feat: run Node.js ESM tests on commit

Author: shijistar

.eslintignore

@@ -1,10 +1,14 @@
+.DS_Store
+
 node_modules
+coverage
 lib
 es
 es-legacy
+umd
 tslib
+tses
 public
-coverage
-.DS_Store
+
 .vscode
 *.md

.github/workflows/reusable-test.yml

@@ -16,7 +16,12 @@ on:
         default: false
 
 jobs:
-  node-modules-cache:
+  # This job is used to cache node_modules and build output
+  # 1. Install latest dependencies
+  # 2. Cache node_modules
+  # 3. Build package
+  # 4. Cache build output
+  install-and-build:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
     steps:
@@ -63,29 +68,6 @@ jobs:
           name: modern-node-modules-${{ hashFiles('**/package-lock.json') }}
           path: node_modules
 
-  # This job is used to run tests on modern Node.js versions
-  # 1. Use default Node.js
-  # 2. Install latest dependencies
-  # 3. Cache node_modules
-  build-modern-node:
-    if: ${{ inputs.use-matrix == true }}
-    runs-on: ubuntu-latest
-    needs: node-modules-cache
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Use Node.js ${{ vars.DEFAULT_NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ vars.DEFAULT_NODE_VERSION }}
-
-      - name: Restore modern node_modules cache
-        id: node_modules_cache
-        uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: ${{ runner.os }}-modern-node-modules-${{ hashFiles('**/package-lock.json') }}
-
       - name: Build package
         run: npm run build
 
@@ -94,6 +76,7 @@ jobs:
         with:
           path: |
             tslib
+            tses
             lib
             es
             es-legacy
@@ -106,12 +89,12 @@ jobs:
           name: ${{ runner.os }}-modern-build-output-${{ github.sha }}
           path: |
             tslib
+            tses
             lib
             es
             es-legacy
             umd
-
-  build-legacy-node:
+  node-modules-legacy-cache:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
     steps:
@@ -137,14 +120,37 @@ jobs:
         if: steps.node_modules_cache.outputs.cache-hit != 'true'
         run: npm install --legacy-peer-deps --ignore-scripts --no-package-lock
 
-  # Run tests on multiple matrix Node.js versions
-  run-jest-lib-modern:
+  # Run ts-tests on default Node.js version
+  run-jest-ts:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
-    needs: build-modern-node
+    needs: install-and-build
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ vars.DEFAULT_NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ vars.DEFAULT_NODE_VERSION }}
+
+      - name: Restore modern node_modules cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            node_modules
+          key: ${{ runner.os }}-modern-node-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Run jest tests from source codes
+        run: npm test
+
+  # Run Node.js CJS unit tests on multiple modern node versions
+  run-jest-cjs:
+    if: ${{ inputs.use-matrix == true }}
+    runs-on: ubuntu-latest
+    needs: install-and-build
     strategy:
       matrix:
-        node-version: [16.x, 17.x, 18.x, 19.x, 20.x, 21.x, 22.x, 23.x]
+        node-version: [16.x, 17.x, 18.x, 19.x, 20.x, 21.x, 22.x, 23.x, 24.x]
     steps:
       - uses: actions/checkout@v4
 
@@ -165,20 +171,21 @@ jobs:
         with:
           path: |
             tslib
+            tses
             lib
             es
             es-legacy
             umd
           key: ${{ runner.os }}-modern-build-output-${{ github.sha }}
 
-      - name: Run jest tests from lib directory
-        run: npm run task:jest:lib
+      - name: Run jest tests from tslib directory
+        run: npm run task:jest-cjs
 
-  # Run legacy tests on multiple matrix Node.js versions
-  run-jest-lib-legacy:
+  # Run CJS unit tests on multiple legacy node versions
+  run-jest-cjs-legacy:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
-    needs: [build-modern-node, build-legacy-node]
+    needs: [install-and-build, node-modules-legacy-cache]
     strategy:
       matrix:
         node-version: [7.x, 8.x, 9.x, 10.x, 11.x, 12.x, 13.x, 14.x, 15.x]
@@ -202,27 +209,31 @@ jobs:
         with:
           path: |
             tslib
+            tses
             lib
             es
             es-legacy
             umd
           key: ${{ runner.os }}-modern-build-output-${{ github.sha }}
 
-      - name: Run jest tests from lib directory
-        run: npm run task:jest:lib
+      - name: Run jest tests from tslib directory
+        run: npm run task:jest-cjs
 
