Merge pull request #19 from alexrecuenco/enable-esm-again

Enable esm again

Author: alexrecuenco

.github/workflows/main.yml

@@ -13,8 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
+          # python-version: '3.12'
           cache: 'pip'
       - uses: pre-commit/action@v3.0.1
 
@@ -23,7 +24,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
+        node-version: [20.x, 22.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -38,3 +39,5 @@ jobs:
       - run: npm run format
       - run: npm run build:debug
       - run: npm run build:prod
+      - run: npm run check:esmloads
+      - run: npm run check:cjsloads

.gitignore

@@ -10,6 +10,7 @@
 # Created by git when using merge tools for conflicts
 *.BACKUP.*
 *.BASE.*
+!tsconfig.base*
 *.LOCAL.*
 *.REMOTE.*
 *_BACKUP_*.txt
@@ -395,3 +396,4 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.gitignore.io/api/git,node,linux,macos,python,pycharm,windows,visualstudiocode
+build*/

.npmignore

@@ -0,0 +1,7 @@
+*
+!dist/**
+!src/**
+!package*json
+!README*
+!tsconfig*
+tsconfig.eslint.json

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos: #The order matters, we want prospector to run after all the sorting was d
       - id: check-json
         # JSON that are not json
         # (?x) means verbose (we can add spaces for better readibility, but they are ignored)
-        exclude: (?x) ^(tsconfig(\.\w+)? | \.vscode/.*) \.json$
+        exclude: (?x) /?(tsconfig(\.\w+)? | \.vscode/.*) \.json$
       - id: check-merge-conflict
       - id: check-symlinks
       - id: check-toml
@@ -19,10 +19,10 @@ repos: #The order matters, we want prospector to run after all the sorting was d
       # File normalization
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v3.1.0'
-    hooks:
-      - id: prettier
-        additional_dependencies:
-          - prettier@3.2.5
-          - prettier-plugin-jsdoc@1.3.0
+  # - repo: https://github.com/pre-commit/mirrors-prettier
+  #   rev: 'v3.1.0'
+  #   hooks:
+  #     - id: prettier
+  #       additional_dependencies:
+  #         - prettier@3.2.5
+  #         - prettier-plugin-jsdoc@1.3.0

.vscode/settings.json

@@ -7,10 +7,12 @@
     },
     "editor.formatOnSaveMode": "modificationsIfAvailable",
     "[javascript,typescript,jsonc,json]": {
+        "editor.indentSize": "tabSize",
+        "editor.tabSize": 2,
         "editor.defaultFormatter": "esbenp.prettier-vscode",
         "editor.formatOnSaveMode": "modificationsIfAvailable",
     },
-    "eslint.experimental.useFlatConfig": true,
+    "eslint.useFlatConfig": true,
     "jest.jestCommandLine": "npm test -- ",
     "jest.runMode": {
         "type": "on-demand",

eslint.config.mjs

@@ -74,7 +74,7 @@ export default [
         project: [
           './tsconfig.eslint.json',
           './tsconfig.json',
-          './tsconfig.prod.json',
+          './tsconfig.node.json',
         ],
       },
     },

jest.config.ts

@@ -1,17 +1,44 @@
-import type { JestConfigWithTsJest } from 'ts-jest';
+import {
+  createDefaultEsmPreset,
+  pathsToModuleNameMapper,
+  type JestConfigWithTsJest,
+} from 'ts-jest';
+
+import { compilerOptions } from './tsconfig.aliases.json';
+import packageJson from './package.json';
+
+const pathAliases = {
+  ...compilerOptions.paths,
+  // Jest wants to know the folder to do the transformation, not the `src/index.js`. 🤷
+  [packageJson.name]: ['src'],
+};
+
+// See here for more info https://kulshekhar.github.io/ts-jest/docs/getting-started/presets/#advanced
+const preset = createDefaultEsmPreset({
+  tsconfig: './tests/tsconfig.json',
+});
 
 const config: JestConfigWithTsJest = {
-  preset: 'ts-jest',
-  testRegex: [
-    '/tests/.*tests?.[jt]sx?',
-    '/__tests__/.*tests?.[jt]sx?',
-    '.*.(spec|test).[jt]sx?',
-  ],
+  ...preset,
+  roots: ['<rootDir>'],
+  modulePaths: [compilerOptions.baseUrl],
+  moduleNameMapper: pathsToModuleNameMapper(pathAliases, {
+    useESM: true,
+  }),
+  modulePathIgnorePatterns: ['<rootDir>/dist/', '<rootDir>/build/'],
+  testRegex: ['/tests/.*tests?.[mc]?[jt]sx?$', '.*.(spec|test).[mc]?[jt]sx?$'],
   // I dono't think we need to run the spec multiple times.. the functional test on tests/ maybe.
-  // We can change this if we consider it useful to run the spec tests when the code is transpiled to javascript
-  testPathIgnorePatterns: ['node_modules', 'build/'],
+  // We can change this back if we consider it useful to run the spec tests when the code is transpiled to javascript
+  testPathIgnorePatterns: [
+    'node_modules',
+    '<rootDir>/build[^/]*/',
+    '<rootDir>/dist/',
+  ],
   testEnvironment: 'node',
-  collectCoverageFrom: ['src/**/*.{js,ts,jsx,tsx}'],
+  collectCoverageFrom: [
+    'src/**/*.{js,ts,jsx,tsx}',
+    '!src/**/*.{spec,test}.{js,ts,jsx,tsx}',
+  ],
   verbose: true,
   // Important to use the AfterEnv to have the jest timeout and all the other settings inside that file to be correctly understood
   // See the difference between setupFiles and setupFilesAfterEnv to see the difference.