fix(testing): add eslint ignore comments for jest config properties

fixes: #10021
nrwl · Apr 28, 2022 · 7ed074d · 7ed074d
1 parent b381e38
commit 7ed074d
Show file tree

Hide file tree

Showing 13 changed files with 42 additions and 2 deletions.
diff --git a/e2e/node/src/node.test.ts b/e2e/node/src/node.test.ts
@@ -363,12 +363,14 @@ describe('nest libraries', function () {
                 displayName: '${nestlib}',
                 preset: '../../jest.preset.ts',
                 globals: {
+                  // eslint-disable-next-line @typescript-eslint/naming-convention
                   'ts-jest': {
                   tsconfig: '<rootDir>/tsconfig.spec.json',
                   },
                 },
                 testEnvironment: 'node',
                  transform: {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
                 '^.+\\.[tj]s$': 'ts-jest',
                 },
                 moduleFileExtensions: ['ts', 'js', 'html'],

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
@@ -5,6 +5,7 @@ exports[`jestProject --babelJest should generate proper jest.transform when --co
   displayName: 'lib1',
   preset: '../../jest.preset.ts',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]sx?$': ['@swc/jest', { jsc: { transform: { react: { runtime: 'automatic' } } } }]
   },
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
@@ -18,6 +19,7 @@ exports[`jestProject --babelJest should generate proper jest.transform when babe
   displayName: 'lib1',
   preset: '../../jest.preset.ts',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]sx?$': 'babel-jest'
   },
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
@@ -31,6 +33,7 @@ exports[`jestProject --babelJest should generate proper jest.transform when babe
   displayName: 'lib1',
   preset: '../../jest.preset.ts',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]s$': 'babel-jest'
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
@@ -45,13 +48,15 @@ exports[`jestProject --setup-file should have setupFilesAfterEnv and globals.ts-
   preset: '../../jest.preset.ts',
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
       stringifyContentPathRegex: '\\\\\\\\.(html|svg)$',
     }
   },
   coverageDirectory: '../../coverage/libs/lib1',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.(ts|mjs|js|html)$': 'jest-preset-angular'
   },
   transformIgnorePatterns: ['node_modules/(?!.*\\\\\\\\.mjs$)'],
@@ -69,6 +74,7 @@ exports[`jestProject should create a jest.config.ts 1`] = `
   displayName: 'lib1',
   preset: '../../jest.preset.ts',
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }

diff --git a/packages/jest/src/generators/jest-project/files-angular/jest.config.ts__tmpl__ b/packages/jest/src/generators/jest-project/files-angular/jest.config.ts__tmpl__
@@ -3,6 +3,7 @@ module.exports = {
   preset: '<%= offsetFromRoot %>jest.preset.ts',
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
       stringifyContentPathRegex: '\\.(html|svg)$',
@@ -11,6 +12,7 @@ module.exports = {
   testEnvironment: '<%= testEnvironment %>',<% } %>
   coverageDirectory: '<%= offsetFromRoot %>coverage/<%= projectRoot %>',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\.(ts|mjs|js|html)$': 'jest-preset-angular'
   },
   transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)']<% if(!skipSerializers) { %>,

diff --git a/packages/jest/src/generators/jest-project/files/jest.config.ts__tmpl__ b/packages/jest/src/generators/jest-project/files/jest.config.ts__tmpl__
@@ -3,12 +3,14 @@ module.exports = {
   preset: '<%= offsetFromRoot %>jest.preset<%= ext %>',<% if(setupFile !== 'none') { %>
   setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],<% } %><% if (transformer === 'ts-jest') { %>
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },<% } %><% if(testEnvironment) { %>
   testEnvironment: '<%= testEnvironment %>',<% } %><% if(skipSerializers){ %>
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     <% if (supportTsx){ %>'^.+\\.[tj]sx?$'<% } else { %>'^.+\\.[tj]s$'<% } %>: <% if (supportTsx && transformer === '@swc/jest') { %>['<%= transformer %>', { jsc: { transform: { react: { runtime: 'automatic' } } } }]<% } else { %>'<%= transformer %>'<% } %>
   },
   <% if (supportTsx) { %>moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],<% } else { %>moduleFileExtensions: ['ts', 'js', 'html'],<% } %><% } %>

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
@@ -1,15 +1,18 @@
 // 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 = {
+"/* eslint-disable @typescript-eslint/naming-convention */
+module.exports = {
   displayName: 'lib-one',
   
   globals: {
+    
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },
   transform: {
+    
     '^.+\\\\\\\\.[tj]sx?$': 'ts-jest'
   },
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
@@ -19,15 +22,18 @@ exports[`Jest Migration (v14.0.0) should rename project jest.config.js to jest.c
 `;
 
 exports[`Jest Migration (v14.0.0) should update jest.config.ts preset to use the jest.preset.ts 1`] = `
