split up into grunt/config and grunt/tasks using jit-grunt and load-grunt-config for improved maintainability and optimal build performance.
added ESLint build step.
added Rollup build step to generate an ES5 cjs-style task from src/index.js (uses Babel internally).
esdoc.js
moved to src/index.js.
adjusted to support ESDoc 1.x.x.
removed publisher argument from esdoc.generate(config).
improved coverage reporting by reading the coverage output json file if it exists. ESDoc >= 1.0.0 no longer reports coverage results in the console. Coverage is only available when the esdoc-coverage-plugin or the esdoc-standard-plugin is used. In case a user decides not to use the esdoc-coverage-plugin, grunt-esdoc won't try to report coverage.
added coverageThreshold. This change partially supersedes #4: it doesn't include failing on unsatisfactory coverage, but since coverage is no longer part of ESDoc, this may not be appropriate anyway.
the file tasks/grunt-esdoc.js is the result of the grunt build task.
README.md
added build status badge.
added npm version badge.
added dependency status badge.
added Getting Started section which includes a correct example of how to actually load the plugin. Previously, the readme file incorrectly referenced grunt-jsdoc.
Hi again,
I squashed and combined the commits from #7 and #8 into a new, clean PR.
Changelog
package.json
esdoc-standard-plugin
for testing with ESDoc >= 1.0.0.Gruntfile.js
grunt/config
andgrunt/tasks
using jit-grunt and load-grunt-config for improved maintainability and optimal build performance.src/index.js
(uses Babel internally).esdoc.js
src/index.js
.publisher
argument fromesdoc.generate(config)
.esdoc-coverage-plugin
or theesdoc-standard-plugin
is used. In case a user decides not to use theesdoc-coverage-plugin
,grunt-esdoc
won't try to report coverage.coverageThreshold
. This change partially supersedes #4: it doesn't include failing on unsatisfactory coverage, but since coverage is no longer part of ESDoc, this may not be appropriate anyway.tasks/grunt-esdoc.js
is the result of thegrunt build
task.README.md
Getting Started
section which includes a correct example of how to actually load the plugin. Previously, the readme file incorrectly referencedgrunt-jsdoc
.--verbose
cli flag.Of course, these are only suggestions.