Gruntfile.js

/*
 * grunt-phpdocumentor
 * https://github.com/gomoob/grunt-phpdocumentor
 *
 * Copyright (c) 2013 Baptiste Gaillard
 * Licensed under the MIT license.
 */

'use strict';

module.exports = function(grunt) {

    // Project configuration.
    grunt.initConfig({
        
        jshint : {
            all : [ 'Gruntfile.js', 'tasks/*.js', 'test/*.js', ],
            options : {
                jshintrc : '.jshintrc',
            }
        },

        // Before generating any new files, remove any previously-created files.
        clean : [ 'docs', 'target' ],

        // Task to be run (and then tested)
        phpdocumentor : {
            
            // Task-level options
            options : {
                command : 'run'
            },
            
            // Configuration used by the 'testForList()' unit test method
            testForList : {
                options : {
                    command : 'list'
                }
            },
            
            // Configuration used by the 'testForParse()' unit test method
            testForParse : {
                options : {
                    command : 'parse'
                }
            },
            
            // Configuration used by the 'testForProjectParse()' unit test method
            testForProjectParse : {
                options : {
                    command : 'project:parse'
                }
            },
            
            // Configuration used by the 'testForProjectRun()' unit test method
            testForProjectRun : {
                options : {
                    command : 'project:run',
                    target : 'target/testForProjectRun'
                }
            },
            
            // Configuration used by the 'testForProjectTransform()' unit test method
            // FIXME: 'transform' is not supported for the moment
            /*testForProjectTransform : {
                options : {
                    command : 'project:transform'
                }
            },*/
            
            // Configuration used by the 'testForTemplateGenerate()' unit test method
            // FIXME: 'template:generate' is not supported for the moment
            // @see http://www.phpdoc.org/docs/latest/for-users/commands/template_generate.html
            /*testForTemplateGenerate : {
                options : {
                    command : 'template:generate'
                }
            },*/

            // Configuration used by the 'testForTemplateList()' unit test method 
            testForTemplateList : {
                options : {
                    command : 'template:list'
                }
            },
            
            // Configuration used by the 'testForTemplatePackage()' unit test method
            // FIXME: 'template:package' is not supported for the moment
            /*testForTemplatePackage : {
                options : {
                    command : 'template:package'
                }
            },*/
            
            // Configuration used by the 'testForTransform()' unit test method 
            // FIXME: 'transform' is not supported for the moment
            /*testForTransform : {
                options : {
                    command : 'transform'
                }
            },*/
            
            // Configuration used by the 'testWithCustomPharFile()' unit test method
            testWithCustomPharFile : {
                options : {
                    phar : 'test/fixtures/phpDocumentor.phar',
                    target : 'target/testWithCustomPharFile'
                }
            },

            // Configuration used by the 'testWithDefaultOptions()' unit test method
            testWithDefaultOptions : {},

            // Configuration used by the 'testWithNullPhar()' unit test method
            testWithNullPhar : {
                options : {
                    phar : null,
                    target : 'target/testWithNullPhar'
                }
            },
            
            // Configuration used by the 'testWithTarget()' unit test method
            testWithTarget : {
                options : {
                    target : 'target/testWithTarget'
                }
            },
            
            // Configuration used by the 'testOverwriteTaskLevelOptions()' unit test method
            testWithTaskOptionsOverwriting : {
                options : {
                    command : 'help'
                }
            }

        },

        // Unit tests.
        nodeunit : {
            tests : [ 'test/*_test.js' ],
        },

    });

    // Actually load this plugin's task(s).
    grunt.loadTasks('tasks');

    // These plugins provide necessary tasks.
    grunt.loadNpmTasks('grunt-contrib-jshint');
    grunt.loadNpmTasks('grunt-contrib-clean');
    grunt.loadNpmTasks('grunt-contrib-nodeunit');

    // Whenever the "test" task is run, first clean the "tmp" dir, then run this plugin's task(s), then test the result.
    grunt.registerTask('test', [ 'clean', 'nodeunit' ]);

    // By default, lint and run all tests.
    grunt.registerTask('default', [ 'jshint', 'test' ]);

};