first commit

2026-10-07 18:56:27 +02:00
commit 2a8a60b725
7768 changed files with 1550851 additions and 0 deletions
@@ -0,0 +1,77 @@
+/**
+ * @author Toru Nagashima
+ * @copyright 2016 Toru Nagashima. All rights reserved.
+ * @copyright 2026 Bret Comnes. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ *
+ * @import { Writable } from 'node:stream'
+ */
+
+// ------------------------------------------------------------------------------
+// Public Interface
+// ------------------------------------------------------------------------------
+
+/**
+ * Print a help text.
+ *
+ * @param {Writable} output - A writable stream to print.
+ * @returns {Promise<null>} Always a fulfilled promise.
+ * @private
+ */
+export default 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.
+    -x, --node-run   - - - - - Use \`node --run\` to execute scripts instead of
+                               the package manager. This is faster but
+                               intentionally omits: pre/post lifecycle hooks
+                               and npm_* environment variables. node_modules/.bin
+                               is still added to PATH. Sets NODE_RUN_SCRIPT_NAME
+                               and NODE_RUN_PACKAGE_JSON_PATH instead.
+                               Can also be enabled project-wide by setting
+                               \`"npm-run-all2": { "nodeRun": true }\` in
+                               package.json.
+
+    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)
+}