fix(env): Do not clobber defined 'env' script

If an env script is already defined, run that instead of the default. PR-URL: #2655 Credit: @isaacs Close: #2655 Reviewed-by: @ljharb
npm · Feb 11, 2021 · ef687f5 · ef687f5
1 parent e815cd4
commit ef687f5
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 6 deletions.
diff --git a/lib/run-script.js b/lib/run-script.js
@@ -41,7 +41,7 @@ const runScript = async (args) => {
 
   if (event === 'restart' && !scripts.restart)
     scripts.restart = 'npm stop --if-present && npm start'
-  else if (event === 'env')
+  else if (event === 'env' && !scripts.env)
     scripts.env = isWindowsShell ? 'SET' : 'env'
 
   pkg.scripts = scripts

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -45,7 +45,6 @@
     "@npmcli/arborist": "^2.2.1",
     "@npmcli/ci-detect": "^1.2.0",
     "@npmcli/config": "^1.2.9",
-    "@npmcli/installed-package-contents": "^1.0.7",
     "@npmcli/run-script": "^1.8.2",
     "abbrev": "~1.1.1",
     "ansicolors": "~0.3.2",

diff --git a/test/lib/run-script.js b/test/lib/run-script.js
@@ -126,12 +126,14 @@ t.test('default env, start, and restart scripts', async t => {
         scriptShell: undefined,
         stdio: 'inherit',
         stdioString: true,
-        pkg: { name: 'x',
+        pkg: {
+          name: 'x',
           version: '1.2.3',
           _id: 'x@1.2.3',
           scripts: {
             env: 'env',
-          } },
+          },
+        },
         event: 'env',
       },
     ])
@@ -185,6 +187,67 @@ t.test('default env, start, and restart scripts', async t => {
   RUN_SCRIPTS.length = 0
 })
 
+t.test('non-default env script', async t => {
+  npm.localPrefix = t.testdir({
+    'package.json': JSON.stringify({
+      name: 'x',
+      version: '1.2.3',
+      scripts: {
+        env: 'hello',
+      },
+    }),
+  })
+
+  await runScript(['env'], er => {
+    if (er)
+      throw er
+
+    t.match(RUN_SCRIPTS, [
+      {
+        path: npm.localPrefix,
+        args: [],
+        scriptShell: undefined,
+        stdio: 'inherit',
+        stdioString: true,
+        pkg: {
+          name: 'x',
+          version: '1.2.3',
+          _id: 'x@1.2.3',
+          scripts: {
+            env: 'hello',
+          },
+        },
+        event: 'env',
+      },
+    ])
+  })
+  RUN_SCRIPTS.length = 0
+
+  await runScriptWin(['env'], er => {
+    if (er)
+      throw er
+
+    t.match(RUN_SCRIPTS, [
+      {
+        path: npm.localPrefix,
+        args: [],
+        scriptShell: undefined,
+        stdio: 'inherit',
+        stdioString: true,
+        pkg: { name: 'x',
+          version: '1.2.3',
+          _id: 'x@1.2.3',
+          scripts: {
+            env: 'hello',
+          },
+        },
+        event: 'env',
+      },
+    ])
+  })
+  RUN_SCRIPTS.length = 0
+})
+
 t.test('try to run missing script', t => {
   npm.localPrefix = t.testdir({
     'package.json': JSON.stringify({