123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- /**
- * @author Toru Nagashima
- * @copyright 2016 Toru Nagashima. All rights reserved.
- * See LICENSE file in root directory for full license.
- */
- 'use strict'
- // ------------------------------------------------------------------------------
- // Public Interface
- // ------------------------------------------------------------------------------
- /**
- * Print a help text.
- *
- * @param {stream.Writable} output - A writable stream to print.
- * @returns {Promise} Always a fulfilled promise.
- * @private
- */
- module.exports = function printHelp (output) {
- output.write(`
- Usage:
- $ run-p [--help | -h | --version | -v]
- $ run-p [OPTIONS] <tasks>
- Run given npm-scripts in parallel.
- <tasks> : A list of npm-scripts' names and Glob-like patterns.
- Options:
- --aggregate-output - - - Avoid interleaving output by delaying printing of
- each command's output until it has finished.
- -c, --continue-on-error - Set the flag to continue executing other tasks
- even if a task threw an error. 'run-p' itself
- will exit with non-zero code if one or more tasks
- threw error(s).
- --max-parallel <number> - Set the maximum number of parallelism. Default is
- unlimited.
- --npm-path <string> - - - Set the path to npm. Default is the value of
- environment variable npm_execpath.
- If the variable is not defined, then it's "npm."
- In this case, the "npm" command must be found in
- environment variable PATH.
- -l, --print-label - - - - Set the flag to print the task name as a prefix
- on each line of output. Tools in tasks may stop
- coloring their output if this option was given.
- -n, --print-name - - - - Set the flag to print the task name before
- running each task.
- -r, --race - - - - - - - Set the flag to kill all tasks when a task
- finished with zero.
- -s, --silent - - - - - - Set 'silent' to the log level of npm.
- Shorthand aliases can be combined.
- For example, '-clns' equals to '-c -l -n -s'.
- Examples:
- $ run-p watch:**
- $ run-p --print-label "build:** -- --watch"
- $ run-p -sl "build:** -- --watch"
- $ run-p start-server start-browser start-electron
- See Also:
- https://github.com/mysticatea/npm-run-all#readme
- `)
- return Promise.resolve(null)
- }
|