feat!: bump engines requirement to Node 22

.eslintignore

@@ -0,0 +1,2 @@
+*.d.ts
+/node_modules

.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2025,
+    sourceType: 'module',
+  },
+  plugins: ['mocha', '@typescript-eslint'],
+  env: {
+    es6: true,
+    mocha: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  rules: {
+    'mocha/no-exclusive-tests': 'error',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        args: 'after-used',
+        argsIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+        vars: 'all',
+      },
+    ],
+    semi: 'off',
+    '@typescript-eslint/semi': 'error',
+    'no-unexpected-multiline': 'error',
+  },
+};

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Publish documentation
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    environment: docs-publish
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # tag: v4.2.2
+      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a  # tag: v4.2.0
+        with:
+          node-version: 22.12.x
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Build API documentation
+        run: yarn build:docs
+      - name: Azure login
+        uses: azure/login@a65d910e8af852a8061c627c456678983e180302 # v2.2.0
+        with:
+          client-id: ${{ secrets.AZURE_OIDC_CLIENT_ID }}
+          tenant-id: ${{ secrets.AZURE_OIDC_TENANT_ID }}
+          subscription-id: ${{ secrets.AZURE_OIDC_SUBSCRIPTION_ID }}
+      - name: Upload to Azure Blob Storage
+        uses: azure/cli@089eac9d8cc39f5d003e94f8b65efc51076c9cbd  # tag: v2.1.0
+        with:
+          inlineScript: |
+            az storage blob upload-batch --account-name ${{ secrets.AZURE_ECOSYSTEM_PACKAGES_STORAGE_ACCOUNT_NAME }} -d '$web/rebuild/${{ github.ref_name }}' -s ./docs --overwrite --auth-mode login

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
         with:
-          node-version: 20.x
+          node-version: 22.12.x
           cache: 'yarn'
       - name: Install
         run: yarn install --frozen-lockfile

.github/workflows/test.yml

@@ -17,10 +17,7 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - '20.9'
-          - '18.17'
-          - '16.20'
-          - '14.16'
+          - '22.12.x'
         os:
           - macos-latest
           - ubuntu-latest
@@ -33,9 +30,6 @@ jobs:
       GYP_MSVS_VERSION: '2022'
     steps:
       - run: git config --global core.autocrlf input
-      - name: Install Rosetta
-        if: ${{ matrix.os == 'macos-latest' && (matrix.node-version == '14.16' || matrix.node-version == '12.22') }}
-        run: /usr/sbin/softwareupdate --install-rosetta --agree-to-license
       - name: Enable Long Paths (Windows)
         if : ${{ matrix.os == 'windows-latest' }}
         run: |
@@ -53,11 +47,7 @@ jobs:
         with:
           node-version: "${{ matrix.node-version }}"
           cache: 'yarn'
-          architecture: ${{ matrix.os == 'macos-latest' && (matrix.node-version == '14.16' || matrix.node-version == '12.22') && 'x64' || env.RUNNER_ARCH }}
-      - name: Update npm
-        if: ${{ matrix.node-version == '14.16' || matrix.node-version == '12.22' }}
-        run: npm install -g npm@8 # Update npm so it works with latest Python 3
-      - name: Install
+      - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Lint
         run: yarn run lint

.gitignore

@@ -30,3 +30,5 @@ node_modules
 
 lib
 test-dist
+
+docs

.mocharc.jsonc

@@ -0,0 +1,10 @@
+// See also: https://github.com/mochajs/mocha/blob/b720ec1b3ca630a90f80311da391b2a0cdfead4e/example/config/.mocharc.js
+{
+  "$schema": "https://json.schemastore.org/mocharc",
+  "color": false,
+  "extensions": [
+    "ts"
+  ],
+  "import": "tsx",
+  "spec": ["test/*.ts"]
+}

.nvmrc

@@ -0,0 +1 @@
+22.12

README.md

@@ -44,7 +44,7 @@ npm run rebuild
 
 ### What are the requirements?
 
