wip: updating build files

[ci skip]

Author: tegefaulkes

.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,
@@ -39,6 +38,7 @@
         "message": "Use `globalThis` instead"
       }
     ],
+    "prefer-rest-params": 0,
     "require-yield": 0,
     "eqeqeq": ["error", "smart"],
     "spaced-comment": [

README.md

@@ -106,7 +106,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

jest.config.js

@@ -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;

package.json

@@ -8,16 +8,30 @@
     "type": "git",
     "url": "https://github.com/MatrixAI/js-id.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"
   },
@@ -27,24 +41,22 @@
   },
   "devDependencies": {
     "@swc/core": "^1.3.62",
-    "@swc/jest": "^0.2.26",
-    "@types/jest": "^28.1.3",
-    "@types/node": "^18.15.0",
-    "@typescript-eslint/eslint-plugin": "^5.45.1",
-    "@typescript-eslint/parser": "^5.45.1",
-    "eslint": "^8.15.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^28.1.1",
-    "jest-extended": "^3.0.1",
-    "jest-junit": "^14.0.0",
-    "prettier": "^2.6.2",
+    "@swc/jest": "^0.2.29",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.5.7",
+    "@typescript-eslint/eslint-plugin": "^5.61.0",
+    "@typescript-eslint/parser": "^5.61.0",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^5.0.0-alpha.2",
+    "jest": "^29.6.2",
+    "jest-extended": "^4.0.0",
+    "jest-junit": "^16.0.0",
+    "prettier": "^3.0.0",
     "shx": "^0.3.4",
-    "ts-jest": "^28.0.5",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^3.9.0",
-    "typedoc": "^0.23.21",
-    "typescript": "^4.9.3"
+    "tsx": "^3.12.7",
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
   }
 }

tsconfig.json

@@ -8,27 +8,29 @@
     "allowJs": true,
     "strictNullChecks": true,
     "noImplicitAny": false,
+    "experimentalDecorators": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
-    "moduleResolution": "node",
-    "module": "CommonJS",
+    "isolatedModules": true,
+    "moduleResolution": "NodeNext",
+    "module": "ESNext",
     "target": "ES2022",
     "baseUrl": "./src",
     "paths": {
-      "@": ["index"],
-      "@/*": ["*"]
+      "#*": ["*"]
     },
+    "skipLibCheck": true,
     "noEmit": true
   },
   "include": [
     "./src/**/*",
     "./src/**/*.json",
     "./tests/**/*",
-    "./scripts/**/*"
+    "./scripts/**/*",
   ],
   "ts-node": {
-    "require": ["tsconfig-paths/register"],
+    "esm": true,
     "transpileOnly": true,
     "swc": true
   }