Grunt plugin for the ES6 documentation tool ESDoc
npm install grunt-esdoc --save-devConfigure the plugin in your project's Gruntfile.js.
First, add the esdoc entry to the options of the initConfig method :
grunt.initConfig({
esdoc : {
dist : {
options: {
source: './src',
destination: './doc'
}
}
}
});Then, load the plugin
grunt.loadNpmTasks('grunt-jsdoc');All ESDoc config properties are allowed under options.
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.
grunt.initConfig({
esdoc : {
dist : {
options: {
config: 'esdoc.json'
}
}
}
});To generate the documentation, you need to call the esdoc task :
$> grunt esdocor integrate it to your build sequence :
grunt.registerTask('default', ['lint', 'test', 'esdoc']);Any contribution is welcome! Please check the issues.
- 0.0.1 First Release - using esdoc 0.1.4 and directly passing through options using the default publisher
- 0.0.2 Using esdoc ~0.4.0 and updated the package metadata with relevant links
- 0.0.3 Upgrade to at least node 4.0.0, upgrade to esdoc 0.4.7, cleaned up output to only show coverage by default
- 0.0.4 Will now parse float percentages of coverage
Copyright (c) 2016 Cleversoap Licensed under the MIT license.