spawn-default-shell - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "spawn-default-shell",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Spawn shell command with platform default shell",
@@ -31,2 +31,3 @@ "main": "src/index.js",
     "eslint-plugin-import": "^1.15.0",
+    "lodash": "^4.16.2",
     "mocha": "^3.0.2",
@@ -36,5 +37,6 @@ "releasor": "^1.2.1"
   "scripts": {
-    "test": "mocha",
+    "test": "npm run test-debug-print && mocha",
+    "test-debug-print": "node -e \"var a = require('./src/get-shell')(); console.log('> getShell()\\n' + JSON.stringify(a, null, 2));\"",
     "lint": "eslint ./src ./test"
   }
 }

README.md

@@ -5,5 +5,10 @@ # spawn-default-shell
 
-Like `child_process.spawn` but with shell benefits. You can just pass the command
-as a string, and it will be executed in the platform default shell.
+[![Build Status](https://travis-ci.org/kimmobrunfeldt/spawn-default-shell.svg?branch=master)](https://travis-ci.org/kimmobrunfeldt/spawn-default-shell) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/kimmobrunfeldt/spawn-default-shell?branch=master&svg=true)](https://ci.appveyor.com/project/kimmobrunfeldt/spawn-default-shell) *master branch status*
 
+[![NPM Badge](https://nodei.co/npm/spawn-default-shell.png?downloads=true)](https://www.npmjs.com/package/spawn-default-shell)
+
+Like `child_process.spawn` with `shell: true` option but a bit more
+convenient and customizable. You can just pass the command as a string,
+and it will be executed in the platform default shell. Used in [concurrently](https://github.com/kimmobrunfeldt/concurrently).
+
 ```js
@@ -10,0 +15,0 @@ // If we are in Linux / Mac, this will work

src/get-shell.js

@@ -1,21 +0,38 @@
-function getShell() {
-  const env = process.env;
+const DETECT_CMD_REGEX = /cmd.exe/;
+// All sh variant names I found end with "sh":
+// https://en.wikipedia.org/wiki/List_of_command-line_interpreters
+const DETECT_SH_REGEX = /sh$/;
 
+function detectPlatformShell() {
   if (process.platform === 'darwin') {
-    return {
-      shell: env.SHELL || '/bin/bash',
-      executeFlag: env.SHELL_EXECUTE_FLAG || '-c',
-    };
+    return process.env.SHELL || '/bin/bash';
   }
 
   if (process.platform === 'win32') {
-    return {
-      shell: env.SHELL || env.COMSPEC || 'cmd.exe',
-      executeFlag: env.SHELL_EXECUTE_FLAG || '/c',
-    };
+    return process.env.SHELL || process.env.COMSPEC || 'cmd.exe';
   }
 
+  return process.env.SHELL || '/bin/sh';
+}
+
+function detectExecuteFlag(shell) {
+  if (process.env.SHELL_EXECUTE_FLAG) {
+    return process.env.SHELL_EXECUTE_FLAG;
+  }
+
+  if (shell.match(DETECT_CMD_REGEX)) {
+    return '/c';
+  } else if (shell.match(DETECT_SH_REGEX)) {
+    return '-c';
+  }
+
+  throw new Error('Unable to detect platform shell type. Please set SHELL_EXECUTE_FLAG env variable.');
+}
+
+function getShell() {
+  const shell = detectPlatformShell();
+
   return {
-    shell: env.SHELL || '/bin/sh',
-    executeFlag: env.SHELL_EXECUTE_FLAG || '-c',
+    shell: shell,
+    executeFlag: detectExecuteFlag(shell),
   };
@@ -22,0 +39,0 @@ }

src/index.js

@@ -15,3 +15,3 @@ const childProcess = require('child_process');
 module.exports = {
-  spawn: spawn
+  spawn: spawn,
 };

test/test-all.js

@@ -1,19 +0,26 @@
-const assert = require('assert');
-const defaultShell = require('../src/index');
+const _ = require('lodash');
+const testBasic = require('./test-basic');
+const testPlatformShared = require('./test-platform-shared');
 
+const PLATFORMS = ['darwin', 'freebsd', 'linux', 'sunos', 'win32'];
+const originalPlatform = Object.getOwnPropertyDescriptor(process, 'platform');
+
 describe('spawn-default-shell', () => {
-  it('piping should work', (done) => {
-    const child = defaultShell.spawn('cat test/data/test.txt | grep 1', {
-      stdio: 'pipe',
-    });
+  testBasic();
+});
 
-    child.stdout.on('data', (data) => {
-      assert.strictEqual(data.toString('utf8'), '1 äö☃\n');
-    });
+describe('shared tests on each platform (mocking)', () => {
+  _.each(PLATFORMS, (platform) => {
+    describe(`process.platform = "${platform}"`, () => {
+      before(() => {
+        Object.defineProperty(process, 'platform', { value: platform });
+      });
 
-    child.on('close', (code) => {
-      assert.strictEqual(code, 0);
-      done();
+      after(() => {
+        Object.defineProperty(process, 'platform', originalPlatform);
+      });
+
+      testPlatformShared();
     });
   });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12714

increased by113.9%

Number of package files

16

increased by33.33%

Lines of code

206

increased by320.41%

Number of lines in readme file

48

increased by11.63%

Worsened metrics

Dev dependency count

6

increased by20%

Number of low supply chain risk alerts

4

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes