Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janl/npm-run-all
A CLI tool to run multiple npm-scripts in parallel or sequential.
https://github.com/janl/npm-run-all
Last synced: 3 months ago
JSON representation
A CLI tool to run multiple npm-scripts in parallel or sequential.
- Host: GitHub
- URL: https://github.com/janl/npm-run-all
- Owner: janl
- License: mit
- Fork: true (mysticatea/npm-run-all)
- Created: 2015-11-18T21:50:34.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-18T21:50:39.000Z (about 9 years ago)
- Last Synced: 2024-04-07T01:27:47.323Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-run-all
[](https://travis-ci.org/mysticatea/npm-run-all)
[](https://coveralls.io/r/mysticatea/npm-run-all?branch=master)
[](http://badge.fury.io/js/npm-run-all)
A CLI tool to run multiple npm-scripts in parallel or sequential.
```
> npm-run-all clean lint build:*
```
## Installation
```
npm install npm-run-all
```
- This package works in both Windows and UNIX-like environments.
- This package is tested in the follow node versions.
- `0.10` (*requires `npm >= 2.0.0`, so please run `npm install -g npm@latest`*)
- `0.12`
- `4.x`
- `5.x`
## Usage
```
Usage: npm-run-all [OPTIONS] [...tasks]
Run specified tasks.
Options:
-h, --help Print this text.
-p, --parallel [...tasks] Run a group of tasks in parallel.
-s, --sequential [...tasks] Run a group of tasks sequentially.
-v, --version Print version number.
```
### Run tasks sequentially
```
npm-run-all build:html build:js
```
This is same as `npm run build:html && npm run build:js`.
### Run tasks in parallel
```
npm-run-all --parallel watch:html watch:js
```
This is same as `npm run watch:html & npm run watch:js`.
Of course, this can be run on **Windows** as well!
### Run a mix of sequential and parallel tasks.
```
npm-run-all clean lint --parallel watch:html watch:js
```
1. First, this runs `clean` and `lint` sequentially.
2. Next, runs `watch:html` and `watch:js` in parallell.
```
npm-run-all a b --parallel c d --sequential e f --parallel g h i
```
1. First, runs `a` and `b` sequentially.
2. Second, runs `c` and `d` in parallell.
3. Third, runs `e` and `f` sequentially.
4. Lastly, runs `g`, `h`, and `i` in parallell.
### Glob-like pattern matching for task names.
```
npm-run-all --parallel watch:*
```
In this case, runs sub tasks of `watch`. e.g. `watch:html`, `watch:js`.
But, doesn't run sub-sub tasks. e.g. `watch:js:index`.
`npm-run-all` reads the actual npm-script list from `package.json` in the current directory.
```
npm-run-all --parallel watch:**
```
If you use a globstar `**`, runs both sub tasks and sub-sub tasks.
This matching rule is similar to [glob](https://www.npmjs.com/package/glob#glob-primer).
The Difference is one -- the separator is `:`, instead of `/`.
## Node API
```
var runAll = require("npm-run-all");
```
### runAll
```
var promise = runAll(tasks, options);
```
Run npm-scripts.
- **patterns** `string|string[]` -- Glob-like patterns for task names.
- **options** `object`
- **options.parallel** `boolean` --
A flag to run tasks in parallel.
Default is `false`.
- **options.stdin** `stream.Readable|null` --
A readable stream to send to the stdin of npm-scripts.
Default is nothing.
Set `process.stdin` in order to send from stdin.
- **options.stdout** `stream.Writable|null` --
A writable stream to receive from the stdout of npm-scripts.
Default is nothing.
Set `process.stdout` in order to print to stdout.
- **options.stderr** `stream.Writable|null` --
A writable stream to receive from the stderr of npm-scripts
Default is nothing.
Set `process.stderr` in order to print to stderr.
- **options.taskList** `string[]|null` --
A string array that is all task names.
By default, reads from `package.json` in the current directory.
- **options.packageConfig** `object|null` --
A map-like object to overwrite package configs.
Keys are package names.
Every value is a map-like object (Pairs of variable name and value).
e.g. `{"npm-run-all": {"test": 777, "test2": 333}}`
Default is `null`.
`runAll` returns a promise that becomes *fulfilled* when all tasks are completed.
The promise will become *rejected* when any of the tasks exit with a non-zero code.