grunt-jsdoc/tasks/lib/exec.js

Integrates jsdoc3 generation into your Grunt build

var path = require('path');
var spawn = require('cross-spawn');
/**
 * Provides utility methods to execute a command
 * @module exec
 */
module.exports = {

    /**
     * Build and execute a child process using the spawn function
     * @param {Object} grunt - the grunt context
     * @param {String} script - the script to run
     * @param {Array} sources - the list of sources files
     * @param {Object} params - the list of cli flags
     * @return {ChildProcess} from the spawn
     */
    buildSpawned: function(grunt, script, sources, params) {

        var flag;
        var cmd = script;
        var args =[];


        // Compute JSDoc options
        for (flag in params) {
            if (params.hasOwnProperty(flag)) {
                if (params[flag] !== false) {
                    args.push('--' + flag);
                }
                if (typeof params[flag] === 'string') {
                    args.push(params[flag]);
                }
            }
        }

        if (!Array.isArray(sources)) {
            sources = [sources];
        }
        args = args.concat(sources);

        grunt.log.debug('Running : ' + cmd + ' ' + args.join(' '));

        return spawn(cmd, args);
    },

    /**
     * Lookup file or path into node modules
     * @param {Object} grunt - the grunt context
     * @returns {String} the first matching resolved path or nothing if not found
     */
    lookup: function(grunt) {
        var i, binPath, paths;
        var nodePath = process.env.NODE_PATH || '';

        //check first the base path into the cwd
        paths = [
            __dirname + '/../../node_modules/.bin/jsdoc',
            __dirname + '/../../node_modules/jsdoc/jsdoc.js',
            __dirname + '/../../../jsdoc/jsdoc.js'
        ];

        //fall back on global if not found at the usual location
        nodePath.split(path.delimiter).forEach(function(p) {
            if (!/\/$/.test(p)) {
                p += '/';
            }
            paths.push(p + '/jsdoc/jsdoc.js');
        });

        for (i in paths) {
            binPath = path.resolve(paths[i]);
            if (grunt.file.exists(binPath) && grunt.file.isFile(binPath)) {
                return binPath;
            }
        }

        return;
    }
};