All Projects → sun-zheng-an → Gulp Shell

sun-zheng-an / Gulp Shell

Licence: mit
A handy command line interface for gulp

Programming Languages

typescript
26450 projects
shell
59808 projects

Projects that are alternatives of or similar to Gulp Shell

gulp-merge-json
A gulp plugin to merge JSON & JSON5 files into one file
Stars: ✭ 35 (-92.62%)
Mutual labels:  gulp, gulp-plugin
gulp-recess
[DEPRECATED] Lint CSS and LESS with RECESS
Stars: ✭ 42 (-91.14%)
Mutual labels:  gulp, gulp-plugin
gulp-ava
Run AVA tests
Stars: ✭ 56 (-88.19%)
Mutual labels:  gulp, gulp-plugin
Glup
Some of the gulp tutorial -《gulp笔记》
Stars: ✭ 136 (-71.31%)
Mutual labels:  gulp, gulp-plugin
anyfs
Portable file system for Node
Stars: ✭ 17 (-96.41%)
Mutual labels:  gulp, gulp-plugin
Gulp Tap
Easily tap into a gulp pipeline without creating a plugin.
Stars: ✭ 158 (-66.67%)
Mutual labels:  gulp, gulp-plugin
gulp-px2rem
This is a gulp plugin for node-px2rem.
Stars: ✭ 19 (-95.99%)
Mutual labels:  gulp, gulp-plugin
Gulp Ftp
[DEPRECATED] Upload files to an FTP-server
Stars: ✭ 100 (-78.9%)
Mutual labels:  gulp, gulp-plugin
gulp-golang
gulp plugin for golang projects
Stars: ✭ 13 (-97.26%)
Mutual labels:  gulp, gulp-plugin
gulp-iife
A Gulp plugin for wrapping JavaScript code in IIFEs.
Stars: ✭ 39 (-91.77%)
Mutual labels:  gulp, gulp-plugin
Gulp Bro
👊 gulp + browserify + incremental build, done right.
Stars: ✭ 119 (-74.89%)
Mutual labels:  gulp, gulp-plugin
gulp-convert-encoding
Plugin for gulp to convert files from one encoding to another.
Stars: ✭ 15 (-96.84%)
Mutual labels:  gulp, gulp-plugin
Gulp Modernizr
Gulp wrapper for custom Modernizr builds
Stars: ✭ 111 (-76.58%)
Mutual labels:  gulp, gulp-plugin
Gulp Html Replace
Replace build blocks in HTML. Like useref but done right.
Stars: ✭ 222 (-53.16%)
Mutual labels:  gulp, gulp-plugin
Gulp Flatten
Gulp plugin: remove or replace relative paths for files
Stars: ✭ 102 (-78.48%)
Mutual labels:  gulp, gulp-plugin
gulp-esbuild
gulp plugin for esbuild bundler
Stars: ✭ 39 (-91.77%)
Mutual labels:  gulp, gulp-plugin
Gulp Plugin Boilerplate
Boilerplate to kickstart creating Gulp plugins
Stars: ✭ 74 (-84.39%)
Mutual labels:  gulp, gulp-plugin
Gulp Ngmin
[DEPRECATED] Pre-minify AngularJS apps with ngmin
Stars: ✭ 89 (-81.22%)
Mutual labels:  gulp, gulp-plugin
gulp-tinypng-compress
TinyPNG API wrapper for compressing PNG & JPG images
Stars: ✭ 49 (-89.66%)
Mutual labels:  gulp, gulp-plugin
gulp-yarn
Automatically install node modules using Yarn. 😻
Stars: ✭ 22 (-95.36%)
Mutual labels:  gulp, gulp-plugin

gulp-shell

NPM version Build Status Coveralls Status Dependency Status Downloads

A handy command line interface for gulp

Installation

npm install --save-dev gulp-shell

Usage

const gulp = require('gulp')
const shell = require('gulp-shell')

gulp.task('example', () => {
  return gulp
    .src('*.js', { read: false })
    .pipe(shell(['echo <%= file.path %>']))
})

Or you can use this shorthand:

gulp.task('greet', shell.task('echo Hello, World!'))

You can find more examples in the gulpfile of this project.

WARNING: Running commands like gulp.src('').pipe(shell('whatever')) is considered as an anti-pattern. PLEASE DON'T DO THAT ANYMORE.

API

shell(commands, options) or shell.task(commands, options)

commands

type: string or Array<string>

A command can be a template which can be interpolated by some file info (e.g. file.path).

WARNING: Using command templates can be extremely dangerous. Don't shoot yourself in the foot by passing arguments like $(rm -rf $HOME).

options.cwd

type: string

default: process.cwd()

Sets the current working directory for the command. This can be a template which can be interpolated by some file info (e.g. file.path).

options.env

type: object

By default, all the commands will be executed in an environment with all the variables in process.env and PATH prepended by ./node_modules/.bin (allowing you to run executables in your Node's dependencies).

You can override any environment variables with this option.

For example, setting it to { PATH: process.env.PATH } will reset the PATH if the default one brings your some troubles.

options.shell

type: string

default: /bin/sh on UNIX, and cmd.exe on Windows

Change it to bash if you like.

options.quiet

type: boolean

default: false

By default, it will print the command output.

options.verbose

type: boolean

default: false

Set to true to print the command(s) to stdout as they are executed

options.ignoreErrors

type: boolean

default: false

By default, it will emit an error event when the command finishes unsuccessfully.

options.errorMessage

type: string

default: Command `<%= command %>` failed with exit code <%= error.code %>

You can add a custom error message for when the command fails. This can be a template which can be interpolated with the current command, some file info (e.g. file.path) and some error info (e.g. error.code).

options.templateData

type: object

The data that can be accessed in template.

Changelog

Details changes for each release are documented in the release notes.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected]