Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
ehmicky committed May 20, 2019
1 parent e7f0ec2 commit 133aa3e
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@

Command execution in Gulp.js.

As opposed to other plugins or
As opposed to
[`child_process.exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback),
`gulp-execa` uses the popular [`execa`](https://github.com/sindresorhus/execa)
library providing:
or to other plugins, `gulp-execa` uses
[`execa`](https://github.com/sindresorhus/execa) providing:

- [Better Windows support](https://github.com/IndigoUnited/node-cross-spawn#why),
including [shebangs](<https://en.wikipedia.org/wiki/Shebang_(Unix)>)
- Faster and more secure commands, since no shell is used by default
- Faster and more secure commands, since [no shell is used by default](#command)
- Execution of locally installed binaries
- Descriptive errors and configurable verbosity
- Interleaved `stdout`/`stderr`
Expand All @@ -28,7 +28,7 @@ mode, unlike similar libraries:
not [serially](https://github.com/rvagg/through2)
- output can be saved either in files or in variables

Example gulpfile:
Example `gulpfile.js`:

<!-- eslint-disable func-names -->

Expand Down Expand Up @@ -63,7 +63,7 @@ Returns a Gulp task that executes `command`.

## exec(command, [options])

Executes `command` and returns a promise.
Returns a promise executing `command`.

## stream(function, [options])

Expand All @@ -74,14 +74,14 @@ argument and return a `command`.
# Command

By default, no shell interpreter (like Bash or `cmd.exe`) is used. This means
`command` must only be the program path followed by arguments. No
escaping/quoting is needed, except for significant spaces (with a backslash).
`command` must be just the program and its arguments. No escaping/quoting is
needed, except for significant spaces (with a backslash).

Shell features such as globbing, variables and operators (`&&`, `>`, `;`) should
not be used. Fortunately, all of this can done directly in Node.js instead.
Shell features such as globbing, variables and operators (like `&&`, `>`, `;`)
should not be used. All of this can be done directly in Node.js instead.

Shell interpreters are slower, less secure and less cross-platform. However, you
can still use them by specifying the `shell` option.
can still opt-in to using them with the `shell` option.

```js
const { series } = require('gulp')
Expand All @@ -99,7 +99,7 @@ module.exports.check = series(task('npm audit'), task('npm outdated'))

### echo

_Type_: `boolean`<br> _Default_: same as [`verbose`](#version)
_Type_: `boolean`<br> _Default_: same as [`verbose`](#verbose)

Whether the `command` should be printed on the console.

Expand Down

0 comments on commit 133aa3e

Please sign in to comment.