grunt-jsdoc/Gruntfile.js

Integrates jsdoc3 generation into your Grunt build

module.exports = function(grunt) {
    'use strict';

    require('load-grunt-tasks')(grunt);

    // Project configuration.
    grunt.initConfig({

        clean: {
            options: {
                force : true
            },
            test: ['doc']
        },

        jsdoc: {
            basic: {
                src: ['tasks/**.js', 'tasks/lib/*.js'],
                options: {
                    destination: 'doc/basic'
                }
            },
            alternate: {
                src: ['tasks'],
                dest : 'doc/alternate',
                options: {
                    readme : 'README.md',
                    recurse : true,
                    private : false
                }
            },
            spacepack: {
                src: ['tasks/**/*.js'],
                options: {
                    destination: 'doc/pack age',
                    package: 'package.json'
                }
            },
            docstrap: {
                src: ['tasks/**.js', 'tasks/lib/*.js', 'README.md'],
                options: {
                    destination: 'doc/docstrap',
                    template: 'node_modules/ink-docstrap/template',
                    configure: 'node_modules/ink-docstrap/template/jsdoc.conf.json'
                }
            },
            nosrc : {
                options: {
                    configure : 'test/nosrc.json'
                }
            }
        },
        nodeunit: {
            unit:      ['test/jsdoc-plugin_test.js'],
            basic:     ['test/jsdoc-basic_test.js'],
            alternate: ['test/jsdoc-alternate_test.js'],
            docstrap:  ['test/jsdoc-docstrap_test.js'],
            spacepack: ['test/jsdoc-spacepack_test.js'],
            nosrc: ['test/jsdoc-nosrc_test.js']
        },

        eslint: {
            all: {
                src: ['Gruntfile.js', 'tasks/**/*.js', 'test/**/*.js']
            }
        }
    });

    // Load local tasks.
    grunt.loadTasks('tasks');


    //testing tasks
    grunt.registerTask('test-basic',     'Test basic jsdoc', ['jsdoc:basic', 'nodeunit:basic']);
    grunt.registerTask('test-alternate', 'Test jsdoc with alternate options', ['jsdoc:alternate', 'nodeunit:alternate']);
    grunt.registerTask('test-docstrap',  'Test jsdoc with a template', ['jsdoc:docstrap', 'nodeunit:docstrap']);
    grunt.registerTask('test-spacepack', 'Test jsdoc with a package and spaces in the paths', ['jsdoc:spacepack', 'nodeunit:spacepack']);
    grunt.registerTask('test-nosrc', 'Test jsdoc without src and dest, only a config', ['jsdoc:nosrc', 'nodeunit:nosrc']);
    grunt.registerTask('test',           'Full test suite', ['clean:test', 'nodeunit:unit', 'test-basic', 'test-alternate', 'test-docstrap', 'test-spacepack', 'test-nosrc']);

    grunt.registerTask('default', 'Default task will lint and test', ['eslint:all', 'test']);
};