fix(testing): exclude jest.config.ts in angular project tsconfigs (#1…

…1468)
nrwl · Aug 5, 2022 · bd4e6ac · bd4e6ac · vercel · Aug 5, 2022
1 parent 5267f45
commit bd4e6ac
Show file tree

Hide file tree

Showing 8 changed files with 158 additions and 10 deletions.
diff --git a/packages/angular/src/generators/application/application.spec.ts b/packages/angular/src/generators/application/application.spec.ts
@@ -103,7 +103,11 @@ describe('app', () => {
       );
       expect(tsconfigApp.compilerOptions.outDir).toEqual('../../dist/out-tsc');
       expect(tsconfigApp.extends).toEqual('./tsconfig.json');
-      expect(tsconfigApp.exclude).toEqual(['**/*.test.ts', '**/*.spec.ts']);
+      expect(tsconfigApp.exclude).toEqual([
+        'jest.config.ts',
+        '**/*.test.ts',
+        '**/*.spec.ts',
+      ]);
 
       const eslintrcJson = parseJson(
         appTree.read('apps/my-app/.eslintrc.json', 'utf-8')
@@ -307,7 +311,7 @@ describe('app', () => {
         {
           path: 'apps/my-dir/my-app/tsconfig.app.json',
           lookupFn: (json) => json.exclude,
-          expectedValue: ['**/*.test.ts', '**/*.spec.ts'],
+          expectedValue: ['jest.config.ts', '**/*.test.ts', '**/*.spec.ts'],
         },
         {
           path: 'apps/my-dir/my-app/.eslintrc.json',
@@ -390,7 +394,7 @@ describe('app', () => {
         {
           path: 'my-dir/my-app/tsconfig.app.json',
           lookupFn: (json) => json.exclude,
-          expectedValue: ['**/*.test.ts', '**/*.spec.ts'],
+          expectedValue: ['jest.config.ts', '**/*.test.ts', '**/*.spec.ts'],
         },
         {
           path: 'my-dir/my-app/.eslintrc.json',

diff --git a/packages/angular/src/generators/application/lib/update-config-files.ts b/packages/angular/src/generators/application/lib/update-config-files.ts
@@ -27,7 +27,12 @@ function updateTsConfigOptions(host: Tree, options: NormalizedSchema) {
       outDir: `${offsetFromRoot(options.appProjectRoot)}dist/out-tsc`,
     },
     exclude: [
-      ...new Set([...(json.exclude || []), '**/*.test.ts', '**/*.spec.ts']),
+      ...new Set([
+        ...(json.exclude || []),
+        'jest.config.ts',
+        '**/*.test.ts',
+        '**/*.spec.ts',
+      ]),
     ],
   }));
 

diff --git a/packages/angular/src/generators/library/lib/update-tsconfig.ts b/packages/angular/src/generators/library/lib/update-tsconfig.ts
@@ -35,7 +35,12 @@ function updateProjectConfig(host: Tree, options: NormalizedSchema) {
   updateJson(host, `${options.projectRoot}/tsconfig.lib.json`, (json) => {
     json.include = ['**/*.ts'];
     json.exclude = [
-      ...new Set([...(json.exclude || []), '**/*.test.ts', '**/*.spec.ts']),
+      ...new Set([
+        ...(json.exclude || []),
+        'jest.config.ts',
+        '**/*.test.ts',
+        '**/*.spec.ts',
+      ]),
     ];
     return json;
   });

diff --git a/packages/angular/src/generators/library/library.spec.ts b/packages/angular/src/generators/library/library.spec.ts
@@ -394,6 +394,7 @@ describe('lib', () => {
         expect(tsconfigJson.exclude).toEqual([
           'src/test-setup.ts',
           '**/*.spec.ts',
+          'jest.config.ts',
           '**/*.test.ts',
         ]);
       });
@@ -409,6 +410,7 @@ describe('lib', () => {
         expect(tsconfigJson.exclude).toEqual([
           'src/test.ts',
           '**/*.spec.ts',
+          'jest.config.ts',
           '**/*.test.ts',
         ]);
       });
@@ -421,7 +423,11 @@ describe('lib', () => {
 
         // ASSERT
         const tsconfigJson = readJson(tree, 'libs/my-lib/tsconfig.lib.json');
-        expect(tsconfigJson.exclude).toEqual(['**/*.test.ts', '**/*.spec.ts']);
+        expect(tsconfigJson.exclude).toEqual([
+          'jest.config.ts',
+          '**/*.test.ts',
+          '**/*.spec.ts',
+        ]);
       });
     });
 
@@ -902,6 +908,7 @@ describe('lib', () => {
         expect(tsConfigLibJson.exclude).toEqual([
           'src/test-setup.ts',
           '**/*.spec.ts',
+          'jest.config.ts',
           '**/*.test.ts',
         ]);
 
@@ -916,6 +923,7 @@ describe('lib', () => {
         expect(tsConfigLibJson2.exclude).toEqual([
           'src/test-setup.ts',
           '**/*.spec.ts',
+          'jest.config.ts',
           '**/*.test.ts',
         ]);
 
@@ -933,6 +941,7 @@ describe('lib', () => {
         expect(tsConfigLibJson3.exclude).toEqual([
           'src/test-setup.ts',
           '**/*.spec.ts',
+          'jest.config.ts',
           '**/*.test.ts',
         ]);
       });

diff --git a/packages/jest/migrations.json b/packages/jest/migrations.json
@@ -53,6 +53,12 @@
       "cli": "nx",
       "description": "Update to export default in jest config and revert jest.preset.ts to jest.preset.js",
       "factory": "./src/migrations/update-14-1-5/update-exports-jest-config"
+    },
+    "exclude-jest-config-from-ts-config": {
+      "version": "14.5.5-beta.0",
+      "cli": "nx",
+      "description": "Exclude jest.config.ts from tsconfig where missing.",
+      "factory": "./src/migrations/update-14-0-0/update-jest-config-ext"
     }
   },
   "packageJsonUpdates": {

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
@@ -20,6 +20,43 @@ module.exports = {
 "
 `;
 
+exports[`Jest Migration (v14.0.0) should produce the same results when running multiple times 1`] = `
+Object {
+  "files": Array [
+    "*.ts",
+    "*.tsx",
+    "*.js",
+    "*.jsx",
+  ],
+  "parserOptions": Object {
+    "project": Array [
+      "libs/my-next-proj/tsconfig.*?.json",
+    ],
+  },
+  "rules": Object {},
+}
+`;
+
+exports[`Jest Migration (v14.0.0) should produce the same results when running multiple times 2`] = `
+"/* eslint-disable */
+
+module.exports = {
+  displayName: 'lib-one',
+  preset: '../../jest.preset.js',
+  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 rename project jest.config.js to jest.config.ts 1`] = `
 "/* eslint-disable */
 

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
@@ -220,4 +220,79 @@ describe('Jest Migration (v14.0.0)', () => {
     const tsconfigSpec = readJson(tree, 'libs/lib-one/tsconfig.spec.json');
     expect(tsconfigSpec.exclude).toEqual(['node_modules']);
   });
+
+  it('should produce the same results when running multiple times', async () => {
+    await libSetUp(tree);
+    updateJson(tree, 'libs/lib-one/tsconfig.lib.json', (json) => {
+      json.exclude = ['**/*.spec.ts'];
+      return json;
+    });
+    updateJson(tree, 'libs/lib-one/tsconfig.spec.json', (json) => {
+      json.include = ['**/*.spec.ts'];
+      return json;
+    });
+
+    await setupNextProj(tree);
+
+    const esLintJson = readJson(tree, 'libs/my-next-proj/.eslintrc.json');
+    // make sure the parserOptions are set correctly for next
+    expect(esLintJson.overrides[0]).toMatchSnapshot();
+
+    await updateJestConfigExt(tree);
+
+    assertNextProj(tree);
+    assertLib(tree);
+
+    await updateJestConfigExt(tree);
+
+    assertNextProj(tree);
+    assertLib(tree);
+
+    expect(tree.read('libs/lib-one/jest.config.ts', 'utf-8')).toMatchSnapshot();
+  });
 });
+
+async function setupNextProj(tree: Tree) {
+  await libSetUp(tree, {
+    ...setupDefaults,
+    libName: 'my-next-proj',
+    setParserOptionsProject: true,
+  });
+  const projectConfig = readProjectConfiguration(tree, 'my-next-proj');
+  projectConfig.targets['build'] = {
+    executor: '@nrwl/next:build',
+    options: {},
+  };
+  updateProjectConfiguration(tree, 'my-next-proj', projectConfig);
+  updateJson(tree, 'libs/my-next-proj/tsconfig.json', (json) => {
+    // simulate nextJS tsconfig;
+    json.exclude = ['node_modules'];
+    return json;
+  });
+}
+
+function assertNextProj(tree: Tree) {
+  expect(
+    readJson(tree, 'libs/my-next-proj/tsconfig.spec.json').exclude
+  ).toEqual(['node_modules']);
+  expect(
+    readJson(tree, 'libs/my-next-proj/tsconfig.spec.json').include
+  ).toEqual(expect.arrayContaining(['jest.config.ts']));
+}
+
+function assertLib(tree: Tree) {
+  expect(readJson(tree, 'libs/lib-one/tsconfig.json').exclude).toBeFalsy();
+  expect(readJson(tree, 'libs/lib-one/tsconfig.spec.json').exclude).toBeFalsy();
+  expect(readJson(tree, 'libs/lib-one/tsconfig.spec.json').include).toEqual([
+    '**/*.spec.ts',
+    'jest.config.ts',
+  ]);
+
+  expect(readJson(tree, 'libs/lib-one/tsconfig.lib.json').exclude).toEqual([
+    '**/*.spec.ts',
+    'jest.config.ts',
+  ]);
+  expect(readJson(tree, 'libs/lib-one/tsconfig.lib.json').include).toEqual([
+    '**/*.ts',
+  ]);
+}
diff --git a/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.ts b/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.ts
@@ -42,11 +42,13 @@ function updateTsConfig(tree: Tree, tsConfigPath: string) {
 function addEsLintIgnoreComments(tree: Tree, filePath: string) {
   if (tree.exists(filePath)) {
     const contents = tree.read(filePath, 'utf-8');
-    tree.write(
-      filePath,
-      `/* eslint-disable */
+    if (!contents.startsWith('/* eslint-disable */')) {
+      tree.write(
+        filePath,
+        `/* eslint-disable */
 ${contents}`
-    );
+      );
+    }
   }
 }
 
@@ -133,6 +135,11 @@ export async function updateJestConfigExt(tree: Tree) {
 
           if (tsConfig.references) {
             for (const { path } of tsConfig.references) {
+              // skip as editor.json should include everything anyway.
+              if (path.endsWith('tsconfig.editor.json')) {
+                continue;
+              }
+
               if (path.endsWith('tsconfig.spec.json')) {
                 const eslintPath = joinPathFragments(
                   projectConfig.root,