# gulp-exec

> exec plugin for gulp

Latest version **5.0.0** (published 2020-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-exec
pnpm add gulp-exec
yarn add gulp-exec
bun add gulp-exec
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2020-06-10 |
| First published | 2013-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 162 |
| Author | Rob Richardson |
| Maintainers | robrich |
| Keywords | gulpplugin, exec |

## Links

- npm: https://www.npmjs.com/package/gulp-exec
- Repository: https://github.com/robrich/gulp-exec
- Issues: https://github.com/robrich/gulp-exec/issues
- npm.io page: https://npm.io/package/gulp-exec

## Dependencies (2)

- [through2](https://npm.io/package/through2.md) ^3.0.1
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1

## Recent versions

- 5.0.0 (latest) — 2020-06-10
- 4.0.0 — 2019-07-18
- 3.0.2 — 2018-07-09
- 3.0.1 — 2018-01-05
- 3.0.0 — 2018-01-05
- 2.1.3 — 2016-11-05
- 2.1.2 — 2015-09-30
- 2.1.1 — 2014-10-02
- 2.1.0 — 2014-07-22
- 2.0.1 — 2014-04-28
- 2.0.0 — 2014-04-20
- 1.0.4 — 2014-01-19
- 1.0.3 — 2014-01-03
- 1.0.2 — 2014-01-02
- 1.0.1 — 2013-12-09
- … 3 more at https://npm.io/package/gulp-exec/versions

## README

gulp-exec ![status](https://secure.travis-ci.org/robrich/gulp-exec.png?branch=master)
===========

[exec](http://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) plugin for [gulp](https://github.com/gulpjs/gulp)

Usage
-----

```javascript
var exec = require('gulp-exec');

gulp.task('reset', function() {
  var options = {
    continueOnError: false, // default = false, true means don't emit error event
    pipeStdout: false, // default = false, true means stdout is written to file.contents
  };
  var reportOptions = {
  	err: true, // default = true, false means don't write err
  	stderr: true, // default = true, false means don't write stderr
  	stdout: true // default = true, false means don't write stdout
  };
  return gulp.src('./**/**')
    .pipe(exec(file => `git checkout ${file.path} test`, options))
    .pipe(exec.reporter(reportOptions));
});
```

**Note**: If you just want to run a command, just run the command, don't use this plugin:

```js
var exec = require('child_process').exec;

gulp.task('task', function (cb) {
  exec('ping localhost', function (err, stdout, stderr) {
    console.log(stdout);
    console.log(stderr);
    cb(err);
  });
})
```

~~`gulp.src('.')`~~ does bad things.  Don't do it.

**Note**: running and reporting are now separate, a breaking change from previous versions.

Upgrading
---------

Version 5 and later no longer use lodash templates. Upgrade from:

```.pipe(exec('git checkout <%= file.path %> <%= options.customTemplatingThing %>', options))```

to:

```.pipe(exec(file => `git checkout ${file.path} customTemplatingThing`, options))```

Note how you can now resolve the command with an ES6 string template in the function.


LICENSE
-------

(MIT License)

Copyright (c) 2014 [Richardson & Sons, LLC](http://richardsonandsons.com/)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/gulp-exec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._