feat: migrate to ESM

Author: CMCDragonkai

Diff for: .eslintrc

@@ -7,19 +7,18 @@
     "jest": true
   },
   "parser": "@typescript-eslint/parser",
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "prettier"
-  ],
-  "plugins": [
-    "import"
-  ],
   "parserOptions": {
     "project": "tsconfig.json",
     "sourceType": "module"
   },
+  "plugins": [
+    "import"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
   "rules": {
     "linebreak-style": ["error", "unix"],
     "no-empty": 1,

Diff for: README.md

@@ -55,7 +55,7 @@ npm install
 # build the dist
 npm run build
 # run the repl (this allows you to import from ./src)
-npm run ts-node
+npm run tsx
 # run the tests
 npm run test
 # lint the source code

Diff for: benches/index.ts

@@ -1,25 +1,29 @@
 #!/usr/bin/env ts-node
 
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
 import si from 'systeminformation';
-import workerManager from './worker_manager';
+import { benchesPath } from './utils/utils.js';
+import workerManager from './worker_manager.js';
 
 async function main(): Promise<void> {
-  await fs.promises.mkdir(path.join(__dirname, 'results'), { recursive: true });
+  await fs.promises.mkdir(path.join(benchesPath, 'results'), {
+    recursive: true,
+  });
   await workerManager();
   const resultFilenames = await fs.promises.readdir(
-    path.join(__dirname, 'results'),
+    path.join(benchesPath, 'results'),
   );
   const metricsFile = await fs.promises.open(
-    path.join(__dirname, 'results', 'metrics.txt'),
+    path.join(benchesPath, 'results', 'metrics.txt'),
     'w',
   );
   let concatenating = false;
   for (const resultFilename of resultFilenames) {
     if (/.+_metrics\.txt$/.test(resultFilename)) {
       const metricsData = await fs.promises.readFile(
-        path.join(__dirname, 'results', resultFilename),
+        path.join(benchesPath, 'results', resultFilename),
       );
       if (concatenating) {
         await metricsFile.write('\n');
@@ -35,9 +39,16 @@ async function main(): Promise<void> {
     system: 'model, manufacturer',
   });
   await fs.promises.writeFile(
-    path.join(__dirname, 'results', 'system.json'),
+    path.join(benchesPath, 'results', 'system.json'),
     JSON.stringify(systemData, null, 2),
   );
 }
 
-void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
+}
+
+export default main;

Diff for: benches/utils/index.ts

@@ -1 +1 @@
-export * from './utils';
+export * from './utils.js';

Diff for: benches/utils/utils.ts

@@ -1,28 +1,33 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
 import b from 'benny';
 import { codeBlock } from 'common-tags';
-import packageJson from '../../package.json';
+import packageJson from '../../package.json' assert { type: 'json' };
+
+const benchesPath = path.dirname(
+  path.dirname(url.fileURLToPath(import.meta.url)),
+);
 
 const suiteCommon = [
   b.cycle(),
   b.complete(),
   b.save({
     file: (summary) => summary.name,
-    folder: path.join(__dirname, '../results'),
+    folder: path.join(benchesPath, 'results'),
     version: packageJson.version,
     details: true,
   }),
   b.save({
     file: (summary) => summary.name,
-    folder: path.join(__dirname, '../results'),
+    folder: path.join(benchesPath, 'results'),
     version: packageJson.version,
     format: 'chart.html',
   }),
   b.complete((summary) => {
     const filePath = path.join(
-      __dirname,
-      '../results',
+      benchesPath,
+      'results',
       summary.name + '_metrics.txt',
     );
     fs.writeFileSync(
@@ -58,4 +63,4 @@ const suiteCommon = [
   }),
 ];
 
-export { suiteCommon };
+export { benchesPath, suiteCommon };

Diff for: benches/worker_manager.ts

@@ -1,11 +1,14 @@
-import type { WorkerModule } from '@/worker';
-import path from 'path';
-import crypto from 'crypto';
+import type { WorkerModule } from '#worker.js';
+import path from 'node:path';
+import url from 'node:url';
+import crypto from 'node:crypto';
 import b from 'benny';
 import { spawn, Worker, Transfer } from 'threads';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
-import WorkerManager from '@/WorkerManager';
-import { suiteCommon } from './utils';
+import { suiteCommon } from './utils/index.js';
+import WorkerManager from '#WorkerManager.js';
+
+const filePath = url.fileURLToPath(import.meta.url);
 
 const logger = new Logger('WorkerManager Bench', LogLevel.WARN, [
   new StreamHandler(),
@@ -22,7 +25,7 @@ async function main() {
   // 1 KiB of data is still too small
   const bytes = crypto.randomBytes(1024 * 1024);
   const summary = await b.suite(
-    path.basename(__filename, path.extname(__filename)),
+    path.basename(filePath, path.extname(filePath)),
     b.add('call overhead', async () => {
       // This calls a noop, this will show the overhead costs
       // All parallelised operation can never be faster than this
@@ -104,8 +107,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

Diff for: jest.config.js renamed to jest.config.mjs

@@ -1,18 +1,16 @@
-const path = require('path');
-const { pathsToModuleNameMapper } = require('ts-jest');
-const { compilerOptions } = require('./tsconfig');
+import path from 'node:path';
+import url from 'node:url';
+import tsconfigJSON from './tsconfig.json' assert { type: "json" };
 
-const moduleNameMapper = pathsToModuleNameMapper(compilerOptions.paths, {
-  prefix: '<rootDir>/src/',
-});
+const projectPath = path.dirname(url.fileURLToPath(import.meta.url));
 
 // Global variables that are shared across the jest worker pool
 // These variables must be static and serializable
 const globals = {
   // Absolute directory to the project root
-  projectDir: __dirname,
+  projectDir: projectPath,
   // Absolute directory to the test root
-  testDir: path.join(__dirname, 'tests'),
+  testDir: path.join(projectPath, 'tests'),
   // Default asynchronous test timeout
   defaultTimeout: 20000,
   // Timeouts rely on setTimeout which takes 32 bit numbers
@@ -24,7 +22,7 @@ const globals = {
 // They can however receive the process environment
 // Use `process.env` to set variables
 
-module.exports = {
+const config = {
   testEnvironment: 'node',
   verbose: true,
   collectCoverage: false,
@@ -40,10 +38,10 @@ module.exports = {
           parser: {
             syntax: "typescript",
             tsx: true,
-            decorators: compilerOptions.experimentalDecorators,
+            decorators: tsconfigJSON.compilerOptions.experimentalDecorators,
             dynamicImport: true,
           },
-          target: compilerOptions.target.toLowerCase(),
+          target: tsconfigJSON.compilerOptions.target.toLowerCase(),
           keepClassNames: true,
         },
       }
@@ -77,5 +75,10 @@ module.exports = {
     'jest-extended/all',
     '<rootDir>/tests/setupAfterEnv.ts'
   ],
-  moduleNameMapper: moduleNameMapper,
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+  },
+  extensionsToTreatAsEsm: ['.ts', '.tsx', '.mts'],
 };
+
+export default config;

Diff for: package.json

@@ -8,31 +8,45 @@
     "type": "git",
     "url": "https://github.com/MatrixAI/js-workers.git"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./*.js": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js"
+    },
+    "./*": "./dist/*"
+  },
+  "imports": {
+    "#*": "./dist/*"
+  },
   "scripts": {
     "prepare": "tsc -p ./tsconfig.build.json",
     "build": "shx rm -rf ./dist && tsc -p ./tsconfig.build.json",
     "postversion": "npm install --package-lock-only --ignore-scripts --silent",
-    "ts-node": "ts-node",
-    "test": "jest",
-    "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,ts}'",
-    "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,ts}' --fix",
+    "tsx": "tsx",
+    "test": "node ./scripts/test.mjs",
+    "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}'",
+    "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}' --fix",
     "lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
     "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
-    "bench": "shx rm -rf ./benches/results && ts-node ./benches"
+    "bench": "tsc -p ./tsconfig.build.json && shx rm -rf ./benches/results && tsx ./benches/index.ts"
   },
   "dependencies": {
-    "@matrixai/async-init": "^1.9.1",
-    "@matrixai/errors": "^1.2.0",
-    "@matrixai/logger": "^3.1.0",
-    "threads": "^1.6.5"
+    "@matrixai/async-init": "^2.0.0",
+    "@matrixai/errors": "^2.0.1",
+    "@matrixai/logger": "^4.0.1",
+    "threads": "^1.7.0"
   },
   "devDependencies": {
-    "@swc/core": "1.3.82",
+    "@swc/core": "^1.3.76",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.5.2",
-    "@types/node": "^20.5.7",
+    "@types/node": "^18.15.0",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.61.0",
     "benny": "^3.7.1",
@@ -47,9 +61,7 @@
     "prettier": "^3.0.0",
     "shx": "^0.3.4",
     "systeminformation": "^5.18.5",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^3.9.0",
+    "tsx": "^3.12.7",
     "typedoc": "^0.24.8",
     "typescript": "^5.1.6"
   }

Diff for: scripts/test.mjs

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+import os from 'node:os';
+import path from 'node:path';
+import url from 'node:url';
+import process from 'node:process';
+import childProcess from 'node:child_process';
+
+const projectPath = path.dirname(
+  path.dirname(url.fileURLToPath(import.meta.url)),
+);
+
+const platform = os.platform();
+
+/* eslint-disable no-console */
+async function main() {
+  const tscArgs = [`-p`, path.join(projectPath, 'tsconfig.build.json')];
+  console.error('Running tsc:');
+  console.error(['tsc', ...tscArgs].join(' '));
+  childProcess.execFileSync('tsc', tscArgs, {
+    stdio: ['inherit', 'inherit', 'inherit'],
+    windowsHide: true,
+    encoding: 'utf-8',
+    shell: platform === 'win32' ? true : false,
+  });
+  const jestArgs = [];
+  console.error('Running jest:');
+  console.error(['jest', ...jestArgs].join(' '));
+  childProcess.execFileSync('jest', jestArgs, {
+    env: {
+      ...process.env,
+      NODE_OPTIONS: '--experimental-vm-modules',
+    },
+    stdio: ['inherit', 'inherit', 'inherit'],
+    windowsHide: true,
+    encoding: 'utf-8',
+    shell: platform === 'win32' ? true : false,
+  });
+}
+/* eslint-enable no-console */
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
+}

Diff for: src/WorkerManager.ts

@@ -1,11 +1,11 @@
 import type { ModuleThread } from 'threads';
 import type { ModuleMethods } from 'threads/dist/types/master';
+import type WorkerManagerInterface from './WorkerManagerInterface.js';
 import type { QueuedTask } from 'threads/dist/master/pool-types';
-import type WorkerManagerInterface from './WorkerManagerInterface';
 import { Pool } from 'threads';
 import Logger from '@matrixai/logger';
-import { CreateDestroy, ready } from '@matrixai/async-init/dist/CreateDestroy';
-import * as errors from './errors';
+import { CreateDestroy, ready } from '@matrixai/async-init/CreateDestroy.js';
+import * as errors from './errors.js';
 
 @CreateDestroy()
 class WorkerManager<W extends ModuleMethods>

Diff for: src/index.ts

@@ -1,6 +1,6 @@
-export { default as WorkerManager } from './WorkerManager';
-export { default as workerModule } from './workerModule';
-export * as errors from './errors';
+export { default as WorkerManager } from './WorkerManager.js';
+export { default as workerModule } from './workerModule.js';
+export * as errors from './errors.js';
 
-export type { default as WorkerManagerInterface } from './WorkerManagerInterface';
-export type { WorkerModule } from './workerModule';
+export type { default as WorkerManagerInterface } from './WorkerManagerInterface.js';
+export type { WorkerModule } from './workerModule.js';