-  # Run ts-tests on default Node.js version
-  run-jest-ts:
+  # Run ESM unit tests on node versions that support Node.js ESM
+  run-jest-esm:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
-    needs: build-modern-node
+    needs: install-and-build
+    strategy:
+      matrix:
+        node-version: [16.x, 17.x, 18.x, 19.x, 20.x, 21.x, 22.x, 23.x, 24.x]
     steps:
       - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ vars.DEFAULT_NODE_VERSION }}
+      - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ vars.DEFAULT_NODE_VERSION }}
+          node-version: ${{ matrix.node-version }}
 
       - name: Restore modern node_modules cache
         uses: actions/cache@v4
@@ -231,13 +242,25 @@ jobs:
             node_modules
           key: ${{ runner.os }}-modern-node-modules-${{ hashFiles('**/package-lock.json') }}
 
-      - name: Run jest tests from source codes
-        run: npm test
+      - name: Restore modern build output cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            tslib
+            tses
+            lib
+            es
+            es-legacy
+            umd
+          key: ${{ runner.os }}-modern-build-output-${{ github.sha }}
+
+      - name: Run jest tests from tses directory
+        run: npm run task:jest-esm
 
-  run-e2e-tests:
+  # Run e2e tests
+  run-e2e:
     if: ${{ inputs.use-matrix == true }}
     runs-on: ubuntu-latest
-    # needs: build-modern-node
     steps:
       - uses: actions/checkout@v4
 
@@ -273,7 +296,7 @@ jobs:
           name: ${{ runner.os }}-modern-build-output-${{ github.sha }}
 
       - name: Build package
-        # if: steps.download_build_output.outcome != 'success'
+        if: steps.download_build_output.outcome != 'success'
         run: npm run build
 
       - name: Run e2e tests

.prettierignore

@@ -1,8 +1,11 @@
+.DS_Store
+coverage
+
 node_modules
 lib
 es
 es-legacy
+umd
 tslib
+tses
 public
-coverage
-.DS_Store

jest-lib.config.js jest-cjs.config.jsjest-lib.config.js renamed to jest-cjs.config.js

