add foreground-scripts option

PR-URL: #2456 Credit: @isaacs Close: #2456 Reviewed-by: @ruyadorno
npm · Jan 7, 2021 · 47ed2df · 47ed2df
1 parent 54a7bd1
commit 47ed2df
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 deletions.
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -419,6 +419,18 @@ mistakes, unnecessary performance degradation, and malicious input.
 If you don't have a clear idea of what you want to do, it is strongly
 recommended that you do not use this option!
 
+#### 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.
+
 #### format-package-lock
 
 * Default: true

diff --git a/lib/utils/config.js b/lib/utils/config.js
@@ -83,6 +83,7 @@ const defaults = {
   'fetch-retry-mintimeout': 10000,
   'fetch-timeout': 5 * 60 * 1000,
   force: false,
+  'foreground-script': false,
   'format-package-lock': true,
   fund: true,
   git: 'git',
@@ -224,6 +225,7 @@ const types = {
   'fetch-retry-mintimeout': Number,
   'fetch-timeout': Number,
   force: Boolean,
+  'foreground-script': Boolean,
   'format-package-lock': Boolean,
   fund: Boolean,
   git: String,

diff --git a/lib/utils/flat-options.js b/lib/utils/flat-options.js
@@ -133,6 +133,7 @@ const flatten = obj => ({
   packageLockOnly: obj['package-lock-only'],
   globalStyle: obj['global-style'],
   legacyBundling: obj['legacy-bundling'],
+  foregroundScripts: !!obj['foreground-scripts'],
   scriptShell: obj['script-shell'] || undefined,
   shell: obj.shell,
   omit: buildOmitList(obj),

diff --git a/tap-snapshots/test-lib-utils-config.js-TAP.test.js b/tap-snapshots/test-lib-utils-config.js-TAP.test.js
@@ -46,6 +46,7 @@ Object {
     "fetch-retry-mintimeout": 10000,
     "fetch-timeout": 300000,
     "force": false,
+    "foreground-script": false,
     "format-package-lock": true,
     "fund": true,
     "git": "git",
@@ -354,6 +355,7 @@ Object {
     "fetch-retry-mintimeout": "{Number TYPE}",
     "fetch-timeout": "{Number TYPE}",
     "force": "{Boolean TYPE}",
+    "foreground-script": "{Boolean TYPE}",
     "format-package-lock": "{Boolean TYPE}",
     "fund": "{Boolean TYPE}",
     "git": "{String TYPE}",
@@ -573,6 +575,7 @@ Object {
     "fetch-retry-mintimeout": 10000,
     "fetch-timeout": 300000,
     "force": false,
+    "foreground-script": false,
     "format-package-lock": true,
     "fund": true,
     "git": "git",
@@ -881,6 +884,7 @@ Object {
     "fetch-retry-mintimeout": "{Number TYPE}",
     "fetch-timeout": "{Number TYPE}",
     "force": "{Boolean TYPE}",
+    "foreground-script": "{Boolean TYPE}",
     "format-package-lock": "{Boolean TYPE}",
     "fund": "{Boolean TYPE}",
     "git": "{String TYPE}",

diff --git a/tap-snapshots/test-lib-utils-flat-options.js-TAP.test.js b/tap-snapshots/test-lib-utils-flat-options.js-TAP.test.js
@@ -36,6 +36,7 @@ Object {
   "engineStrict": "engine-strict",
   "fmode": 438,
   "force": "force",
+  "foregroundScripts": false,
   "formatPackageLock": "format-package-lock",
   "fund": "fund",
   "git": "git",