@crabas0npm/excepturi-ducimus-magni

Command Line Utility for Gulp

Install

npm install --global @crabas0npm/excepturi-ducimus-magni

Usage

> gulp [flags] <task> <task>...

Custom Metadata

When listing tasks with the gulp -T command, @crabas0npm/excepturi-ducimus-magni 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.

By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the --series flag. e.g. gulp clean build --series

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 JavaScript variant languages in 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.js, .gulp.ts). You can find a list of supported JavaScript variant languages in Interpret.

A configuration file from the current working directory (cwd) or above are selected before a configuration file from the home directory (~).

Supported configurations properties:

| Property | Description | |--------------------|-------------| | description | Top-level description of the project/gulpfile (Replaces "Tasks for ~/path/of/gulpfile.js") | | gulpfile | Set a default gulpfile | | preload | An array of modules to preload before running the gulpfile. Any relative paths will be resolved against the --cwd directory (if you don't want that behavior, use absolute paths) | | nodeFlags | An array of flags used to forcibly respawn the process upon startup. For example, if you always want your gulpfiles to run in node's harmony mode, you can set --harmony here | | 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.silent | Silence logging by default | | flags.series | Run tasks given on the CLI in series (the default is parallel) | | message(data) | A function used to translate messages that pass through @crabas0npm/excepturi-ducimus-magni. Can receive an object like { tag: Symbol(), ...props } where the tag is a symbol from @gulpjs/messages. The string returned from this function will be logged. If false is explicitly returned, no message will be logged. | | timestamp(data) | A function used to provide timestamps for @crabas0npm/excepturi-ducimus-magni. Can receive an object like { tag: Symbol(), ...props } where the tag is a symbol from @gulpjs/messages. The string returned from this function will be output before any messages. If false is explicitly returned, no timestamp will be output. |

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