@@ -5,9 +5,13 @@ const config = {
   testEnvironment: 'node',
   testMatch: ['<rootDir>/tslib/test/**/*.{spec,test}.js'],
   collectCoverage: true,
-  collectCoverageFrom: ['<rootDir>/tslib/src/**/*.js'],
+  collectCoverageFrom: ['<rootDir>/lib/**/*.js'],
   coverageReporters: ['json', 'lcov', 'text', 'clover'],
-  coveragePathIgnorePatterns: ['<rootDir>/tslib/src/types.js', '<rootDir>/tslib/src/localize-interface.js'],
+  coveragePathIgnorePatterns: ['<rootDir>/lib/types.js', '<rootDir>/lib/localize-interface.js'],
+  moduleNameMapper: {
+    '^@enum-plus/(.*)$': '<rootDir>/lib/$1',
+    '^@enum-plus': '<rootDir>/lib/index.js',
+  },
   coverageThreshold: {
     global: {
       branches: 100,

jest-es.config.js jest-esm.config.jsjest-es.config.js renamed to jest-esm.config.js

@@ -1,14 +1,17 @@
-const nodeVersion = process.versions.node.split('.').map(Number)[0];
-
 /** @type {import('jest').Config} */
 const config = {
   testEnvironment: 'node',
   extensionsToTreatAsEsm: ['.ts'],
   testMatch: ['<rootDir>/tses/test/**/*.{spec,test}.js'],
   collectCoverage: true,
-  collectCoverageFrom: ['<rootDir>/tses/src/**/*.js'],
+  collectCoverageFrom: ['<rootDir>/es/**/*.js'],
   coverageReporters: ['json', 'lcov', 'text', 'clover'],
   coveragePathIgnorePatterns: ['<rootDir>/es/types.js', '<rootDir>/es/localize-interface.js'],
+  setupFilesAfterEnv: ['<rootDir>/tses/test/jest.setup.js'],
+  moduleNameMapper: {
+    '^@enum-plus/(.*)$': '<rootDir>/es/$1',
+    '^@enum-plus': '<rootDir>/es/index.js',
+  },
   transform: {
     '^.+\\.(ts|js)$': ['ts-jest', { useESM: true }],
   },
@@ -21,11 +24,5 @@ const config = {
     },
   },
 };
-if (nodeVersion <= 15) {
-  // @ts-expect-error: because setupTestFrameworkScriptFile is a deprecated API
-  config.setupTestFrameworkScriptFile = '<rootDir>/tses/test/jest.setup.js';
-} else {
-  config.setupFilesAfterEnv = ['<rootDir>/tses/test/jest.setup.js'];
-}
 
-export default config;
+module.exports = config;

jest.config.js

@@ -8,6 +8,10 @@ module.exports = {
   collectCoverageFrom: ['src/**/*.{ts,tsx}'],
   coverageReporters: ['json', 'lcov', 'text', 'clover'],
   coveragePathIgnorePatterns: ['src/types.ts', 'src/localize-interface.ts', 'src/extension.d.ts'],
+  moduleNameMapper: {
+    '^@enum-plus/(.*)$': '<rootDir>/src/$1',
+    '^@enum-plus': '<rootDir>/src',
+  },
   coverageThreshold: {
     global: {
       branches: 100,

package.json

@@ -90,6 +90,7 @@
     "build:es": "run-s task:build-es task:add-umd-banner task:add-es-extensions",
     "build:es-legacy": "cross-env LEGACY=1 run-s task:build-es-legacy task:add-umd-banner task:add-es-legacy-extensions",
     "build:lib": "run-s ts2lib task:copy-dts task:copy-lib",
+    "build:tses": "run-s ts2es task:add-tses-extensions",
     "e2e": "run-s task:bundle-e2e task:run-e2e",
     "e2e:debug": "run-s task:bundle-e2e task:run-e2e-debug",
     "e2e:ui": "run-s task:bundle-e2e task:run-e2e-ui",
@@ -106,19 +107,14 @@
     "task:copy-dts": "shx cp ./src/*.d.ts ./lib",
     "task:copy-lib": "tsx scripts/copy-lib.ts",
     "task:jest": "jest --coverage",
-    "task:jest:es": "jest --coverage -c jest-es.config.js",
-    "task:jest:lib": "jest --coverage -c jest-lib.config.js",
+    "task:jest-cjs": "jest --coverage -c jest-cjs.config.js",
+    "task:jest-esm": "jest --coverage -c jest-esm.config.js",
     "task:run-e2e": "playwright test",
     "task:run-e2e-debug": "playwright test --debug",
     "task:run-e2e-ui": "playwright test --ui",
-    "task:run-e2e:chrome": "playwright test --project=chrome",
-    "task:run-e2e:chromium-legacy": "playwright test --project=chromium-legacy",
-    "task:run-e2e:edge": "playwright test --project=edge",
-    "task:run-e2e:firefox": "playwright test --project=firefox",
-    "task:run-e2e:webkit": "playwright test --project=webkit",
     "test": "npm run task:jest",
-    "test-node-cjs": "run-s ts2lib task:jest:lib",
-    "test-node-esm": "run-s ts2es task:add-tses-extensions task:jest:es",
+    "test-node-cjs": "run-s ts2lib task:jest-cjs",
+    "test-node-esm": "run-s build:tses task:jest-esm",
     "ts2es": "tsc -p tsconfig.es.json",
     "ts2lib": "tsc -p tsconfig.lib.json"
   },

test/data/week-config.ts

@@ -1,4 +1,4 @@
-import type { defaultLocalize as defaultLocalizeType, Enum as EnumType } from '../../src/index';
+import type { defaultLocalize as defaultLocalizeType, Enum as EnumType } from '@enum-plus';
 
 export const localeEN = {
   'weekDay.name': 'Week Days',

test/engines/base.ts

@@ -1,4 +1,4 @@
-import type * as EnumPlusNamespace from '../../src/index';
+import type * as EnumPlusNamespace from '@enum-plus';
 import type * as WeekConfigNamespace from '../data/week-config';
 import type * as WeekDataNamespace from '../data/week-data';
 import type * as SerializeJavascriptNamespace from '../utils/serialize-javascript';

test/engines/jest.ts

@@ -1,4 +1,4 @@
-import * as EnumPlus from '../../src/index';
+import * as EnumPlus from '@enum-plus';
 import * as WeekConfig from '../data/week-config';
 import * as WeekData from '../data/week-data';
 import * as SerializeJavascript from '../utils/serialize-javascript';