{"_id":"@axtell/esdoc-standard-plugin","_rev":"1-a8b068861d779574d313cf41e6898b30","name":"@axtell/esdoc-standard-plugin","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@axtell/esdoc-standard-plugin","version":"1.0.0","description":"A standard plugin for ESDoc","author":{"name":"h13i32maru"},"homepage":"https://github.com/esdoc/esdoc-plugins","license":"MIT","repository":{"type":"git","url":"git+https://github.com/esdoc/esdoc-plugins.git"},"dependencies":{"esdoc-lint-plugin":"^1.0.0","esdoc-coverage-plugin":"^1.0.0","esdoc-accessor-plugin":"^1.0.0","esdoc-external-ecmascript-plugin":"^1.0.0","esdoc-brand-plugin":"^1.0.0","esdoc-undocumented-identifier-plugin":"^1.0.0","esdoc-unexported-identifier-plugin":"^1.0.0","@axtell/esdoc-publish-html-plugin":"^1.0.0","esdoc-type-inference-plugin":"^1.0.0","esdoc-integrate-manual-plugin":"^1.0.0","esdoc-integrate-test-plugin":"^1.0.0"},"devDependencies":{"esdoc":"latest","mocha":"2.5.3"},"engines":{"node":">= 6.0.0"},"scripts":{"test":"rm -rf ./test/out && mocha --require ./test/init.js $(find test/ -regex '.*.test.js$') -R spec"},"keywords":["esdoc","standard","plugin"],"files":["src","README.md"],"main":"src/Plugin.js","bugs":{"url":"https://github.com/esdoc/esdoc-plugins/issues"},"_id":"@axtell/esdoc-standard-plugin@1.0.0","_npmVersion":"6.0.1","_nodeVersion":"8.9.3","_npmUser":{"name":"vihanb","email":"contact@vihan.org"},"dist":{"integrity":"sha512-mlXftGbI1XCCXB+d2k2GoMgOySUrg0JV24aAXitp2suRPe7qo+M/JUSOomoqFWQ0hr45oFqoYTfjQl161xiNmA==","shasum":"c417c0a7bf9eca52bb9d0f0910c7f77ba14c460b","tarball":"https://registry.npmjs.org/@axtell/esdoc-standard-plugin/-/esdoc-standard-plugin-1.0.0.tgz","fileCount":5,"unpackedSize":6554,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbVnWrCRA9TVsSAnZWagAAh78P/0reds6VvgDjwVEDu4Jw\nBdIsBA8JFco9tD+xPMIxrkluQV1lpnYAycx6RMTWXkk4HXcUS7NC2VpIp2RA\nmEfqTZUOgMQrIzV1upoi3qTeePHJCoIQFlveJEpienpScxFU4Vjqb3McEs6f\nCorY+kTlAQnGPZZUdKf1l7s8QoWDq/pQh6TEgbiK/NOdE9iFuFBWXx3QdMR6\nzvulbn2nyw9Dqaa0pyvv2x0LDd5RooOeyx5hOFw7tdf5ZISBQN8wTQDA7E/4\nDADLDSUvnhV46l9S5HUaYGW2+MPiWu7WaHuY/PVSj22cPDFO0jhQyD5fc/IZ\nfmXqgv6RBwYFb+Hi7kz15ERNGmd6HoUCwRb5l1+qni0MNZKsE6QSZwBQCU5e\n+/yAsfM0yOdkRCv6M0i1fTuIxK2UfcPYliV9UCuGFhMdy63eHJAzyMkegKjV\nxJMBbAi8sa/5UYCNv95EDwy8Pz0oikYGeY6LxvH8lwY/T/sTcNPYzznMqs5H\nkhkI6yUMFRKwZ6N/Stn6p7wxSmQOUgOBl5QKSWhjumSprnmXwR6uJy58pxrP\ns8BNwavbpp1pqjZ3tHREXCofINzeGXtu7sKOv9Ei1YmgZjIdm/CeL8L8XoQZ\nxCBh197eEsw89pvy47AMTlCAVeZXko0gioX7le3+QhT5BpXhJxN2rsF12RLf\ndvHg\r\n=AM19\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA4Kr5fBK800Kfs7oyJfolw0At3nBuJDLxJN/BTe/lxsAiBNWvxqwWW/yD8tUE0nbJgkmJHowrdlgHPUh4fs77JLlg=="}]},"maintainers":[{"name":"vihanb","email":"contact@vihan.org"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/esdoc-standard-plugin_1.0.0_1532392875405_0.37930284449912666"},"_hasShrinkwrap":false}},"time":{"created":"2018-07-24T00:41:15.336Z","1.0.0":"2018-07-24T00:41:15.487Z","modified":"2022-04-04T17:13:26.101Z"},"maintainers":[{"name":"vihanb","email":"contact@vihan.org"}],"description":"A standard plugin for ESDoc","homepage":"https://github.com/esdoc/esdoc-plugins","keywords":["esdoc","standard","plugin"],"repository":{"type":"git","url":"git+https://github.com/esdoc/esdoc-plugins.git"},"author":{"name":"h13i32maru"},"bugs":{"url":"https://github.com/esdoc/esdoc-plugins/issues"},"license":"MIT","readme":"# ESDoc Standard Plugin\n## Install\n```bash\nnpm install esdoc-standard-plugin\n```\n\n## Config\n```json\n{\n  \"source\": \"./src\",\n  \"destination\": \"./doc\",\n  \"plugins\": [\n    {\n      \"name\": \"esdoc-standard-plugin\",\n      \"option\": {\n        \"lint\": {\"enable\": true},\n        \"coverage\": {\"enable\": true},\n        \"accessor\": {\"access\": [\"public\", \"protected\", \"private\"], \"autoPrivate\": true},\n        \"undocumentIdentifier\": {\"enable\": true},\n        \"unexportedIdentifier\": {\"enable\": false},\n        \"typeInference\": {\"enable\": true},\n        \"brand\": {\n          \"logo\": \"./logo.png\",\n          \"title\": \"My Library\",\n          \"description\": \"this is awesome library\",\n          \"repository\": \"https://github.com/foo/bar\",\n          \"site\": \"http://my-library.org\",\n          \"author\": \"https://twitter.com/foo\",\n          \"image\": \"http://my-library.org/logo.png\"\n        },\n        \"manual\": {\n          \"index\": \"./manual/index.md\",\n          \"globalIndex\": true,\n          \"asset\": \"./manual/asset\",\n          \"files\": [\n            \"./manual/overview.md\",\n            \"./manual/design.md\",\n            \"./manual/installation.md\",\n            \"./manual/usage1.md\",\n            \"./manual/usage2.md\",\n            \"./manual/tutorial.md\",\n            \"./manual/configuration.md\",\n            \"./manual/example.md\",\n            \"./manual/advanced.md\",\n            \"./manual/faq.md\",\n            \"./CHANGELOG.md\"\n          ]\n        },\n        \"test\": {\n          \"source\": \"./test/\",\n          \"interfaces\": [\"describe\", \"it\", \"context\", \"suite\", \"test\"],\n          \"includes\": [\"(spec|Spec|test|Test)\\\\.js$\"],\n          \"excludes\": [\"\\\\.config\\\\.js$\"]\n        }\n      }\n    }\n  ]\n}\n```\n\nThe `esdoc-standard-plugin` is a glue plugin. The following plugins are used by this.\n- [esdoc-lint-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-lint-plugin)\n- [esdoc-coverage-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-coverage-plugin)\n- [esdoc-accessor-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-accessor-plugin)\n- [esdoc-type-inference-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-type-inference-plugin)\n- [esdoc-external-ecmascript-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-external-ecmascript-plugin)\n- [esdoc-brand-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-brand-plugin)\n- [esdoc-undocumented-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-undocumented-identifier-plugin)\n- [esdoc-unexported-identifier-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-unexported-identifier-plugin)\n- [esdoc-integrate-manual-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-manual-plugin)\n- [esdoc-integrate-test-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-integrate-test-plugin)\n- [esdoc-publish-html-plugin](https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-html-plugin)\n\n## LICENSE\nMIT\n\n## Author\n[Ryo Maruyama@h13i32maru](https://github.com/h13i32maru)\n","readmeFilename":"README.md"}