bootstrap-grunt

Introduction

bootstrap-grunt help you to configure Grunt in a maintainable way.

Grunfile grows out of control easily. bootstrap-grunt break up Grunfile into many small-reusable files with tasks & config.

Guntfile.js

module.exports = function (grunt) {

    var path = require("path"),
        bootstrap = require("bootstrap-grunt");

    bootstrap(grunt)
        // --------------
        // Initial configuration
        .setConfig({
            banner: '/*! <%= pkg.title || pkg.name %> - v<%= pkg.version %> - <%= grunt.template.today("yyyy-mm-dd") %>\n' +
                '<%= pkg.homepage ? " * " + pkg.homepage + "\\n" : "" %>' +
                ' * Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author %>;\n */\n',
            src: {
                docs: "<%= pkg.directories.docs %>",
                css: "<%= pkg.directories.source.css %>",
                js: "<%= pkg.directories.source.js %>",
                specs: "<%= pkg.directories.test.casperjs %>",
                html: "<%= pkg.directories.source.html %>"
            }
        })

        // load package.json and store it's contents in <configuration>.pkg
        // loadPackageJSON(String absolute_path)
        .loadPackageJSON(path.join(__dirname , 'package.json'))

        // if you need to do something with the configuration before loading dependencies
        // config(Function callback(Object config, Object package_json))
        .config(function(config, package_json) {
            package_json.directories.source.js =
                bootstrap.expandFiles(package_json.directories.source.js);
        })

        // --------------
        // loading your plugins

        // from package.json -> .devDependencies load all grunt-*
        .loadDevDependencies()

        // from package.json -> .dependencies load all grunt-*
        .loadDependencies()

        // alternative method: .config(function(){ require('load-grunt-tasks')(grunt); })

        // --------------
        // Loading your configuration/tasks
        // loadConfiguration(Array from, Object options);
        // options has only "json_comments" atm.

        // *.js are required and execute it
        // Arguments passed: grunt, config, bootstrap

        // *.json are treated as config extensors
        // *.yml are treated as config extensors

        .loadConfiguration([path.join(__dirname , 'grunt/*')], {json_comments: true})

        // init Grunt
        .initConfig();
    // RIP Gruntfile.js
};

task: print.js

module.exports = function(grunt, config, bootstrap) {
    // set configuration or use YML/JSON instead your choice!
    bootstrap.merge({
        print: {
            es: { options: { lang: "Hola!"}},
            en: { options: { lang: "Hello!"}},
        }
    });

    // register tasks normally
    grunt.registerMultiTask('print', 'Increment HTML version', function () {
        var options;

        switch(this.target) {
            case "es":
                options = this.options({ lang: "Adios!"});
                break;
            case "en":
                var options = this.options({ lang: "Bye!"});
                break;
        }

        grunt.log.debug("In config: ", config.print[this.target].options.lang);
        grunt.log.debug("In options: ", options.lang);
    });
};

config: print.yml

print:
    es:
        options:
            lang: "Hola!"
    en:
        options:
            lang: "Hello!"

config: cssmin.json

{
    "cssmin": {
        "dist": {
            "expand": true,
            "cwd": "public/css/",
            "src": ["*.css", "!*.min.css"],
            "dest": "public/css/",
            "ext": ".min.css"
        }
    }
}

license

MIT.