feat(testing): move jest config to .ts

move jest config and preset to ts files ISSUES CLOSED: #8344
nrwl · Apr 20, 2022 · 903ef65 · 903ef65
1 parent 4ca470c
commit 903ef65
Show file tree

Hide file tree

Showing 33 changed files with 543 additions and 43 deletions.
diff --git a/packages/jest/migrations.json b/packages/jest/migrations.json
@@ -41,6 +41,12 @@
       "cli": "nx",
       "description": "Create a root babel config file if it doesn't exist and using babel-jest in jest.config.js and add @nrwl/web as needed",
       "factory": "./src/migrations/update-13-4-4/add-missing-root-babel-config"
+    },
+    "update-jest-config-extensions": {
+      "version": "14.0.0-beta.1",
+      "cli": "nx",
+      "description": "Update move jest config files to .ts files.",
+      "factory": "./src/migrations/update-14-0-0/update-jest-config-ext"
     }
   },
   "packageJsonUpdates": {

diff --git a/packages/jest/src/generators/init/init.ts b/packages/jest/src/generators/init/init.ts
@@ -25,9 +25,9 @@ const schemaDefaults = {
 } as const;
 
 function createJestConfig(host: Tree) {
-  if (!host.exists('jest.config.js')) {
+  if (!host.exists('jest.config.ts')) {
     host.write(
-      'jest.config.js',
+      'jest.config.ts',
       stripIndents`
   const { getJestProjects } = require('@nrwl/jest');
 
@@ -37,9 +37,9 @@ function createJestConfig(host: Tree) {
     );
   }
 
-  if (!host.exists('jest.preset.js')) {
+  if (!host.exists('jest.preset.ts')) {
     host.write(
-      'jest.preset.js',
+      'jest.preset.ts',
       `
       const nxPreset = require('@nrwl/jest/preset');
      

diff --git a/packages/jest/src/generators/jest-project/__snapshots__/jest-project.spec.ts.snap b/packages/jest/src/generators/jest-project/__snapshots__/jest-project.spec.ts.snap
@@ -64,7 +64,7 @@ exports[`jestProject --setup-file should have setupFilesAfterEnv and globals.ts-
 "
 `;
 
-exports[`jestProject should create a jest.config.js 1`] = `
+exports[`jestProject should create a jest.config.ts 1`] = `
 "module.exports = {
   displayName: 'lib1',
   preset: '../../jest.preset.js',

diff --git a/...ject/files-angular/jest.config.js__tmpl__ → ...ject/files-angular/jest.config.ts__tmpl__ b/...ject/files-angular/jest.config.js__tmpl__ → ...ject/files-angular/jest.config.ts__tmpl__
@@ -1,6 +1,6 @@
 module.exports = {
   displayName: '<%= project %>',
-  preset: '<%= offsetFromRoot %>jest.preset.js',
+  preset: '<%= offsetFromRoot %>jest.preset.ts',
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
   globals: {
     'ts-jest': {

diff --git a/...jest-project/files/jest.config.js__tmpl__ → ...jest-project/files/jest.config.ts__tmpl__ b/...jest-project/files/jest.config.js__tmpl__ → ...jest-project/files/jest.config.ts__tmpl__
@@ -1,6 +1,6 @@
 module.exports = {
   displayName: '<%= project %>',
-  preset: '<%= offsetFromRoot %>jest.preset.js',<% if(setupFile !== 'none') { %>
+  preset: '<%= offsetFromRoot %>jest.preset.ts',<% if(setupFile !== 'none') { %>
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],<% } %><% if (transformer === 'ts-jest') { %>
   globals: {
     'ts-jest': {

diff --git a/packages/jest/src/generators/jest-project/lib/update-jestconfig.ts b/packages/jest/src/generators/jest-project/lib/update-jestconfig.ts
@@ -3,7 +3,7 @@ import { addPropertyToJestConfig } from '../../../utils/config/update-config';
 import { readProjectConfiguration, Tree } from '@nrwl/devkit';
 
 function isUsingUtilityFunction(host: Tree) {
-  return host.read('jest.config.js').toString().includes('getJestProjects()');
+  return host.read('jest.config.ts').toString().includes('getJestProjects()');
 }
 
 export function updateJestConfig(host: Tree, options: JestProjectSchema) {
@@ -13,7 +13,7 @@ export function updateJestConfig(host: Tree, options: JestProjectSchema) {
   const project = readProjectConfiguration(host, options.project);
   addPropertyToJestConfig(
     host,
-    'jest.config.js',
+    'jest.config.ts',
     'projects',
     `<rootDir>/${project.root}`
   );

diff --git a/packages/jest/src/generators/jest-project/lib/update-workspace.ts b/packages/jest/src/generators/jest-project/lib/update-workspace.ts
@@ -20,7 +20,7 @@ export function updateWorkspace(tree: Tree, options: JestProjectSchema) {
     options: {
       jestConfig: joinPathFragments(
         normalizePath(projectConfig.root),
-        'jest.config.js'
+        'jest.config.ts'
       ),
       passWithNoTests: true,
     },

diff --git a/packages/jest/src/migrations/update-14-0-0/__snapshots__/update-jest-config-ext.spec.ts.snap b/packages/jest/src/migrations/update-14-0-0/__snapshots__/update-jest-config-ext.spec.ts.snap
@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Jest Migration (v14.0.0) should rename project jest.config.js to jest.config.ts 1`] = `
+"module.exports = {
+  displayName: 'lib-one',
+  preset: '../../jest.preset.ts',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    }
+  },
+  transform: {
+    '^.+\\\\\\\\.[tj]sx?$': 'ts-jest'
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/libs/lib-one'
+};
+"
+`;
+
+exports[`Jest Migration (v14.0.0) should update jest.config.ts preset to use the jest.preset.ts 1`] = `
+"module.exports = {
+  displayName: 'lib-one',
+  preset: '../../jest.preset.ts',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    }
+  },
+  transform: {
+    '^.+\\\\\\\\.[tj]sx?$': 'ts-jest'
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/libs/lib-one'
+};
+"
+`;
diff --git a/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.spec.ts b/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.spec.ts
@@ -0,0 +1,162 @@
+import {
+  readJson,
+  readProjectConfiguration,
+  Tree,
+  updateJson,
+  updateProjectConfiguration,
+} from '@nrwl/devkit';
+import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
+import { updateJestConfigExt } from './update-jest-config-ext';
+import { libraryGenerator as workspaceLib } from '@nrwl/workspace';
+
+describe('Jest Migration (v14.0.0)', () => {
+  let tree: Tree;
+  beforeEach(async () => {
+    tree = createTreeWithEmptyWorkspace(2);
+    tree.write(
+      'jest.config.js',
+      String.raw`
+const { getJestProjects } = require('@nrwl/jest');
+module.exports = {
+  projects: getJestProjects(),
+};
+`
+    );
+    tree.write(
+      'jest.preset.js',
+      String.raw`
+const nxPreset = require('@nrwl/jest/preset');
+module.exports = { ...nxPreset };
+`
+    );
+    await workspaceLib(tree, { name: 'lib-one' });
+    tree.rename('libs/lib-one/jest.config.ts', 'libs/lib-one/jest.config.js');
+    updateProjectConfiguration(tree, 'lib-one', {
+      ...readProjectConfiguration(tree, 'lib-one'),
+      targets: {
+        test: {
+          executor: '@nrwl/jest:jest',
+          options: {
+            jestConfig: 'libs/lib-one/jest.config.js',
+            passWithNoTests: true,
+          },
+        },
+      },
+    });
+  });
+
+  it('should rename project jest.config.js to jest.config.ts', async () => {
+    await updateJestConfigExt(tree);
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeTruthy();
+    expect(tree.read('libs/lib-one/jest.config.ts', 'utf-8')).toMatchSnapshot();
+  });
+
+  it('should rename root jest files', async () => {
+    await updateJestConfigExt(tree);
+    expect(tree.exists('jest.config.ts')).toBeTruthy();
+    expect(tree.exists('jest.preset.ts')).toBeTruthy();
+  });
+
+  it('should update jest.config.ts preset to use the jest.preset.ts', async () => {
+    tree.rename('libs/lib-one/jest.config.js', 'libs/lib-one/jest.config.ts');
+    const projectConfig = readProjectConfiguration(tree, 'lib-one');
+    updateProjectConfiguration(tree, 'lib-one', {
+      ...projectConfig,
+      targets: {
+        test: {
+          ...projectConfig.targets.test,
+          options: {
+            jestConfig: 'libs/lib-one/jest.config.ts',
+            passWithNoTests: true,
+          },
+        },
+      },
+    });
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeTruthy();
+    await updateJestConfigExt(tree);
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeTruthy();
+    expect(tree.read('libs/lib-one/jest.config.ts', 'utf-8')).toMatchSnapshot();
+  });
+
+  it('should only update js/ts files', async () => {
+    tree.rename('libs/lib-one/jest.config.js', 'libs/lib-one/jest.config.ts');
+    updateProjectConfiguration(tree, 'lib-one', {
+      ...readProjectConfiguration(tree, 'lib-one'),
+      targets: {
+        test: {
+          executor: '@nrwl/jest:jest',
+          options: {
+            jestConfig: 'libs/lib-one/jest.config.ts',
+            passWithNoTests: true,
+          },
+        },
+      },
+    });
+
+    await workspaceLib(tree, { name: 'lib-two' });
+    tree.delete('libs/lib-two/jest.config.ts'); // lib generator creates a ts file
+    tree.write('libs/lib-two/jest.config.json', '{}');
+    updateProjectConfiguration(tree, 'lib-two', {
+      ...readProjectConfiguration(tree, 'lib-two'),
+      targets: {
+        test: {
+          executor: '@nrwl/jest:jest',
+          options: {
+            jestConfig: 'libs/lib-two/jest.config.json',
+            passWithNoTests: true,
+          },
+        },
+      },
+    });
+    await workspaceLib(tree, { name: 'lib-three' });
+
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeTruthy();
+    await updateJestConfigExt(tree);
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeTruthy();
+    expect(tree.exists('libs/lib-two/jest.config.ts')).toBeFalsy();
+    expect(tree.exists('libs/lib-two/jest.config.json')).toBeTruthy();
+    expect(tree.exists('libs/lib-three/jest.config.ts')).toBeTruthy();
+  });
+
+  it('should not throw error if file does not exit', async () => {
+    tree.delete('libs/lib-one/jest.config.js');
+    await updateJestConfigExt(tree);
+    expect(tree.exists('libs/lib-one/jest.config.ts')).toBeFalsy();
+    expect(tree.exists('libs/lib-one/jest.config.js')).toBeFalsy();
+  });
+
+  it('should update correct tsconfigs', async () => {
+    updateJson(tree, 'libs/lib-one/tsconfig.lib.json', (json) => {
+      json.exclude = ['**/*.spec.ts'];
+      return json;
+    });
+
+    await updateJestConfigExt(tree);
+
+    const tsconfig = readJson(tree, 'libs/lib-one/tsconfig.json');
+    const libTsConfig = readJson(tree, 'libs/lib-one/tsconfig.lib.json');
+    const specTsConfig = readJson(tree, 'libs/lib-one/tsconfig.spec.json');
+
+    expect(tsconfig.exclude).toBeFalsy();
+    expect(libTsConfig.exclude).toEqual(['**/*.spec.ts', 'jest.config.ts']);
+    expect(specTsConfig.exclude).toBeFalsy();
+  });
+
+  it('should add exclude to root tsconfig with no references', async () => {
+    tree.delete('libs/lib-one/tsconfig.spec.json');
+    tree.delete('libs/lib-one/tsconfig.lib.json');
+
+    updateJson(tree, 'libs/lib-one/tsconfig.json', (json) => {
+      delete json.references;
+      return json;
+    });
+
+    await updateJestConfigExt(tree);
+
+    const tsconfig = readJson(tree, 'libs/lib-one/tsconfig.json');
+
+    expect(tsconfig.exclude).toEqual(['jest.config.ts']);
+    expect(tree.exists('libs/lib-one/tsconfig.spec.json')).toBeFalsy();
+    expect(tree.exists('libs/lib-one/tsconfig.lib.json')).toBeFalsy();
+  });
+});