-"module.exports = {
+"/* eslint-disable @typescript-eslint/naming-convention */
+module.exports = {
   displayName: 'lib-one',
   
   globals: {
+    
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },
   transform: {
+    
     '^.+\\\\\\\\.[tj]sx?$': 'ts-jest'
   },
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],

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
@@ -64,6 +64,14 @@ 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 @typescript-eslint/naming-convention */
+${contents}`);
+  }
+}
+
 function isJestConfigValid(tree: Tree, options: JestExecutorOptions) {
   const configExt = extname(options.jestConfig);
 
@@ -112,6 +120,7 @@ export async function updateJestConfigExt(tree: Tree) {
       }
 
       updateJestPreset(tree, options, projectName);
+      addEsLintIgnoreComments(tree, options.jestConfig);
 
       const newJestConfigPath = options.jestConfig.replace('.js', '.ts');
       tree.rename(options.jestConfig, newJestConfigPath);

diff --git a/packages/js/src/generators/library/files/jest-config/jest.config.__ext__ b/packages/js/src/generators/library/files/jest-config/jest.config.__ext__
@@ -10,6 +10,7 @@ module.exports = {
   displayName: '<%= project %>',
   preset: '<%= offsetFromRoot %>jest.preset.<%= ext %>',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\.[tj]s$': ['@swc/jest', swcJestConfig],
   },
   moduleFileExtensions: ['ts', 'js', 'html'],

diff --git a/packages/js/src/generators/library/library.spec.ts b/packages/js/src/generators/library/library.spec.ts
@@ -701,11 +701,13 @@ describe('lib', () => {
           displayName: 'my-lib',
           preset: '../../jest.preset.ts',
           globals: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             'ts-jest': {
               tsconfig: '<rootDir>/tsconfig.spec.json',
             }
           },
           transform: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             '^.+\\\\\\\\.[tj]s$': 'ts-jest'
           },
           moduleFileExtensions: ['ts', 'js', 'html'],

diff --git a/...src/generators/workspace-rules-project/__snapshots__/workspace-rules-project.spec.ts.snap b/...src/generators/workspace-rules-project/__snapshots__/workspace-rules-project.spec.ts.snap
@@ -87,11 +87,13 @@ exports[`@nrwl/linter:workspace-rules-project should generate the required files
   displayName: 'eslint-rules',
   preset: '../../jest.preset.ts',
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]s$': 'ts-jest'
   },
   moduleFileExtensions: ['ts', 'js', 'html'],

diff --git a/packages/nest/src/generators/library/__snapshots__/library.spec.ts.snap b/packages/nest/src/generators/library/__snapshots__/library.spec.ts.snap
@@ -5,11 +5,13 @@ exports[`lib --testEnvironment should set target jest testEnvironment to jsdom 1
   displayName: 'my-lib',
   preset: '../../jest.preset.ts',
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]s$': 'ts-jest'
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
@@ -23,12 +25,14 @@ exports[`lib --testEnvironment should set target jest testEnvironment to node by
   displayName: 'my-lib',
   preset: '../../jest.preset.ts',
   globals: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'ts-jest': {
       tsconfig: '<rootDir>/tsconfig.spec.json',
     }
   },
   testEnvironment: 'node',
   transform: {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     '^.+\\\\\\\\.[tj]s$': 'ts-jest'
   },
   moduleFileExtensions: ['ts', 'js', 'html'],

diff --git a/packages/node/src/generators/application/application.spec.ts b/packages/node/src/generators/application/application.spec.ts
@@ -379,6 +379,7 @@ describe('app', () => {
           preset: '../../jest.preset.ts',
           testEnvironment: 'node',
           transform: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             '^.+\\\\\\\\.[tj]s$': 'babel-jest'
           },
           moduleFileExtensions: ['ts', 'js', 'html'],

diff --git a/packages/node/src/generators/library/library.spec.ts b/packages/node/src/generators/library/library.spec.ts
@@ -467,6 +467,7 @@ describe('lib', () => {
           preset: '../../jest.preset.ts',
           testEnvironment: 'node',
           transform: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             '^.+\\\\\\\\.[tj]sx?$': 'babel-jest'
           },
           moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],

diff --git a/packages/web/src/generators/application/application.spec.ts b/packages/web/src/generators/application/application.spec.ts
@@ -426,6 +426,7 @@ describe('app', () => {
           preset: '../../jest.preset.ts',
           setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
           transform: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             '^.+\\\\\\\\.[tj]s$': 'babel-jest'
           },
           moduleFileExtensions: ['ts', 'js', 'html'],
@@ -448,6 +449,7 @@ describe('app', () => {
           preset: '../../jest.preset.ts',
           setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
           transform: {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
             '^.+\\\\\\\\.[tj]s$': '@swc/jest'
           },
           moduleFileExtensions: ['ts', 'js', 'html'],