feat!: bump engines to Node.js >=22.12.0 (#199)

BREAKING CHANGE: bumps minimum Node.js version to 22

* refactor: move private getNextTarget function to separate file

* fix: ESM equivalent of __dirname

* ci: use dynamic import

Author: dsanders11

.github/workflows/check-electron-abi.yml

@@ -30,9 +30,9 @@ jobs:
       uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
       with:
         script: |
-          const nodeAbi = require('node-abi');
+          const { getAbi } = await import('${{ github.workspace }}/node_modules/node-abi/index.js');
 
-          const abi = nodeAbi.getAbi('${{ github.event.inputs.electron-version }}', 'electron');
+          const abi = getAbi('${{ github.event.inputs.electron-version }}', 'electron');
 
           if (abi !== '${{ github.event.inputs.expected-abi }}') {
             core.error(`Got ABI ${abi}, expected ${{ github.event.inputs.expected-abi }}`);

.github/workflows/release.yml

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

.github/workflows/test.yml

@@ -17,17 +17,11 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - '20.10'
-          - '18.18'
-          - '16.20'
-          - '14.21'
+          - 22.12.x
         os:
           - macos-latest
           - ubuntu-latest
           - windows-latest
-        exclude:
-          - os: macos-latest
-            node-version: '14.21'
     runs-on: "${{ matrix.os }}"
     steps:
       - name: Checkout

.github/workflows/update-abi.yml

@@ -19,7 +19,7 @@ jobs:
         token: ${{ steps.generate-token.outputs.token }}
     - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
       with:
-        node-version: '20.x'
+        node-version-file: '.nvmrc'
     - name: Get npm cache directory
       id: npm-cache
       run: |

.nvmrc

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

getNextTarget.js

@@ -0,0 +1,13 @@
+import semver from 'semver';
+
+export function getNextTarget (runtime, targets) {
+  const latest = targets.filter((t) => { return t.runtime === runtime }).slice(-1)[0]
+  const increment = runtime === 'electron' ? 'minor' : 'major'
+  let next = semver.inc(latest.target, increment)
+  // Electron releases appear in the registry in their beta form, sometimes there is
+  // no active beta line.  During this time we need to double bump
+  if (runtime === 'electron' && semver.parse(latest.target).prerelease.length) {
+    next = semver.inc(next, 'major')
+  }
+  return next
+}

index.js

@@ -1,19 +1,12 @@
-var semver = require('semver')
-
-function getNextTarget (runtime, targets) {
-  if (targets == null) targets = allTargets
-  var latest = targets.filter(function (t) { return t.runtime === runtime }).slice(-1)[0]
-  var increment = runtime === 'electron' ? 'minor' : 'major'
-  var next = semver.inc(latest.target, increment)
-  // Electron releases appear in the registry in their beta form, sometimes there is
-  // no active beta line.  During this time we need to double bump
-  if (runtime === 'electron' && semver.parse(latest.target).prerelease.length) {
-    next = semver.inc(next, 'major')
-  }
-  return next
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import semver from 'semver';
+
+import { getNextTarget } from './getNextTarget.js';
 
-function getAbi (target, runtime) {
+export function getAbi (target, runtime) {
   if (target === String(Number(target))) return target
   if (target) target = target.replace(/^v/, '')
   if (!runtime) runtime = 'node'
@@ -23,37 +16,37 @@ function getAbi (target, runtime) {
     if (target === process.versions.node) return process.versions.modules
   }
 
-  var abi
-  var lastTarget
+  let abi
+  let lastTarget
 
-  for (var i = 0; i < allTargets.length; i++) {
-    var t = allTargets[i]
+  for (let i = 0; i < allTargets.length; i++) {
+    const t = allTargets[i]
     if (t.runtime !== runtime) continue
     if (semver.lte(t.target, target) && (!lastTarget || semver.gte(t.target, lastTarget))) {
       abi = t.abi
       lastTarget = t.target
     }
   }
 
-  if (abi && semver.lt(target, getNextTarget(runtime))) return abi
+  if (abi && semver.lt(target, getNextTarget(runtime, allTargets))) return abi
   throw new Error('Could not detect abi for version ' + target + ' and runtime ' + runtime + '.  Updating "node-abi" might help solve this issue if it is a new release of ' + runtime)
 }
 
-function getTarget (abi, runtime) {
+export function getTarget (abi, runtime) {
   if (abi && abi !== String(Number(abi))) return abi
   if (!runtime) runtime = 'node'
 
   if (runtime === 'node' && !abi) return process.versions.node
 
-  var match = allTargets
+  const match = allTargets
     .filter(function (t) {
       return t.abi === abi && t.runtime === runtime
     })
     .map(function (t) {
       return t.target
     })
   if (match.length) {
-    var betaSeparatorIndex = match[0].indexOf("-")
+    const betaSeparatorIndex = match[0].indexOf("-")
     return betaSeparatorIndex > -1
       ? match[0].substring(0, betaSeparatorIndex)
       : match[0]
@@ -63,31 +56,31 @@ function getTarget (abi, runtime) {
 }
 
 function sortByTargetFn (a, b) {
-  var abiComp = Number(a.abi) - Number(b.abi)
+  const abiComp = Number(a.abi) - Number(b.abi)
   if (abiComp !== 0) return abiComp
   if (a.target < b.target) return -1
   if (a.target > b.target) return 1
   return 0
 }
 
 function loadGeneratedTargets () {
-  var registry = require('./abi_registry.json')
-  var targets = {
+  const registry = JSON.parse(fs.readFileSync(path.join(path.dirname(fileURLToPath(import.meta.url)), 'abi_registry.json'), 'utf8'))
+  const targets = {
     supported: [],
     additional: [],
     future: []
   }
 
   registry.forEach(function (item) {
-    var target = {
+    const target = {
       runtime: item.runtime,
       target: item.target,
       abi: item.abi
     }
     if (item.lts) {
-      var startDate = new Date(Date.parse(item.lts[0]))
-      var endDate = new Date(Date.parse(item.lts[1]))
-      var currentDate = new Date()
+      const startDate = new Date(Date.parse(item.lts[0]))
+      const endDate = new Date(Date.parse(item.lts[1]))
+      const currentDate = new Date()
       target.lts = startDate < currentDate && currentDate < endDate
     } else {
       target.lts = false
@@ -109,9 +102,9 @@ function loadGeneratedTargets () {
   return targets
 }
 
-var generatedTargets = loadGeneratedTargets()
+const generatedTargets = loadGeneratedTargets()
 
-var supportedTargets = [
+export const supportedTargets = [
   {runtime: 'node', target: '5.0.0', abi: '47', lts: false},
   {runtime: 'node', target: '6.0.0', abi: '48', lts: false},
   {runtime: 'node', target: '7.0.0', abi: '51', lts: false},
@@ -129,22 +122,20 @@ var supportedTargets = [
   {runtime: 'electron', target: '2.0.0', abi: '57', lts: false},
   {runtime: 'electron', target: '3.0.0', abi: '64', lts: false},
   {runtime: 'electron', target: '4.0.0', abi: '64', lts: false},
-  {runtime: 'electron', target: '4.0.4', abi: '69', lts: false}
+  {runtime: 'electron', target: '4.0.4', abi: '69', lts: false},
+  ...generatedTargets.supported
 ]
 
-supportedTargets.push.apply(supportedTargets, generatedTargets.supported)
-
-var additionalTargets = [
+export const additionalTargets = [
   {runtime: 'node-webkit', target: '0.13.0', abi: '47', lts: false},
   {runtime: 'node-webkit', target: '0.15.0', abi: '48', lts: false},
   {runtime: 'node-webkit', target: '0.18.3', abi: '51', lts: false},
   {runtime: 'node-webkit', target: '0.23.0', abi: '57', lts: false},
-  {runtime: 'node-webkit', target: '0.26.5', abi: '59', lts: false}
+  {runtime: 'node-webkit', target: '0.26.5', abi: '59', lts: false},
+  ...generatedTargets.additional
 ]
 
-additionalTargets.push.apply(additionalTargets, generatedTargets.additional)
-
-var deprecatedTargets = [
+export const deprecatedTargets = [
   {runtime: 'node', target: '0.2.0', abi: '1', lts: false},
   {runtime: 'node', target: '0.9.1', abi: '0x000A', lts: false},
   {runtime: 'node', target: '0.9.9', abi: '0x000B', lts: false},
@@ -162,18 +153,9 @@ var deprecatedTargets = [
   {runtime: 'electron', target: '0.33.0', abi: '46', lts: false}
 ]
 
-var futureTargets = generatedTargets.future
+export const futureTargets = generatedTargets.future
 
-var allTargets = deprecatedTargets
+export const allTargets = deprecatedTargets
   .concat(supportedTargets)
   .concat(additionalTargets)
   .concat(futureTargets)
-
-exports.getAbi = getAbi
-exports.getTarget = getTarget
-exports.deprecatedTargets = deprecatedTargets
-exports.supportedTargets = supportedTargets
-exports.additionalTargets = additionalTargets
-exports.futureTargets = futureTargets
-exports.allTargets = allTargets
-exports._getNextTarget = getNextTarget

package.json

@@ -2,13 +2,16 @@
   "name": "node-abi",
   "version": "0.0.0-development",
   "description": "Get the Node ABI for a given target and runtime, and vice versa.",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
   "scripts": {
-    "test": "tape test/index.js",
+    "test": "node --test test/index.js",
     "update-abi-registry": "node --unhandled-rejections=strict scripts/update-abi-registry.js"
   },
   "files": [
-    "abi_registry.json"
+    "abi_registry.json",
+    "index.js",
+    "getNextTarget.js"
   ],
   "repository": {
     "type": "git",
@@ -27,14 +30,12 @@
     "url": "https://github.com/electron/node-abi/issues"
   },
   "homepage": "https://github.com/electron/node-abi#readme",
-  "devDependencies": {
-    "tape": "^5.3.1"
-  },
+  "devDependencies": {},
   "dependencies": {
-    "semver": "^7.3.5"
+    "semver": "^7.6.3"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=22.12.0"
   },
   "publishConfig": {
     "provenance": true

scripts/update-abi-registry.js

@@ -1,7 +1,8 @@
-const { writeFile } = require('node:fs/promises')
-const path = require('node:path')
+import { writeFile } from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url';
 
-const semver = require('semver')
+import semver from 'semver'
 
 function sortByElectronVersionFn (a, b) {
   const modulesComp = Number(a.modules) - Number(b.modules)
@@ -127,7 +128,7 @@ async function main () {
     ...electronTargets,
   ]
 
-  await writeFile(path.resolve(__dirname, '..', 'abi_registry.json'), JSON.stringify(supportedTargets, null, 2))
+  await writeFile(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'abi_registry.json'), JSON.stringify(supportedTargets, null, 2))
 }
 
 main()