Gathering detailed insights and metrics for gulp-cli
Gathering detailed insights and metrics for gulp-cli
Installations
npm install gulp-cliDeveloper
gulpjs
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>=10.13.0
Typescript Support
No
Node Version
20.5.0
NPM Version
9.8.0
Statistics
401 Stars
179 Commits
106 Forks
24 Watching
5 Branches
36 Contributors
Updated on 09 Oct 2024
Bundle Size
214.50 kB
Minified
66.23 kB
Minified + Gzipped
Languages
JavaScript (99.03%)
Shell (0.97%)
Total Downloads
Cumulative downloads
Total Downloads
341,997,530
Last day
-6.7%
263,535
Compared to previous day
Last week
3.8%
1,568,995
Compared to previous week
Last month
12.8%
6,221,081
Compared to previous month
Last year
6.6%
64,896,661
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
gulp-cli
Command Line Utility for Gulp
Install
1npm install --global gulp-cli
Usage
1> gulp [flags] <task> <task>...
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.
1function clean() { ... } 2clean.description = 'Cleans up generated files.';
task.flags- Object with key/value pairs being flag/description to display.
1function build() { ... } 2build.flags = { 3 '--prod': 'Builds in production mode.' 4};
Example Usage:
1function build() { ... } 2build.description = 'Build entire project.'; 3build.flags = { 4 '--prod': 'Builds in production mode (minification, etc).' 5}; 6// gulp 3.x 7gulp.task('build', build); 8// gulp 4.x 9gulp.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 gulp-cli. 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 gulp-cli. 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.
| Flag | Short Flag | Description |
|---|---|---|
| --help | -h | Show this help. |
| --version | -v | Print the global and local gulp versions. |
| --preload [path] | Will preload a module before running the gulpfile. This is useful for transpilers but also has other applications. | |
| --gulpfile [path] | -f | Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well. |
| --cwd [path] | Manually set the CWD. The search for the gulpfile, as well as the relativity of all preloads (with the `--preload` flag) will be from here. | |
| --tasks | -T | Print the task dependency tree for the loaded gulpfile. |
| --tasks-simple | Print a plaintext list of tasks for the loaded gulpfile. | |
| --tasks-json [path] | Print the task dependency tree, in JSON format, for the loaded gulpfile. The [path] argument is optional, and if given writes the JSON to the path. | |
| --tasks-depth [number] | Specify the depth of the task dependency tree to print. This flag can be used with --tasks or --tasks-json. (This flag was named --depth before but is deprecated.) | |
| --compact-tasks | Reduce the output of task dependency tree by printing only top tasks and their child tasks. This flag can be used with --tasks or --tasks-json. | |
| --sort-tasks | Will sort top tasks of task dependency tree. This flag can be used with --tasks. | |
| --color | Will force gulp and gulp plugins to display colors, even when no color support is detected. | |
| --no-color | Will force gulp and gulp plugins to not display colors, even when color support is detected. | |
| --silent | -S | Suppress all gulp logging. |
| --continue | Continue execution of tasks upon failure. | |
| --series | Run tasks given on the CLI in series (the default is parallel). | |
| --log-level | -L | Set the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default. |
License
MIT
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/gulpjs/.github/SECURITY.md:1
- Info: Found linked content: github.com/gulpjs/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/gulpjs/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/gulpjs/.github/SECURITY.md:1
Reason
Found 12/29 approved changesets -- score normalized to 4
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/dev.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/dev.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/dev.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/gulpjs/gulp-cli/release.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/dev.yml:51
- Warn: npmCommand not pinned by hash: .github/workflows/dev.yml:79
- Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 21 are checked with a SAST tool
Score
4.4
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More