test: add windows path support

Author: watilde

lib/install/installer/bin.js

@@ -2,29 +2,94 @@ const fs = require('fs-extra')
 const path = require('path')
 const nm = require('../../utils/nm')
 
+const isWindows = process.platform === 'win32'
+const removeIfExists = (filePath) => {
+  try {
+    fs.rmSync(filePath, { force: true })
+  } catch (error) {
+    if (error.code !== 'ENOENT') {
+      throw error
+    }
+  }
+}
+
+const makePosixLink = (source, dest) => {
+  removeIfExists(dest)
+  fs.symlinkSync(source, dest)
+  try {
+    fs.chmodSync(source, 0o755)
+  } catch (error) {
+    if (error.code !== 'ENOENT') throw error
+  }
+}
+
+const makeWindowsShims = (source, dest) => {
+  removeIfExists(dest)
+  let linked = false
+  try {
+    fs.symlinkSync(source, dest, 'file')
+    linked = true
+  } catch (error) {
+    if (!['EACCES', 'EPERM', 'UNKNOWN'].includes(error.code)) {
+      throw error
+    }
+    fs.copyFileSync(source, dest)
+  }
+
+  try {
+    fs.chmodSync(source, 0o755)
+  } catch (error) {
+    if (!['ENOENT', 'EPERM', 'EINVAL'].includes(error.code)) {
+      throw error
+    }
+  }
+
+  const nodePath = process.execPath
+  const cmdContent = `@ECHO OFF\r\n"${nodePath}" "${source}" %*\r\n`
+  const psContent = `& "${nodePath}" "${source}" $args\r\n`
+
+  removeIfExists(`${dest}.cmd`)
+  removeIfExists(`${dest}.ps1`)
+
+  fs.writeFileSync(`${dest}.cmd`, cmdContent, 'utf8')
+  fs.writeFileSync(`${dest}.ps1`, psContent, 'utf8')
+
+  return linked
+}
+
+const createBinEntry = (command, relativePath, targetDir) => {
+  const binDir = path.join(nm, '.bin')
+  const source = path.join(targetDir, relativePath)
+  const dest = path.join(binDir, command)
+
+  fs.ensureDirSync(binDir)
+
+  if (isWindows) {
+    makeWindowsShims(source, dest)
+  } else {
+    makePosixLink(source, dest)
+  }
+
+  if (!isWindows) return
+
+  try {
+    fs.chmodSync(dest, 0o755)
+  } catch (error) {
+    if (!['ENOENT', 'EPERM', 'EINVAL'].includes(error.code)) {
+      throw error
+    }
+  }
+}
+
 const bin = (key, target) => {
   const pkgJSON = require(path.join(target, 'package.json'))
   if (!pkgJSON.bin) return
-  fs.ensureDirSync(path.join(nm, '.bin'))
+
   if (typeof pkgJSON.bin === 'string') {
-    try {
-      fs.unlinkSync(path.join(nm, '.bin', key))
-    } catch (e) {}
-    fs.symlinkSync(
-      path.join(target, pkgJSON.bin),
-      path.join(nm, '.bin', key)
-    )
-    fs.chmodSync(path.join(target, pkgJSON.bin), '0755')
+    createBinEntry(key, pkgJSON.bin, target)
   } else if (typeof pkgJSON.bin === 'object') {
     Object.keys(pkgJSON.bin).forEach((cmd) => {
-      try {
-        fs.unlinkSync(path.join(nm, '.bin', cmd))
-      } catch (e) {}
-      fs.symlinkSync(
-        path.join(target, pkgJSON.bin[cmd]),
-        path.join(nm, '.bin', cmd)
-      )
-      fs.chmodSync(path.join(target, pkgJSON.bin[cmd]), '0755')
+      createBinEntry(cmd, pkgJSON.bin[cmd], target)
     })
   }
 }

test/12-install-bin.js

@@ -18,15 +18,33 @@ test((t) => {
     const binPath = resolveBinPath()
     t.ok(fs.existsSync(binPath), `${packageJson.name}: happy-birthday bin exists`)
 
-    if (process.platform !== 'win32') {
-      const linkStats = fs.lstatSync(binPath)
-      t.ok(linkStats.isSymbolicLink(), `${packageJson.name}: bin entry is a symlink`)
-    }
+    const binStats = fs.lstatSync(binPath)
+
+    if (binStats.isSymbolicLink()) {
+      const resolved = fs.realpathSync(binPath)
+      t.equal(resolved, resolveBinTarget(), `${packageJson.name}: bin resolves to package script`)
 
-    const resolved = fs.realpathSync(binPath)
-    t.equal(resolved, resolveBinTarget(), `${packageJson.name}: bin resolves to package script`)
+      const stat = fs.statSync(binPath)
+      t.ok(isExecutable(stat.mode), `${packageJson.name}: bin entry is executable`)
+    } else if (process.platform === 'win32') {
+      const cmdShim = `${binPath}.cmd`
+      const psShim = `${binPath}.ps1`
+      t.ok(fs.existsSync(cmdShim), `${packageJson.name}: cmd shim exists`)
+      t.ok(fs.existsSync(psShim), `${packageJson.name}: powershell shim exists`)
+      const target = resolveBinTarget()
+      const shimContent = fs.readFileSync(cmdShim, 'utf8')
+      t.match(
+        shimContent.replace(/\\/g, '/'),
+        target.replace(/\\/g, '/'),
+        `${packageJson.name}: cmd shim points to target script`
+      )
+      const binContent = fs.readFileSync(binPath, 'utf8')
+      const targetContent = fs.readFileSync(target, 'utf8')
+      t.equal(binContent, targetContent, `${packageJson.name}: fallback bin matches target content`)
+    } else {
+      const resolved = fs.realpathSync(binPath)
+      t.equal(resolved, resolveBinTarget(), `${packageJson.name}: bin resolves to package script`)
 
-    if (process.platform !== 'win32') {
       const stat = fs.statSync(binPath)
       t.ok(isExecutable(stat.mode), `${packageJson.name}: bin entry is executable`)
     }