@zkochan/cmd-shim 2.2.3 → 3.1.0

package/README.md

@@ -39,6 +39,7 @@ The same as above, but will just continue if the file does not exist.
 - `opts.preserveSymlinks` - _Boolean_ - if true, `--preserve-symlinks` is added to the options passed to NodeJS.
 - `opts.nodePath` - _String_ - sets the [NODE_PATH](https://nodejs.org/api/cli.html#cli_node_path_path) env variable.
 - `opts.createCmdFile` - _Boolean_ - is `true` on Windows by default. If true, creates a cmd file.
+- `opts.createPwshFile` - _Boolean_ - is `true` by default. If true, creates a powershell file.
 
 ```javascript
 const cmdShim = require('@zkochan/cmd-shim')

package/index.d.ts

@@ -0,0 +1,47 @@
+
+interface Options {
+  /**
+   * If a PowerShell script should be created.
+   *
+   * @default true
+   */
+  createPwshFile?: boolean;
+
+  /**
+   * If a Windows Command Prompt script should be created.
+   *
+   * @default false
+   */
+  createCmdFile?: boolean;
+
+  /**
+   * If symbolic links should be preserved.
+   *
+   * @default false
+   */
+  preserveSymlinks?: boolean;
+
+  /**
+   * The path to the executable file.
+   */
+  prog?: string;
+
+  /**
+   * The arguments to initialize the `node` process with.
+   */
+  args?: string;
+
+  /**
+   * The value of the $NODE_PATH environment variable.
+   *
+   * The single `string` format is only kept for legacy compatibility,
+   * and the array form should be preferred.
+   */
+  nodePath?: string | string[];
+}
+
+declare function cmdShim(src: string, to: string, opts: Options): Promise<void>
+declare namespace cmdShim {
+  function cmdShimIfExists(src: string, to: string, opts: Options): Promise<void>
+}
+export = cmdShim;

package/index.js

@@ -19,6 +19,8 @@ const path = require('path')
 const isWindows = require('is-windows')
 const shebangExpr = /^#!\s*(?:\/usr\/bin\/env)?\s*([^ \t]+)(.*)$/
 const DEFAULT_OPTIONS = {
+  // Create PowerShell file by default if the option hasn't been specified
+  createPwshFile: true,
   createCmdFile: isWindows()
 }
 
@@ -42,12 +44,16 @@ function cmdShim (src, to, opts) {
 }
 
 function cmdShim_ (src, to, opts) {
-  return Promise.all([rm(to), opts.createCmdFile && rm(`${to}.cmd`)])
+  return Promise.all([
+    rm(to),
+    rm(`${to}.ps1`),
+    opts.createCmdFile && rm(`${to}.cmd`)
+  ])
     .then(() => writeShim(src, to, opts))
 }
 
 function writeShim (src, to, opts) {
-  opts = opts || {}
+  opts = Object.assign({}, DEFAULT_OPTIONS, opts)
   const defaultArgs = opts.preserveSymlinks ? '--preserve-symlinks' : ''
   // make a cmd file and a sh script
   // First, check if the bin is a #! of some sort.
@@ -61,7 +67,7 @@ function writeShim (src, to, opts) {
           const shebang = firstLine.match(shebangExpr)
           if (!shebang) return writeShim_(src, to, Object.assign({}, opts, {args: defaultArgs}))
           const prog = shebang[1]
-          const args = shebang[2] && (defaultArgs && (shebang[2] + ' ' + defaultArgs) || shebang[2]) || defaultArgs
+          const args = (shebang[2] && ((defaultArgs && (shebang[2] + ' ' + defaultArgs)) || shebang[2])) || defaultArgs
           return writeShim_(src, to, Object.assign({}, opts, {prog, args}))
         })
         .catch(() => writeShim_(src, to, Object.assign({}, opts, {args: defaultArgs})))
@@ -69,24 +75,32 @@ function writeShim (src, to, opts) {
 }
 
 function writeShim_ (src, to, opts) {
-  opts = opts || {}
+  opts = Object.assign({}, DEFAULT_OPTIONS, opts)
   let shTarget = path.relative(path.dirname(to), src)
   let target = shTarget.split('/').join('\\')
   let longProg
   let prog = opts.prog
   let shProg = prog && prog.split('\\').join('/')
   let shLongProg
+  let pwshProg = shProg && `"${shProg}$exe"`
+  let pwshLongProg
   shTarget = shTarget.split('\\').join('/')
   let args = opts.args || ''
+  let {
+    win32: nodePath,
+    posix: shNodePath
+  } = normalizePathEnvVar(opts.nodePath)
   if (!prog) {
     prog = `"%~dp0\\${target}"`
     shProg = `"$basedir/${shTarget}"`
+    pwshProg = shProg
     args = ''
     target = ''
     shTarget = ''
   } else {
     longProg = `"%~dp0\\${prog}.exe"`
     shLongProg = '"$basedir/' + prog + '"'
+    pwshLongProg = `"$basedir/${prog}$exe"`
     target = `"%~dp0\\${target}"`
     shTarget = `"$basedir/${shTarget}"`
   }
@@ -100,7 +114,7 @@ function writeShim_ (src, to, opts) {
     //   SET PATHEXT=%PATHEXT:;.JS;=;%
     //   node "%~dp0\.\node_modules\npm\bin\npm-cli.js" %*
     // )
-    cmd = opts.nodePath ? `@SET NODE_PATH=${opts.nodePath}\r\n` : ''
+    cmd = nodePath ? `@SET NODE_PATH=${nodePath}\r\n` : ''
     if (longProg) {
       cmd += '@IF EXIST ' + longProg + ' (\r\n' +
         '  ' + longProg + ' ' + args + ' ' + target + ' %*\r\n' +
@@ -131,17 +145,16 @@ function writeShim_ (src, to, opts) {
   // exit $ret
 
   let sh = '#!/bin/sh\n'
-  const env = opts.nodePath ? `NODE_PATH="${opts.nodePath}" ` : ''
+  sh = sh +
+    "basedir=$(dirname \"$(echo \"$0\" | sed -e 's,\\\\,/,g')\")\n" +
+    '\n' +
+    'case `uname` in\n' +
+    '    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;\n' +
+    'esac\n' +
+    '\n'
+  const env = opts.nodePath ? `NODE_PATH="${shNodePath}" ` : ''
 
   if (shLongProg) {
-    sh = sh +
-      "basedir=$(dirname \"$(echo \"$0\" | sed -e 's,\\\\,/,g')\")\n" +
-      '\n' +
-      'case `uname` in\n' +
-      '    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;\n' +
-      'esac\n' +
-      '\n'
-
     sh = sh +
       'if [ -x ' + shLongProg + ' ]; then\n' +
       '  ' + env + shLongProg + ' ' + args + ' ' + shTarget + ' "$@"\n' +
@@ -152,20 +165,102 @@ function writeShim_ (src, to, opts) {
       'fi\n' +
       'exit $ret\n'
   } else {
-    sh = env + shProg + ' ' + args + ' ' + shTarget + ' "$@"\n' +
+    sh = sh + env + shProg + ' ' + args + ' ' + shTarget + ' "$@"\n' +
       'exit $?\n'
   }
 
+  // #!/usr/bin/env pwsh
+  // $basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
+  //
+  // $ret=0
+  // $exe = ""
+  // if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
+  //   # Fix case when both the Windows and Linux builds of Node
+  //   # are installed in the same directory
+  //   $exe = ".exe"
+  // }
+  // if (Test-Path "$basedir/node") {
+  //   & "$basedir/node$exe" "$basedir/node_modules/npm/bin/npm-cli.js" $args
+  //   $ret=$LASTEXITCODE
+  // } else {
+  //   & "node$exe" "$basedir/node_modules/npm/bin/npm-cli.js" $args
+  //   $ret=$LASTEXITCODE
+  // }
+  // exit $ret
+  let pwsh = '#!/usr/bin/env pwsh\n' +
+    '$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent\n' +
+    '\n' +
+    '$exe=""\n' +
+    (opts.nodePath ? '$env_node_path=$env:NODE_PATH\n' +
+      `$env:NODE_PATH="${nodePath}"\n` : '') +
+    'if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {\n' +
+    '  # Fix case when both the Windows and Linux builds of Node\n' +
+    '  # are installed in the same directory\n' +
+    '  $exe=".exe"\n' +
+    '}'
+  if (opts.nodePath) {
+    pwsh = pwsh +
+      ' else {\n' +
+      `  $env:NODE_PATH="${shNodePath}"\n` +
+      '}'
+  }
+  pwsh += '\n'
+  if (shLongProg) {
+    pwsh = pwsh +
+      '$ret=0\n' +
+      `if (Test-Path ${pwshLongProg}) {\n` +
+      `  & ${pwshLongProg} ${args} ${shTarget} $args\n` +
+      '  $ret=$LASTEXITCODE\n' +
+      '} else {\n' +
+      `  & ${pwshProg} ${args} ${shTarget} $args\n` +
+      '  $ret=$LASTEXITCODE\n' +
+      '}\n' +
+      (opts.nodePath ? '$env:NODE_PATH=$env_node_path\n' : '') +
+      'exit $ret\n'
+  } else {
+    pwsh = pwsh +
+      `& ${pwshProg} ${args} ${shTarget} $args\n` +
+      (opts.nodePath ? '$env:NODE_PATH=$env_node_path\n' : '') +
+      'exit $LASTEXITCODE\n'
+  }
+
   return Promise.all([
     opts.createCmdFile && fs.writeFile(to + '.cmd', cmd, 'utf8'),
+    opts.createPwshFile && fs.writeFile(`${to}.ps1`, pwsh, 'utf8'),
     fs.writeFile(to, sh, 'utf8')
   ])
-  .then(() => chmodShim(to, opts.createCmdFile))
+    .then(() => chmodShim(to, opts))
 }
 
-function chmodShim (to, createCmdFile) {
+function chmodShim (to, {createCmdFile, createPwshFile}) {
   return Promise.all([
     fs.chmod(to, 0o755),
+    createPwshFile && fs.chmod(`${to}.ps1`, 0o755),
     createCmdFile && fs.chmod(`${to}.cmd`, 0o755)
   ])
 }
+
+/**
+ * @param {string|string[]} nodePath
+ * @returns {{win32:string,posix:string}}
+ */
+function normalizePathEnvVar (nodePath) {
+  if (!nodePath) {
+    return {
+      win32: nodePath,
+      posix: nodePath
+    }
+  }
+  let split = (typeof nodePath === 'string' ? nodePath.split(path.delimiter) : Array.from(nodePath))
+  let result = {}
+  for (let i = 0; i < split.length; i++) {
+    const win32 = split[i].split('/').join('\\')
+    const posix = isWindows() ? split[i].split('\\').join('/').replace(/^([^:\\/]*):/, (_, $1) => `/mnt/${$1.toLowerCase()}`) : split[i]
+
+    result.win32 = result.win32 ? `${result.win32};${win32}` : win32
+    result.posix = result.posix ? `${result.posix}:${posix}` : posix
+
+    result[i] = {win32, posix}
+  }
+  return result
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkochan/cmd-shim",
-  "version": "2.2.3",
+  "version": "3.1.0",
   "description": "Used in pnpm for command line application support",
   "author": {
     "name": "Zoltan Kochan",
@@ -8,13 +8,15 @@
     "url": "http://kochan.io"
   },
   "scripts": {
-    "test:unit": "tape test/*.js | tap-diff",
+    "test:unit": "tape test/*.js",
     "test": "standard && npm run test:unit && mos test",
     "md": "mos"
   },
   "files": [
+    "index.d.ts",
     "index.js"
   ],
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/pnpm/cmd-shim.git"
@@ -28,14 +30,13 @@
   "devDependencies": {
     "mos": "^1.3.1",
     "mos-plugin-readme": "^1.0.4",
-    "rimraf": "~2.2.8",
-    "standard": "^8.5.0",
-    "tap-diff": "^0.1.1",
+    "rimraf": "^2.6.2",
+    "standard": "^11.0.1",
     "tape": "^4.6.2",
-    "tape-promise": "^2.0.0"
+    "tape-promise": "^3.0.0"
   },
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   },
   "mos": {
     "plugins": [