ESDoc plugin to test coverage. Useful in combination with a CI service.
npm install esdoc-plugin-require-coverage> ESDoc plugin to test coverage. Useful in combination with a CI service.
Add the module to your development dependencies as usual by running:
``bash`
npm install --save-dev esdoc-plugin-require-coverage
After that you can configure ESDoc to use this plugin by adding an entry inside your esdoc.json:
`json`
{
"source": "./src",
"destination": "./doc",
"plugins": [
{
"name": "esdoc-plugin-require-coverage"
}
]
}
With the plugin installed and added to esdoc.json just run ESDoc as usual:
`bash`
esdoc -c esdoc.json
The only difference you'll experience is that ESDoc will throw an error if the required coverage is not met.
The required coverage defaults to 90%. You can change that by passing an option to the plugin inside esdoc.json:
`json``
{
...
"plugins": [
{
"name": "esdoc-plugin-require-coverage",
"option": {
"required": 80
}
}
]
}
In the above example, a coverage of 80% would be tested.