Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs: add foreground-scripts to run-script page (#5087)
  • Loading branch information
ruyadorno committed Jun 29, 2022
1 parent 0ce09f1 commit 5be7d6e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
15 changes: 15 additions & 0 deletions docs/content/commands/npm-run-script.md
Expand Up @@ -240,6 +240,21 @@ will *not* run any pre- or post-scripts.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->

#### `foreground-scripts`

* Default: false
* Type: Boolean

Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
scripts for installed packages in the foreground process, sharing standard
input, output, and error with the main npm process.

Note that this will generally make installs run slower, and be much noisier,
but can be useful for debugging.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->

#### `script-shell`

* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
Expand Down
1 change: 1 addition & 0 deletions lib/commands/run-script.js
Expand Up @@ -35,6 +35,7 @@ class RunScript extends BaseCommand {
'include-workspace-root',
'if-present',
'ignore-scripts',
'foreground-scripts',
'script-shell',
]

Expand Down
2 changes: 1 addition & 1 deletion tap-snapshots/test/lib/load-all-commands.js.test.cjs
Expand Up @@ -746,7 +746,7 @@ npm run-script <command> [-- <args>]
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--if-present] [--ignore-scripts]
[--script-shell <script-shell>]
[--foreground-scripts] [--script-shell <script-shell>]
aliases: run, rum, urn
Expand Down
2 changes: 1 addition & 1 deletion tap-snapshots/test/lib/npm.js.test.cjs
Expand Up @@ -790,7 +790,7 @@ All commands:
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--if-present] [--ignore-scripts]
[--script-shell <script-shell>]
[--foreground-scripts] [--script-shell <script-shell>]
aliases: run, rum, urn
Expand Down

0 comments on commit 5be7d6e

Please sign in to comment.