gulpplug.js

'use strict';

var autoPlug = require('auto-plug'),
    glob = require('glob'),
    path = require('path');

function Plug() {
    this.dir = path.join(path.dirname(module.parent.filename), '.gulpplug');
    this.tasksDir = path.join(this.dir, 'tasks');
    this.taskGlob = '**/*.js';
    this.gulp = require('gulp');
    this.help = true;
    this.autoPlug = true;
    this.tasks = {};
    this.plugins = {};
}

Plug.prototype.addTasks = function() {
    glob.sync(this.taskGlob, {
        cwd: this.tasksDir
    }).forEach(function(filepath) {
        this.addTask({
            file: filepath,
            name: this.getTasknameFromFilepath(filepath)
        });
    }.bind(this));
    if (this.help) {
        this.addHelpTask();
    }
    return this;
};

Plug.prototype.addTask = function(task) {
    if (task.name === '' || this.tasks.hasOwnProperty(task.name)) {
        return this;
    }
    if (!task.hasOwnProperty('fn')) {
        task = this.requireTask(task);
    }
    if (typeof task.fn === 'function') {
        task.fn(this.gulp, this);
        this.tasks[task.name] = task;
    }
    return this;
};

Plug.prototype.requireTask = function(task) {
    var taskModule = require(path.join(this.tasksDir, task.file));
    if (Array.isArray(taskModule) && taskModule.length === 2) {
        task.description = taskModule[0];
        task.fn = taskModule[1];
    } else {
        task.fn = taskModule;
    }
    return task;
};

Plug.prototype.getTasks = function() {
    return Object.keys(this.tasks).reduce(function(tasks, taskName) {
        tasks.push(this.tasks[taskName]);
        return tasks;
    }.bind(this), []);
};

Plug.prototype.addHelpTask = function() {
    this.addTask({
        name: 'help',
        fn: helpTask,
        description: 'display help message'
    });
    if (!this.tasks.hasOwnProperty('default')) {
        this.gulp.task('default', ['help']);
    }
    return this;
};

function helpTask(gulp, plug) {
    var gutil = require('gulp-util'),
        chalk = gutil.colors;
    gulp.task('help', function(done) {
        gutil.log(chalk.yellow('=================================================='));
        gutil.log(chalk.yellow('Available Tasks:'));
        plug.getTasks().forEach(function(task) {
            gutil.log(
                chalk.cyan(task.name) + chalk.gray(' ➜ ') +
                (task.description ? chalk.white(task.description) : chalk.gray('(no description)'))
            );
        });
        gutil.log(chalk.yellow('=================================================='));
        done();
    });
}

Plug.prototype.getTasknameFromFilepath = function(filepath) {
    return filepath.toLowerCase()
        .replace(/(^a-z0-9_-)|(\.[^\.]+$)/ig, '')
        .replace(new RegExp(path.sep, 'g'), ':');
};

Plug.prototype.loadPlugins = function() {
    this.plugins = autoPlug({
        prefix: 'gulp',
        config: require(path.join(path.dirname(module.parent.filename), 'package.json'))
    });
    return this;
};

module.exports = new Plug();