Back to directory
mysticatea avatar

npm-run-all

A CLI tool to run multiple npm-scripts in parallel or sequential.. Read more below about its uses, features, and usage.

Clone repository

git clone https://github.com/mysticatea/npm-run-all.git

5,838

Stars

239

Forks

33

Watchers

MIT

License

index npm-run-all run-s run-p Node API

npm-run-all

npm version Downloads/month Build Status Build status Coverage Status Dependency Status

A CLI tool to run multiple npm-scripts in parallel or sequential.

⤴️ Motivation

  • Simplify. The official npm run-script command cannot run multiple scripts, so if we want to run multiple scripts, it's redundant a bit. Let's shorten it by glob-like patterns.
    Before: npm run clean && npm run build:css && npm run build:js && npm run build:html
    After: npm-run-all clean build:*
  • Cross platform. We sometimes use & to run multiple command in parallel, but cmd.exe (npm run-script uses it by default) does not support the &. Half of Node.js users are using it on Windows, so the use of & might block contributions. npm-run-all --parallel works well on Windows as well.

💿 Installation

$ npm install npm-run-all --save-dev
# or
$ yarn add npm-run-all --dev
  • It requires Node@>=4.

📖 Usage

CLI Commands

This npm-run-all package provides 3 CLI commands.

The main command is npm-run-all. We can make complex plans with npm-run-all command.

Both run-s and run-p are shorthand commands. run-s is for sequential, run-p is for parallel. We can make simple plans with those commands.

Yarn Compatibility

If a script is invoked with Yarn, npm-run-all will correctly use Yarn to execute the plan's child scripts.

Node API

This npm-run-all package provides Node API.

📰 Changelog

🍻 Contributing

Welcome♡

Bug Reports or Feature Requests

Please use GitHub Issues.

Correct Documents

Please use GitHub Pull Requests.

I'm not familiar with English, so I especially thank you for documents' corrections.

Implementing

Please use GitHub Pull Requests.

There are some npm-scripts to help developments.

  • npm test - Run tests and collect coverage.
  • npm run clean - Delete temporary files.
  • npm run lint - Run ESLint.
  • npm run watch - Run tests (not collect coverage) on every file change.

Releases

Nov 24, 2018

Download .zip

🐛 Bug fixes

52eaf86...1b41ac5 switched ps-tree package to pidtree package for security reason.

Nov 24, 2018

Download .zip

🐛 Bug fixes

d56c268 improved label colors 35f86ae fixed a bug that the script name which starts with ! makes npm-run-all confusing.

Bug fixes

096779b fixed the problem that --aggregate-output option does not work if child tasks print large output (#111). Thank you, @jlopezxs! 693261b fixed the problem that --aggregate-output opti...

Aug 28, 2017

Download .zip

Bug fixes

fbd4024 fixed a regression bug of --print-name.

Aug 26, 2017

Download .zip

Features

e07e782 add --aggregate-output option. This option avoids that the output of tasks is mixed even if parallel mode. Don't use this option if a task never finishes (e.g. web server, file watch...