-Node v12.13.0 or higher is required. Building native modules from source uses
+Node v22.12.0 or higher is required. Building native modules from source uses
 [`node-gyp`](https://github.com/nodejs/node-gyp#installation), refer to the link for its
 installation/runtime requirements.
 
@@ -102,7 +102,7 @@ for Electron Packager. For example:
 
 ```javascript
 import packager from '@electron/packager';
-import rebuild from '@electron/rebuild';
+import { rebuild } from '@electron/rebuild';
 
 packager({
   // … other options
@@ -128,7 +128,7 @@ electron-rebuild is also a library that you can require into your app or
 build process. It has a very simple API:
 
 ```javascript
-import rebuild from '@electron/rebuild';
+import { rebuild } from '@electron/rebuild';
 
 // Public: Rebuilds a node_modules directory with the given Electron version.
 //
@@ -151,16 +151,29 @@ import rebuild from '@electron/rebuild';
 A full build process might look something like:
 
 ```javascript
-const childProcess = require('child_process');
-const pathToElectron = require('electron');
-
-  rebuild({
-    buildPath: __dirname,
-    electronVersion: '1.4.12'
-  })
-    .then(() => console.info('Rebuild Successful'))
-    .catch((e) => {
-      console.error("Building modules didn't work!");
-      console.error(e);
-    });
+// ESM
+import { rebuild } from '@electron/rebuild'
+
+rebuild({
+  buildPath: import.meta.dirname,
+  electronVersion: '35.1.5'
+})
+.then(() => console.info('Rebuild Successful'))
+.catch((e) => {
+  console.error('Building modules didn\'t work!')
+  console.error(e)
+})
+
+// CommonJS
+const { rebuild } = require('@electron/rebuild')
+
+rebuild({
+  buildPath: __dirname,
+  electronVersion: '35.1.5'
+})
+.then(() => console.info('Rebuild Successful'))
+.catch((e) => {
+  console.error('Building modules didn\'t work!')
+  console.error(e)
+})
 ```

package.json

@@ -2,17 +2,18 @@
   "name": "@electron/rebuild",
   "version": "0.0.0-development",
   "description": "Electron supporting package to rebuild native node modules against the currently installed electron",
-  "main": "lib/main.js",
+  "type": "module",
+  "exports": "./lib/main.js",
   "typings": "lib/main.d.ts",
   "scripts": {
-    "compile": "tsc",
+    "build": "tsc",
+    "build:docs": "typedoc src/main.ts",
     "coverage": "npm run prewarm-headers && nyc npm run spec",
     "coverage:report": "nyc report --reporter=text-lcov > coverage.lcov",
     "watch": "tsc -w",
-    "prepare": "npm run compile",
-    "mocha": "cross-env TS_NODE_FILES=true mocha",
+    "prepare": "npm run build",
     "lint": "eslint --ext .ts .",
-    "spec": "tsc && npm run mocha -- test/*.ts",
+    "spec": "tsc && mocha",
     "test": "npm run prewarm-headers && npm run lint && npm run spec",
     "prewarm-headers": "node-gyp install --ensure"
   },
@@ -39,7 +40,7 @@
   },
   "homepage": "https://github.com/electron/rebuild",
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=22.12.0"
   },
   "publishConfig": {
     "provenance": true
@@ -50,10 +51,10 @@
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "detect-libc": "^2.0.1",
-    "fs-extra": "^10.0.0",
     "got": "^11.7.0",
-    "node-abi": "^3.45.0",
-    "node-api-version": "^0.2.0",
+    "graceful-fs": "^4.2.11",
+    "node-abi": "^4.2.0",
+    "node-api-version": "^0.2.1",
     "ora": "^5.1.0",
     "read-binary-file-arch": "^1.0.6",
     "semver": "^7.3.5",
@@ -62,74 +63,29 @@
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@tsconfig/node22": "^22.0.0",
     "@types/chai": "^4.2.12",
     "@types/chai-as-promised": "^7.1.3",
     "@types/debug": "^4.1.5",
-    "@types/fs-extra": "^9.0.1",
+    "@types/graceful-fs": "^4.1.9",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^17.0.8",
+    "@types/node": "~22.10.7",
     "@types/node-abi": "^3.0.0",
     "@types/semver": "^7.3.9",
     "@types/tar": "^6.1.0",
     "@types/yargs": "^17.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.0.1",
-    "@typescript-eslint/parser": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
-    "cross-env": "^7.0.2",
     "electron": "^22.0.0",
     "eslint": "^7.7.0",
     "eslint-plugin-mocha": "^9.0.0",
-    "mocha": "^10.8.2",
+    "mocha": "^11.1.0",
     "nyc": "^15.1.0",
-    "ts-node": "^10.0.0",
-    "typescript": "^4.0.2"
-  },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "ecmaVersion": 2019,
-      "sourceType": "module"
-    },
-    "plugins": [
-      "mocha",
-      "@typescript-eslint"
-    ],
-    "env": {
-      "es6": true,
-      "mocha": true,
-      "node": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended"
-    ],
-    "rules": {
-      "mocha/no-exclusive-tests": "error",
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          "args": "after-used",
-          "argsIgnorePattern": "^_",
-          "ignoreRestSiblings": true,
-          "vars": "all"
-        }
-      ],
-      "semi": "off",
-      "@typescript-eslint/semi": "error",
-      "no-unexpected-multiline": "error"
-    }
-  },
-  "eslintIgnore": [
-    "*.d.ts",
-    "node_modules"
-  ],
-  "mocha": {
-    "extensions": [
-      "ts"
-    ],
-    "require": "ts-node/register"
+    "tsx": "^4.19.3",
+    "typedoc": "~0.25.13",
+    "typescript": "~5.4.5"
   },
   "nyc": {
     "extends": "@istanbuljs/nyc-config-typescript"

src/arch.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process';
+import { execSync } from 'node:child_process';
 
 /**
  * Runs the `uname` command and returns the trimmed output.