run-script: allow custom shell (#16687)

Fixes: npm/npm#6543 PR-URL: npm/npm#16687 Credit: @mmkal Reviewed-By: @zkat Reviewed-By: @iarna
wl363535796 · Jul 5, 2017 · a09c1a6 · a09c1a6
1 parent 7d65004
commit a09c1a6
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/doc/misc/npm-config.md b/doc/misc/npm-config.md
@@ -889,6 +889,13 @@ in to a private registry for the first time:
 will cause `@organization` to be mapped to the registry for future installation
 of packages specified according to the pattern `@organization/package`.
 
+### script-shell
+
+* Default: `null`
+* Type: path
+
+The shell to use for scripts run with the `npm run` command.
+
 ### scripts-prepend-node-path
 
 * Default: "warn-only"

diff --git a/lib/config/defaults.js b/lib/config/defaults.js
@@ -203,6 +203,7 @@ Object.defineProperty(exports, 'defaults', {get: function () {
     'save-prefix': '^',
     'save-prod': false,
     scope: '',
+    'script-shell': null,
     'scripts-prepend-node-path': 'warn-only',
     searchopts: '',
     searchexclude: null,
@@ -326,6 +327,7 @@ exports.types = {
   'save-prefix': String,
   'save-prod': Boolean,
   scope: String,
+  'script-shell': [null, String],
   'scripts-prepend-node-path': [false, true, 'auto', 'warn-only'],
   searchopts: String,
   searchexclude: [null, String],

diff --git a/lib/utils/lifecycle.js b/lib/utils/lifecycle.js
@@ -264,7 +264,11 @@ function runCmd_ (cmd, pkg, env, wd, stage, unsafe, uid, gid, cb_) {
   var sh = 'sh'
   var shFlag = '-c'
 
-  if (process.platform === 'win32') {
+  var customShell = npm.config.get('script-shell')
+
+  if (customShell) {
+    sh = customShell
+  } else if (process.platform === 'win32') {
     sh = process.env.comspec || 'cmd'
     shFlag = '/d /s /c'
     conf.windowsVerbatimArguments = true

diff --git a/test/tap/run-script.js b/test/tap/run-script.js
@@ -75,6 +75,14 @@ var exitCode = {
   }
 }
 
+var shell = {
+  name: 'scripted',
+  version: '1.2.3',
+  scripts: {
+    'start': 'echo foo'
+  }
+}
+
 function testOutput (t, command, er, code, stdout, stderr) {
   var lines
 
@@ -308,6 +316,12 @@ test('npm run-script no-params (direct only)', function (t) {
   })
 })
 
+test('npm run-script script-shell config', function (t) {
+    writeMetadata(shell)
+
+    common.npm(['run-script', 'start', '--script-shell', 'echo'], opts, testOutput.bind(null, t, '-c echo foo'))
+})
+
 test('npm run-script no-params (direct only)', function (t) {
   var expected = [
     'Lifecycle scripts included in scripted:',