Make it work

Author: AlphaHydrae

.github/workflows/build.yml

@@ -1,8 +1,10 @@
 name: build
+
 env:
   DEBUG: napi:*
   APP_NAME: exec
   CARGO_INCREMENTAL: '1'
+
 permissions:
   contents: write
   id-token: write
@@ -20,11 +22,16 @@ permissions:
       - .prettierignore
       - .prettierrc.yml
   pull_request: null
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+
 jobs:
   build:
+    name: Build ${{ matrix.settings.target }} with node@22
+    runs-on: ${{ matrix.settings.host }}
+    if: ${{ github.ref == 'refs/head/main' || startsWith(github.ref, 'refs/tags/') }}
     strategy:
       fail-fast: false
       matrix:
@@ -54,8 +61,6 @@ jobs:
               set -e &&
               rustup target add aarch64-unknown-linux-musl &&
               npm run build -- --target aarch64-unknown-linux-musl
-    name: stable - ${{ matrix.settings.target }} - node@22
-    runs-on: ${{ matrix.settings.host }}
     steps:
       - uses: actions/checkout@v4
       - name: Setup node
@@ -103,8 +108,9 @@ jobs:
           name: bindings-${{ matrix.settings.target }}
           path: ${{ env.APP_NAME }}.*.node
           if-no-files-found: error
+
   test-macos-binding:
-    name: Test bindings on ${{ matrix.settings.target }} - node@${{ matrix.node }}
+    name: Test ${{ matrix.settings.target }} with node@${{ matrix.node }}
     needs:
       - build
     strategy:
@@ -142,8 +148,9 @@ jobs:
         shell: bash
       - name: Test bindings
         run: npm test
+
   test-linux-x64-gnu-binding:
-    name: Test bindings on Linux-x64-gnu - node@${{ matrix.node }}
+    name: Test Linux-x64-gnu with node@${{ matrix.node }}
     needs:
       - build
     strategy:
@@ -173,8 +180,9 @@ jobs:
         shell: bash
       - name: Test bindings
         run: docker run --rm -v $(pwd):/build -w /build node:${{ matrix.node }}-slim npm test
+
   test-linux-x64-musl-binding:
-    name: Test bindings on x86_64-unknown-linux-musl - node@${{ matrix.node }}
+    name: Test x86_64-unknown-linux-musl with node@${{ matrix.node }}
     needs:
       - build
     strategy:
@@ -205,8 +213,9 @@ jobs:
         shell: bash
       - name: Test bindings
         run: docker run --rm -v $(pwd):/build -w /build node:${{ matrix.node }}-alpine npm test
+
   test-linux-aarch64-gnu-binding:
-    name: Test bindings on aarch64-unknown-linux-gnu - node@${{ matrix.node }}
+    name: Test aarch64-unknown-linux-gnu with node@${{ matrix.node }}
     needs:
       - build
     strategy:
@@ -244,8 +253,9 @@ jobs:
             set -e
             npm test
             ls -la
+
   test-linux-aarch64-musl-binding:
-    name: Test bindings on aarch64-unknown-linux-musl - node@lts
+    name: Test aarch64-unknown-linux-musl with node@22
     needs:
       - build
     runs-on: ubuntu-latest
@@ -270,11 +280,12 @@ jobs:
       - name: Setup and run tests
         uses: addnab/docker-run-action@v3
         with:
-          image: node:lts-alpine
+          image: node:22-alpine
           options: '--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build'
           run: |
             set -e
             npm test
+
   publish:
     name: Publish
     runs-on: ubuntu-latest

README.md

@@ -2,7 +2,25 @@
 
 The [`execvp` function](https://linux.die.net/man/3/execvp) for Node.js.
 
-## Install this package
+```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
@@ -18,3 +36,7 @@ npm i @alphahydrae/exec
 | 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.

build.rs

@@ -1,5 +1,5 @@
 extern crate napi_build;
 
 fn main() {
-  napi_build::setup();
+    napi_build::setup();
 }

exec.d.ts

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

exec.js

@@ -1,6 +1,8 @@
-const { doNotCloseOnExit, execvp } = require('./index.js');
+const native = require('./index.js');
 
-doNotCloseOnExit(process.stdin.fd);
-doNotCloseOnExit(process.stdout.fd);
-doNotCloseOnExit(process.stderr.fd);
-execvp('ls', [process.argv0, 'tests']);
+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]);
+};

npm/darwin-arm64/package.json

@@ -24,4 +24,4 @@
   "engines": {
     "node": "^18 || ^20 || ^22"
   }
-}
+}

npm/darwin-x64/package.json

@@ -24,4 +24,4 @@
   "engines": {
     "node": "^18 || ^20 || ^22"
   }
-}
+}

npm/linux-arm64-gnu/package.json

@@ -27,4 +27,4 @@
   "engines": {
     "node": "^18 || ^20 || ^22"
   }
-}
+}

npm/linux-arm64-musl/package.json

@@ -27,4 +27,4 @@
   "engines": {
     "node": "^18 || ^20 || ^22"
   }
-}
+}

npm/linux-x64-gnu/package.json

@@ -27,4 +27,4 @@
   "engines": {
     "node": "^18 || ^20 || ^22"
   }
-}
+}