feat!: bump engines requirement to Node 22 (#347)

BREAKING CHANGE: bumps required Node.js version to >=22.12.0. ESM-only.

* use `node:` imports

* use `"@tsconfig/node22`

* remove `rimraf`

* update `glob` and remove inlined types

* esm: add `"type": "module"` and update imports

* esm: update test imports and dependencies

* remove `default` exports

* remove unused `import`s

* fix Windows tests

* update `import`s / `export`s in `src/asar.ts`

* remove `promisify(stream.pipeline)`

* remove `lodash`

* remove `enginesStrict`

* rename `bin/asar.js` to `bin/asar.mjs`

* bump `minimatch` to `10.0.1`

* `var` -> `const`

* add `noUnusedLocals: true` to `tsconfig.json`

* update `wrappedFs`

* update `commander`

* update `chai`

* add docs publishing flow

* docs: update README imports

---------

Co-authored-by: Erick Zhao <[email protected]>

Author: erikian

.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@49933ea5288caeca8642d1e84afbd3f7d6820020  # tag: v4.4.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@a457da9ea143d694b1b9c7c869ebb04ebe844ef5 # v2.3.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/asar/${{ 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@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
-          node-version: 20.x
+          node-version: '22.12.x'
           cache: 'yarn'
       - name: Install
         run: yarn install --frozen-lockfile

.github/workflows/test.yml

@@ -18,9 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - '20.19'
-          - '18.18'
-          - '16.20'
+          - '22.12.x'
         os:
           - macos-latest
           - ubuntu-22.04

.gitignore

@@ -9,3 +9,4 @@
 npm-debug.log
 .idea
 lib
+docs

.mocharc.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   'watch-files': ['test/**/*.js', 'lib/**/*.js'],
   recursive: true,
   file: './test/mocha.setup.js', // setup file before everything else loads

.nvmrc

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

README.md

@@ -16,7 +16,7 @@ all files together without compression, while having random access support.
 
 ### Install
 
-This module requires Node 10 or later.
+This module requires Node 22.12.0 or later.
 
 ```bash
 $ npm install --engine-strict @electron/asar
@@ -86,12 +86,12 @@ $ asar pack app app.asar --unpack-dir "{**/x1,**/x2,z4/w1}"
 ### Example
 
 ```javascript
-const asar = require('@electron/asar');
+import { createPackage } from '@electron/asar';
 
 const src = 'some/path/';
 const dest = 'name.asar';
 
-await asar.createPackage(src, dest);
+await createPackage(src, dest);
 console.log('done.');
 ```
 
@@ -103,7 +103,7 @@ nothing, or a `stream.Transform`. The latter will be used on files that will be
 in the `.asar` file to transform them (e.g. compress).
 
 ```javascript
-const asar = require('@electron/asar');
+import { createPackageWithOptions } from '@electron/asar';
 
 const src = 'some/path/';
 const dest = 'name.asar';
@@ -112,7 +112,7 @@ function transform (filename) {
   return new CustomTransformStream()
 }
 
-await asar.createPackageWithOptions(src, dest, { transform: transform });
+await createPackageWithOptions(src, dest, { transform: transform });
 console.log('done.');
 ```
 

bin/asar.js renamed to bin/asar.mjs

@@ -1,20 +1,21 @@
 #!/usr/bin/env node
 
-var packageJSON = require('../package.json')
-var splitVersion = function (version) { return version.split('.').map(function (part) { return Number(part) }) }
-var requiredNodeVersion = splitVersion(packageJSON.engines.node.slice(2))
-var actualNodeVersion = splitVersion(process.versions.node)
+import packageJSON from '../package.json' with { type: 'json' };
+import { createPackageWithOptions, listPackage, extractFile, extractAll } from '../lib/asar.js';
+import { program } from 'commander';
+import fs from 'node:fs';
+import path from 'node:path';
+
+const splitVersion = function (version) { return version.split('.').map(function (part) { return Number(part) }) }
+const requiredNodeVersion = splitVersion(packageJSON.engines.node.slice(2))
+const actualNodeVersion = splitVersion(process.versions.node)
 
 if (actualNodeVersion[0] < requiredNodeVersion[0] || (actualNodeVersion[0] === requiredNodeVersion[0] && actualNodeVersion[1] < requiredNodeVersion[1])) {
   console.error('CANNOT RUN WITH NODE ' + process.versions.node)
   console.error('asar requires Node ' + packageJSON.engines.node + '.')
   process.exit(1)
 }
 
-// Not consts so that this file can load in Node < 4.0
-var asar = require('../lib/asar')
-var program = require('commander')
-
 program.version('v' + packageJSON.version)
   .description('Manipulate asar archive files')
 
@@ -35,7 +36,7 @@ program.command('pack <dir> <output>')
       builddir: options.sb,
       dot: !options.excludeHidden
     }
-    asar.createPackageWithOptions(dir, output, options).catch(error => {
+    createPackageWithOptions(dir, output, options).catch(error => {
       console.error(error)
       process.exit(1)
     })
@@ -49,8 +50,8 @@ program.command('list <archive>')
     options = {
       isPack: options.isPack
     }
-    var files = asar.listPackage(archive, options)
-    for (var i in files) {
+    const files = listPackage(archive, options)
+    for (const i in files) {
       console.log(files[i])
     }
   })
@@ -59,15 +60,15 @@ program.command('extract-file <archive> <filename>')
   .alias('ef')
   .description('extract one file from archive')
   .action(function (archive, filename) {
-    require('fs').writeFileSync(require('path').basename(filename),
-      asar.extractFile(archive, filename))
+    fs.writeFileSync(path.basename(filename),
+      extractFile(archive, filename))
   })
 
 program.command('extract <archive> <dest>')
   .alias('e')
   .description('extract archive')
   .action(function (archive, dest) {
-    asar.extractAll(archive, dest)
+    extractAll(archive, dest)
   })
 
 program.command('*', { hidden: true})

package.json

@@ -2,17 +2,18 @@
   "name": "@electron/asar",
   "description": "Creating Electron app packages",
   "version": "0.0.0-development",
-  "main": "./lib/asar.js",
+  "type": "module",
+  "exports": "./lib/asar.js",
   "types": "./lib/asar.d.ts",
   "bin": {
-    "asar": "./bin/asar.js"
+    "asar": "./bin/asar.mjs"
   },
   "files": [
     "bin",
     "lib"
   ],
   "engines": {
-    "node": ">=10.12.0"
+    "node": ">=22.12.0"
   },
   "license": "MIT",
   "homepage": "https://github.com/electron/asar",
@@ -28,6 +29,7 @@
   },
   "scripts": {
     "build": "tsc",
+    "build:docs": "typedoc src/asar.ts",
     "mocha": "xvfb-maybe electron-mocha && mocha",
     "mocha:update": "mocha --update",
     "mocha:watch": "mocha --watch",
@@ -39,21 +41,21 @@
     "prepare": "tsc"
   },
   "dependencies": {
-    "commander": "^5.0.0",
-    "glob": "^7.1.6",
-    "minimatch": "^3.0.4"
+    "commander": "^13.1.0",
+    "glob": "^11.0.1",
+    "minimatch": "^10.0.1"
   },
   "devDependencies": {
-    "@types/minimatch": "^3.0.5",
-    "@types/node": "^12.0.0",
-    "chai": "^4.5.0",
-    "electron": "^22.0.0",
-    "electron-mocha": "^13.0.1",
-    "lodash": "^4.17.15",
-    "mocha": "^10.1.0",
+    "@tsconfig/node22": "^22.0.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "~22.10.7",
+    "chai": "^5.2.0",
+    "electron": "^34.5.0",
+    "electron-mocha": "^13.1.0",
+    "mocha": "~11.0.2",
     "mocha-chai-jest-snapshot": "^1.1.6",
     "prettier": "^3.3.3",
-    "rimraf": "^3.0.2",
+    "typedoc": "~0.25.13",
     "typescript": "^5.5.4",
     "xvfb-maybe": "^0.2.1"
   }