ESDoc Standard Plugin
Use with updated EnterTheNameHere/esdoc-monorepo. Original esdoc is here.
Install
npm install @enterthenamehere/esdoc-standard-plugin
Original plugins can be found here.
Config
{
"source": "./src",
"destination": "./doc",
"plugins": [
{
"name": "@enterthenamehere/esdoc-standard-plugin",
"option": {
"lint": {"enable": true},
"coverage": {"enable": true},
"accessor": {"access": ["public", "protected", "private"], "autoPrivate": true},
"undocumentIdentifier": {"enable": true},
"unexportedIdentifier": {"enable": false},
"typeInference": {"enable": true},
"brand": {
"logo": "./logo.png",
"title": "My Library",
"description": "this is awesome library",
"repository": "https://github.com/foo/bar",
"site": "http://my-library.org",
"author": "https://twitter.com/foo",
"image": "http://my-library.org/logo.png"
},
"manual": {
"index": "./manual/index.md",
"globalIndex": true,
"asset": "./manual/asset",
"files": [
"./manual/overview.md",
"./manual/design.md",
"./manual/installation.md",
"./manual/usage1.md",
"./manual/usage2.md",
"./manual/tutorial.md",
"./manual/configuration.md",
"./manual/example.md",
"./manual/advanced.md",
"./manual/faq.md",
"./CHANGELOG.md"
]
},
"test": {
"source": "./test/",
"interfaces": ["describe", "it", "context", "suite", "test"],
"includes": ["(spec|Spec|test|Test)\\.js$"],
"excludes": ["\\.config\\.js$"]
}
}
}
]
}The esdoc-standard-plugin is a glue plugin. The following plugins are used by this.
- @enterthenamehere/esdoc-lint-plugin
- @enterthenamehere/esdoc-coverage-plugin
- @enterthenamehere/esdoc-accessor-plugin
- @enterthenamehere/esdoc-type-inference-plugin
- @enterthenamehere/esdoc-external-ecmascript-plugin
- @enterthenamehere/esdoc-brand-plugin
- @enterthenamehere/esdoc-undocumented-identifier-plugin
- @enterthenamehere/esdoc-unexported-identifier-plugin
- @enterthenamehere/esdoc-integrate-manual-plugin
- @enterthenamehere/esdoc-integrate-test-plugin
- @enterthenamehere/esdoc-publish-html-plugin
- @enterthenamehere/esdoc-ecmascript-proposal-plugin
LICENSE
MIT