Display helpful information for your Gulp tasks
Display helpful information for your Gulp tasks
:rocket: Are you ready to tackle ES6 and hone your JavaScript Skills? :rocket:
Check out these outstanding ES6 courses by @wesbos
gulp-assist presents basic info registered tasks in a stylish format by extendinggulp
with an additional method to describe tasks and their flags. gulp-assist
does not modify existing gulp
methods or API.
And info for each individual task including flags and their descriptions.
$ npm install gulp-assist --save-dev
const gulp = require('gulp');
// initialize the module
require('gulp-assist')();
gulp.task('lint', () =>
// ...
);
gulp.assist('lint', {
desc: 'Analyzes code for errors and convention violations.',
flags: {
src: 'Specifies a directory / module to inspect, within the `src` directory.'
}
});
Example Usage of all options:
const gulp = require('gulp');
let taskName = 'default';
require('gulp-assist')({ gulp, taskName })
Type: Object
Default: null
The module has the ability to use a gulp
instance already required. If this
option is not specified, the module will require gulp
internally. In most cases
this will use the shared instance.
Type: String
Default: 'help'
The name of the task that gulp-assist should use as the entry point.
Registers a task with gulp-assist.
Type: String
Default: null
A description of the task being registered.
Type: Object
Default: null
An object whose keys represent a flag name. gulp-assist automagically prepends a
double hypen to each flag name when displaying task details. The value for each
key should represent the description of the flag.
MIT © Andrew Powell