better-gulp-cli v0.0.4
bettter-gulp-cli
Command Line Utility for Gulp
This is a fork
Fork from https://github.com/gulpjs/gulp-cli to add ability to
load user-defined gulp-cli
package.
Designed for https://www.npmjs.com/package/gulp-v4, but should work for any
customized versions of gulp
.
Installation
npm install -g better-gulp-cli
Usage
> gulp [flags] <task> <task>...
Use customized version of gulp
, e.g. gulp-v4
,
add the following config to package.json
,
{
"gulp-cli": {
"package": "gulp-v4"
}
}
Custom Metadata
When listing tasks with the gulp -T
command, gulp-cli displays some custom metadata as defined upon task functions. Currently supported properties:
task.description
- String of the description to display.
function clean() { ... }
clean.description = 'Cleans up generated files.';
task.flags
- Object with key/value pairs being flag/description to display.
function build() { ... }
build.flags = {
'--prod': 'Builds in production mode.'
};
Example Usage:
function build() { ... }
build.description = 'Build entire project.';
build.flags = {
'--prod': 'Builds in production mode (minification, etc).'
};
// gulp 3.x
gulp.task('build', build);
// gulp 4.x
gulp.task(build);
Tasks
The task(s) listed on the command line will be executed. If more than one task is listed, Gulp will execute all of them concurrently, that is, as if they had all been listed as dependencies of a single task.
Gulp does not serialize tasks listed on the command line. From using
other comparable tools users may expect to execute something like
gulp clean build
, with tasks named clean
and build
. This will not
produce the intended result, as the two tasks will be executed
concurrently.
Just running gulp
will execute the task default
. If there is no
default
task, gulp will error.
Completion
Thanks to the grunt team, specifically Tyler Kellen
To enable tasks auto-completion in shell you should add eval "$(gulp --completion=shell)"
in your .shellrc
file.
Bash:
Add eval "$(gulp --completion=bash)"
to ~/.bashrc
.
Zsh:
Add eval "$(gulp --completion=zsh)"
to ~/.zshrc
.
Powershell:
Add Invoke-Expression ((gulp --completion=powershell) -join [System.Environment]::NewLine)
to $PROFILE
.
Fish:
Add gulp --completion=fish | source
to ~/.config/fish/config.fish
.
Compilers
You can find a list of supported languages at https://github.com/js-cli/js-interpret. If you would like to add support for a new language, send pull requests/open issues on that project.
Environment
The CLI adds process.env.INIT_CWD which is the original cwd it was launched from.
Configuration
Configuration is supported through the use of a .gulp.*
file (e.g. .gulp.json
, .gulp.yml
). You can find a list of supported languages at https://github.com/js-cli/js-interpret.
Configuration from the home directory (~
) and current working directory (cwd
) are merged with cwd
taking precedence.
Supported configurations properties:
Property | Description |
---|---|
description | Top-level description of the project/gulpfile (Replaces "Tasks for ~/path/of/gulpfile.js") |
flags.continue | Continue execution of tasks upon failure by default. |
flags.compactTasks | Reduce the output of task dependency tree by default. |
flags.tasksDepth | Set default depth of task dependency tree. |
flags.gulpfile | Set a default gulpfile |
flags.silent | Silence logging by default |
Flags
gulp has very few flags to know about. All other flags are for tasks to use if needed.
Some flags only work with gulp 4 and will be ignored when invoked against gulp 3.
License
MIT