feat(misc): replace ts-jest transformer with @swc/jest for ts sol…

…ution setup (#29763) ## Current Behavior ## Expected Behavior ## Related Issue(s) Fixes #
nrwl · Jan 28, 2025 · 626c514 · 626c514
1 parent 5127c15
commit 626c514
Show file tree

Hide file tree

Showing 14 changed files with 479 additions and 42 deletions.
diff --git a/packages/detox/src/generators/application/application.spec.ts b/packages/detox/src/generators/application/application.spec.ts
@@ -252,11 +252,8 @@ describe('detox application generator', () => {
       expect(tree.exists('my-dir/my-app-e2e/.detoxrc.json')).toBeTruthy();
       expect(tree.exists('my-dir/my-app-e2e/src/app.spec.ts')).toBeTruthy();
 
-      const detoxrc = tree.read('my-dir/my-app-e2e/.detoxrc.json').toString();
-      // Strip trailing commas
-      const detoxrcJson = JSON.parse(
-        detoxrc.replace(/(?<=(true|false|null|["\d}\]])\s*),(?=\s*[}\]])/g, '')
-      );
+      const detoxrcJson = readJson(tree, 'my-dir/my-app-e2e/.detoxrc.json');
+      expect(detoxrcJson.testRunner.args.config).toEqual('./jest.config.json');
       const appsDetoxrcJson = detoxrcJson['apps'];
       expect(appsDetoxrcJson).toEqual({
         'android.debug': {
@@ -288,6 +285,32 @@ describe('detox application generator', () => {
           type: 'ios.app',
         },
       });
+      expect(tree.read('my-dir/my-app-e2e/jest.config.json', 'utf-8'))
+        .toMatchInlineSnapshot(`
+        "{
+          "preset": "../../jest.preset",
+          "rootDir": ".",
+          "testMatch": [
+            "<rootDir>/src/**/*.test.ts?(x)",
+            "<rootDir>/src/**/*.spec.ts?(x)"
+          ],
+          "testTimeout": 120000,
+          "maxWorkers": 1,
+          "globalSetup": "detox/runners/jest/globalSetup",
+          "globalTeardown": "detox/runners/jest/globalTeardown",
+          "reporters": ["detox/runners/jest/reporter"],
+          "testEnvironment": "detox/runners/jest/testEnvironment",
+          "verbose": true,
+          "setupFilesAfterEnv": ["<rootDir>/test-setup.ts"],
+          "transform": {
+            "^.+\\\\.(ts|js|html)$": [
+              "ts-jest",
+              { "tsconfig": "<rootDir>/tsconfig.e2e.json" }
+            ]
+          }
+        }
+        "
+      `);
     });
 
     it('should update configuration', async () => {
@@ -558,5 +581,84 @@ describe('detox application generator', () => {
         "
       `);
     });
+
+    it('should generate jest test config with @swc/jest', async () => {
+      writeJson(tree, 'apps/my-app/package.json', {
+        name: 'my-app',
+      });
+
+      await detoxApplicationGenerator(tree, {
+        e2eDirectory: 'apps/my-app-e2e',
+        appProject: 'my-app',
+        linter: Linter.None,
+        framework: 'react-native',
+        addPlugin: true,
+        skipFormat: true,
+      });
+
+      expect(tree.exists('apps/my-app-e2e/test-setup.ts')).toBeTruthy();
+      const detoxrc = readJson(tree, 'apps/my-app-e2e/.detoxrc.json');
+      expect(detoxrc.testRunner.args.config).toEqual('./jest.config.ts');
+      expect(tree.read('apps/my-app-e2e/jest.config.ts', 'utf-8'))
+        .toMatchInlineSnapshot(`
+        "/* eslint-disable */
+        import { readFileSync } from 'fs';
+
+        // Reading the SWC compilation config for the spec files
+        const swcJestConfig = JSON.parse(
+          readFileSync(\`\${__dirname}/.spec.swcrc\`, 'utf-8')
+        );
+
+        // Disable .swcrc look-up by SWC core because we're passing in swcJestConfig ourselves
+        swcJestConfig.swcrc = false;
+
+        export default {
+          preset: "../../jest.preset",
+          rootDir: ".",
+          testMatch: [
+            "<rootDir>/src/**/*.test.ts?(x)",
+            "<rootDir>/src/**/*.spec.ts?(x)"
+          ],
+          testTimeout: 120000,
+          maxWorkers: 1,
+          globalSetup: "detox/runners/jest/globalSetup",
+          globalTeardown: "detox/runners/jest/globalTeardown",
+          reporters: ["detox/runners/jest/reporter"],
+          testEnvironment: "detox/runners/jest/testEnvironment",
+          verbose: true,
+          setupFilesAfterEnv: ["<rootDir>/test-setup.ts"],
+          transform: {
+            "^.+\\\\.(ts|js|html)$": ['@swc/jest', swcJestConfig]
+          }
+        };
+        "
+      `);
+      expect(tree.read('apps/my-app-e2e/.spec.swcrc', 'utf-8'))
+        .toMatchInlineSnapshot(`
+          "{
+            "jsc": {
+              "target": "es2017",
+              "parser": {
+                "syntax": "typescript",
+                "decorators": true,
+                "dynamicImport": true
+              },
+              "transform": {
+                "decoratorMetadata": true,
+                "legacyDecorator": true
+              },
+              "keepClassNames": true,
+              "externalHelpers": true,
+              "loose": true
+            },
+            "module": {
+              "type": "es6"
+            },
+            "sourceMaps": true,
+            "exclude": []
+          }
+          "
+        `);
+    });
   });
 });
diff --git a/packages/detox/src/generators/application/files/app/.detoxrc.json.template b/packages/detox/src/generators/application/files/app/.detoxrc.json.template
@@ -2,7 +2,7 @@
   "testRunner": {
     "args": {
       "$0": "jest",
-      "config": "./jest.config.json"
+      "config": "./<%= jestConfigFileName %>"
     },
     "jest": {
       "setupTimeout": 120000

diff --git a/...ation/files/app/jest.config.json.template → ...non-ts-solution/jest.config.json.template b/...ation/files/app/jest.config.json.template → ...non-ts-solution/jest.config.json.template
@@ -13,11 +13,10 @@
   "testEnvironment": "detox/runners/jest/testEnvironment",
   "verbose": true,
   "setupFilesAfterEnv": ["<rootDir>/test-setup.ts"],
-      "transform": {
+  "transform": {
     "^.+\\.(ts|js|html)$": [
       "ts-jest",
       { "tsconfig": "<rootDir>/tsconfig.e2e.json" }
     ]
   }
-
 }
diff --git a/packages/detox/src/generators/application/files/ts-solution/jest.config.ts.template b/packages/detox/src/generators/application/files/ts-solution/jest.config.ts.template
@@ -0,0 +1,30 @@
+/* eslint-disable */
+<% if (js) { %>const { readFileSync } = require('fs')<% } else { %>import { readFileSync } from 'fs';<% } %>
+
+// Reading the SWC compilation config for the spec files
+const swcJestConfig = JSON.parse(
+  readFileSync(`${__dirname}/.spec.swcrc`, 'utf-8')
+);
+
+// Disable .swcrc look-up by SWC core because we're passing in swcJestConfig ourselves
+swcJestConfig.swcrc = false;
+
+<% if (js) { %>module.exports =<% } else { %>export default<% } %> {
+  preset: "<%= offsetFromRoot %>jest.preset",
+  rootDir: ".",
+  testMatch: [
+    "<rootDir>/src/**/*.test.ts?(x)",
+    "<rootDir>/src/**/*.spec.ts?(x)"
+  ],
+  testTimeout: 120000,
+  maxWorkers: 1,
+  globalSetup: "detox/runners/jest/globalSetup",
+  globalTeardown: "detox/runners/jest/globalTeardown",
+  reporters: ["detox/runners/jest/reporter"],
+  testEnvironment: "detox/runners/jest/testEnvironment",
+  verbose: true,
+  setupFilesAfterEnv: ["<rootDir>/test-setup.ts"],
+  transform: {
+    "^.+\\.(ts|js|html)$": ['@swc/jest', swcJestConfig]
+  }
+};
diff --git a/packages/detox/src/generators/application/lib/create-files.spec.ts b/packages/detox/src/generators/application/lib/create-files.spec.ts
@@ -28,6 +28,7 @@ describe('Create Files', () => {
     expect(tree.exists('apps/my-app-e2e/.detoxrc.json')).toBeTruthy();
     expect(tree.exists('apps/my-app-e2e/tsconfig.json')).toBeTruthy();
     expect(tree.exists('apps/my-app-e2e/tsconfig.e2e.json')).toBeTruthy();
+    expect(tree.exists('apps/my-app-e2e/jest.config.json')).toBeTruthy();
     expect(tree.exists('apps/my-app-e2e/test-setup.ts')).toBeTruthy();
   });
 });
diff --git a/packages/detox/src/generators/application/lib/create-files.ts b/packages/detox/src/generators/application/lib/create-files.ts
@@ -1,14 +1,15 @@
 import {
+  offsetFromRoot as _offsetFromRoot,
   detectPackageManager,
   generateFiles,
   getPackageManagerCommand,
-  offsetFromRoot as _offsetFromRoot,
+  joinPathFragments,
   toJS,
   Tree,
   writeJson,
-  joinPathFragments,
 } from '@nx/devkit';
 import { getRelativePathToRootTsConfig } from '@nx/js';
+import { addSwcTestConfig } from '@nx/js/src/utils/swc/add-swc-config';
 import { join } from 'path';
 import { NormalizedSchema } from './normalize-options';
 
@@ -23,8 +24,22 @@ export function createFiles(host: Tree, options: NormalizedSchema) {
     exec: getPackageManagerCommand(detectPackageManager(host.root)).exec,
     offsetFromRoot,
     rootTsConfigPath,
+    jestConfigFileName: options.isUsingTsSolutionConfig
+      ? 'jest.config.ts'
+      : 'jest.config.json',
   });
   if (options.isUsingTsSolutionConfig) {
+    addSwcTestConfig(host, options.e2eProjectRoot, 'es6');
+    generateFiles(
+      host,
+      join(__dirname, '../files/ts-solution'),
+      options.e2eProjectRoot,
+      {
+        ...options,
+        exec: getPackageManagerCommand(detectPackageManager(host.root)).exec,
+        offsetFromRoot,
+      }
+    );
     writeJson(
       host,
       joinPathFragments(options.e2eProjectRoot, 'tsconfig.json'),

diff --git a/packages/detox/src/generators/application/lib/normalize-options.spec.ts b/packages/detox/src/generators/application/lib/normalize-options.spec.ts
@@ -39,6 +39,7 @@ describe('Normalize Options', () => {
       appRoot: 'apps/my-app',
       isUsingTsSolutionConfig: false,
       linter: Linter.EsLint,
+      js: false,
     });
   });
 
@@ -68,6 +69,7 @@ describe('Normalize Options', () => {
       e2eProjectRoot: 'apps/my-app-e2e',
       framework: 'react-native',
       isUsingTsSolutionConfig: false,
+      js: false,
     });
   });
 
@@ -97,6 +99,7 @@ describe('Normalize Options', () => {
       e2eProjectName: 'directory-my-app-e2e',
       framework: 'react-native',
       isUsingTsSolutionConfig: false,
+      js: false,
     });
   });
 });
diff --git a/packages/detox/src/generators/application/lib/normalize-options.ts b/packages/detox/src/generators/application/lib/normalize-options.ts
@@ -48,5 +48,6 @@ export async function normalizeOptions(
     e2eProjectName,
     e2eProjectRoot,
     isUsingTsSolutionConfig: isUsingTsSolutionSetup(host),
+    js: options.js ?? false,
   };
 }