npm - @alphahydrae/exec - Versions diffs - 0.2.1 - Mend

@alphahydrae/exec 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE.txt ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Simon Oulevay (Alpha Hydrae)
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,42 @@
+# `@alphahydrae/exec`
+The [`execvp` function](https://linux.die.net/man/3/execvp) for Node.js.
+```js
+import { execvp } from '@alphahydrae/exec';
+execvp('ls', ['.']);
+console.log(`
+  This will never print because the executing Node.js
+  program is replaced by the executed command, keeping
+  the same process ID and file descriptors.
+`)
+```
+If you're familiar with Bash's `exec` function, this is the same for Node.js.
+This package was developed to be used in Node.js scripts that are frontends to
+execute other commands. For example, a script that would build and execute a
+complex SSH or Ansible command.
+## Installation
+```bash
+npm i @alphahydrae/exec
+```
+## Support matrix
+| OS & Architecture | Node 18 | Node 20 | Node 22 |
+| ----------------- | ------- | ------- | ------- |
+| macOS x64         | ✓       | ✓       | ✓       |
+| macOS arm64       | ✓       | ✓       | ✓       |
+| Linux x64 gnu     | ✓       | ✓       | ✓       |
+| Linux x64 musl    | ✓       | ✓       | ✓       |
+| Linux arm64 gnu   | ✓       | ✓       | ✓       |
+| Linux arm64 musl  | ✓       | ✓       | ✓       |
+> The `exec` family of functions is part of the
+> [POSIX](https://en.wikipedia.org/wiki/POSIX) operating system API, so it will
+> not work on Windows.

package/exec.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function execvp(file: string, args: Array<string>): void;

package/exec.js ADDED Viewed

@@ -0,0 +1,8 @@
+const native = require('./index.js');
+module.exports.execvp = function (file, args) {
+  native.doNotCloseOnExit(process.stdin.fd);
+  native.doNotCloseOnExit(process.stdout.fd);
+  native.doNotCloseOnExit(process.stderr.fd);
+  native.execvp(file, [process.argv0, ...args]);
+};

package/index.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/* eslint-disable */
+/* auto-generated by NAPI-RS */
+export declare function execvp(file: string, args: Array<string>): void
+export declare function doNotCloseOnExit(fd: number): void

package/index.js ADDED Viewed

@@ -0,0 +1,316 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+/* auto-generated by NAPI-RS */
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+const { platform, arch } = process
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'exec.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.android-arm64.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'exec.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'exec.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'exec.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'exec.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'exec.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./exec.darwin-universal.node')
+      } else {
+        nativeBinding = require('@alphahydrae/exec-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'exec.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.darwin-x64.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'exec.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'exec.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./exec.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@alphahydrae/exec-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'exec.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./exec.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@alphahydrae/exec-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'exec.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./exec.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@alphahydrae/exec-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+const { execvp, doNotCloseOnExit } = nativeBinding
+module.exports.execvp = execvp
+module.exports.doNotCloseOnExit = doNotCloseOnExit

package/package.json ADDED Viewed

@@ -0,0 +1,74 @@
+{
+  "name": "@alphahydrae/exec",
+  "version": "0.2.1",
+  "description": "The execvp function for Node.js",
+  "main": "exec.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlphaHydrae/node-exec.git"
+  },
+  "license": "MIT",
+  "keywords": [
+    "exec",
+    "execvp"
+  ],
+  "files": [
+    "exec.d.ts",
+    "exec.js",
+    "index.d.ts",
+    "index.js"
+  ],
+  "napi": {
+    "name": "exec",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "x86_64-apple-darwin",
+        "x86_64-unknown-linux-gnu",
+        "x86_64-unknown-linux-musl",
+        "aarch64-apple-darwin",
+        "aarch64-unknown-linux-gnu",
+        "aarch64-unknown-linux-musl"
+      ]
+    }
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "check": "npm run lint && npm run format",
+    "check:write": "npm run lint && npm run format:write",
+    "format": "npm run format:cargo && npm run format:prettier",
+    "format:cargo": "cargo fmt --check",
+    "format:cargo:write": "cargo fmt",
+    "format:prettier": "prettier --check .",
+    "format:prettier:write": "prettier --write .",
+    "format:write": "npm run format:cargo:write && npm run format:prettier:write",
+    "lint": "cargo clippy",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "jest",
+    "version": "napi version"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4",
+    "@swc-node/register": "^1.10.6",
+    "@swc/core": "^1.6.13",
+    "chalk": "^5.3.0",
+    "doctoc": "^2.2.1",
+    "jest": "^29.7.0",
+    "npm-run-all2": "^7.0.0",
+    "prettier": "^3.4.2",
+    "typescript": "^5.5.3"
+  },
+  "engines": {
+    "node": "^18 || ^20 || ^22"
+  },
+  "optionalDependencies": {
+    "@alphahydrae/exec-darwin-x64": "0.2.1",
+    "@alphahydrae/exec-linux-x64-gnu": "0.2.1",
+    "@alphahydrae/exec-linux-x64-musl": "0.2.1",
+    "@alphahydrae/exec-darwin-arm64": "0.2.1",
+    "@alphahydrae/exec-linux-arm64-gnu": "0.2.1",
+    "@alphahydrae/exec-linux-arm64-musl": "0.2.1"
+  }
+}