Gulp Comfy

Boilerplate to make gulp as comfy as possible.

Features

• Task names match file paths automatically (task1, task1/foo, task1/foo/bar, ...).
• Opt in to define watch tasks automatically (watch/task1, watch/task2, ...).
• Opt in to define clean tasks automatically (clean/task1, clean/task2, ...).
• Main watch and clean aggregate tasks defined automatically.
• default task that runs watch.

Install

npm install --save-dev gulp-comfy

Use

One line gulpfile.js:

require('gulp-comfy')();

Tasks

Define tasks in separate files under gulp/tasks. Instead of calling gulp.task(), define the task as a module:

module.exports = {
  // ... Task Properties ...
};

Task Properties

• fn, Function, Optional: The function to pass to gulp.task().
• deps, Array, Optional: The array of task dependencies to pass to gulp.task().
• watch, String|Array, Optional: A glob or array of globs to pass to gulp.watch(). If specified a watch task will be defined automatically for this task with the name of the task prefixed with watch/.
• clean, String|Array, Optional: A glob or array of globs to pass to del(). If specified a clean task will be defined automatically for this task with the name of the task prefixed with clean/.

Task Name

The name of the task is determined by the file path, relative to gulp/tasks. For example, if my task is defined in gulp/tasks/build/scripts.js, then the name of the task would be build/scripts. The watch and clean, if the task opted into them, would respectively be watch/build/scripts and clean/build/scripts.

Magic Tasks

In addition to per-task watch and clean tasks, there are several other "magic" tasks defined automatically.

• default: Simply runs watch.
• watch: Aggregates individual watch tasks into one watch task.
• clean: Aggregates individual clean tasks into one clean task.

Parent Tasks

Tasks are defined automatically for any directories under gulp/tasks to aggregate tasks inside the directory. For example, if the directory is named task1 and it contains tasks a.js, b.js, c.js, then the following tasks would all be created:

• task1/a
• task1/b
• task1/c
• task1 (parent task, runs all child tasks)