summaryrefslogtreecommitdiffstats
path: root/node_modules/npm-run-all/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/npm-run-all/README.md')
-rw-r--r--node_modules/npm-run-all/README.md91
1 files changed, 91 insertions, 0 deletions
diff --git a/node_modules/npm-run-all/README.md b/node_modules/npm-run-all/README.md
new file mode 100644
index 0000000..b80d787
--- /dev/null
+++ b/node_modules/npm-run-all/README.md
@@ -0,0 +1,91 @@
+| index | [npm-run-all] | [run-s] | [run-p] | [Node API] |
+|-------|---------------|---------|---------|------------|
+
+# npm-run-all
+
+[![npm version](https://img.shields.io/npm/v/npm-run-all.svg)](https://www.npmjs.com/package/npm-run-all)
+[![Downloads/month](https://img.shields.io/npm/dm/npm-run-all.svg)](http://www.npmtrends.com/npm-run-all)
+[![Build Status](https://travis-ci.org/mysticatea/npm-run-all.svg?branch=master)](https://travis-ci.org/mysticatea/npm-run-all)
+[![Build status](https://ci.appveyor.com/api/projects/status/v0owd44q1r7hceir/branch/master?svg=true)](https://ci.appveyor.com/project/mysticatea/npm-run-all/branch/master)
+[![Coverage Status](https://codecov.io/gh/mysticatea/eslint-plugin-node/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/npm-run-all)
+[![Dependency Status](https://david-dm.org/mysticatea/npm-run-all.svg)](https://david-dm.org/mysticatea/npm-run-all)
+
+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.<br>
+ Before: `npm run clean && npm run build:css && npm run build:js && npm run build:html`<br>
+ 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
+
+```bash
+$ 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.
+
+- [npm-run-all]
+- [run-s]
+- [run-p]
+
+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.
+
+- [Node API]
+
+## 📰 Changelog
+
+- https://github.com/mysticatea/npm-run-all/releases
+
+## 🍻 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.
+
+[npm-run-all]: docs/npm-run-all.md
+[run-s]: docs/run-s.md
+[run-p]: docs/run-p.md
+[Node API]: docs/node-api.md