Grunt plugin for the ES6 documentation tool [ESDoc](https://esdoc.org/)
npm install grunt-esdocGrunt plugin for the ES6 documentation tool ESDoc
``bash`
npm install grunt-esdoc --save-dev
Configure the plugin in your project's Gruntfile.js.
First, add the esdoc entry to the options of the initConfig method :
`javascript`
grunt.initConfig({
esdoc : {
dist : {
options: {
source: './src',
destination: './doc'
}
}
}
});
Then, load the plugin
`javascript`
grunt.loadNpmTasks('grunt-jsdoc');
All ESDoc config properties are allowed under options.
`javascript`
grunt.initConfig({
esdoc : {
dist : {
options: {
source: './path/to/src',
destination: './path/to/esdoc',
includes: ['\\.(js|es6)$'],
excludes: ['\\.config\\.(js|es6)$'],
access: ['public', 'protected'],
autoPrivate: true,
unexportIdentifier: false,
undocumentIdentifier: true,
builtinExternal: true,
importPathPrefix: '',
index: './README.md',
package: './package.json',
coverage: true,
test: {
type: 'mocha',
source: './test/src',
includes: ['Test\\.(js|es6)$'],
excludes: ['\\.config\\.(js|es6)$']
}
title: 'My Software Name',
styles: ['./path/to/style.css'],
scripts: ['./path/to/script.js']
}
}
}
});
Alternatively, you can pass
a config option instead that is a path to a file containing the configuration options for ESDoc.
`javascript`
grunt.initConfig({
esdoc : {
dist : {
options: {
config: 'esdoc.json'
}
}
}
});
To generate the documentation, you need to call the esdoc task :
`bash`
$> grunt esdoc
or integrate it to your build sequence :
`javascript``
grunt.registerTask('default', ['lint', 'test', 'esdoc']);
Any contribution is welcome! Please check the issues.