refactor: deprecate ngcc-jest-processor and replace with global set…

…up (#1275)

examples/example-app-v11/jest-esm.config.js

@@ -1,4 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
@@ -12,6 +11,7 @@ module.exports = {
       tsconfig: '<rootDir>/tsconfig-esm.spec.json',
     },
   },
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: {
     ...pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
     tslib: 'tslib/tslib.es6.js',

examples/example-app-v11/jest.config.js

@@ -1,10 +1,10 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
 };

examples/example-app-v12-monorepo/jest-esm.config.js

@@ -1,4 +1,5 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
+  globalSetup: 'jest-preset-angular/global-setup',
   projects: ['<rootDir>/projects/app1/jest-esm.config.js', '<rootDir>/projects/app2/jest-esm.config.js'],
 };

examples/example-app-v12-monorepo/jest.config.js

@@ -1,4 +1,5 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
+  globalSetup: 'jest-preset-angular/global-setup',
   projects: ['<rootDir>/projects/app1', '<rootDir>/projects/app2'],
 };

examples/example-app-v12-monorepo/projects/app1/jest-esm.config.js

@@ -1,5 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
-
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular/presets/defaults-esm',

examples/example-app-v12-monorepo/projects/app1/jest.config.js

@@ -1,5 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
-
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',

examples/example-app-v12-monorepo/projects/app2/jest-esm.config.js

@@ -1,5 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
-
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular/presets/defaults-esm',

examples/example-app-v12-monorepo/projects/app2/jest.config.js

@@ -1,5 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
-
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',

examples/example-app-v12/jest-esm.config.js

@@ -1,4 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
@@ -12,6 +11,7 @@ module.exports = {
       tsconfig: '<rootDir>/tsconfig-esm.spec.json',
     },
   },
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: {
     ...pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
     tslib: 'tslib/tslib.es6.js',

examples/example-app-v12/jest.config.js

@@ -1,10 +1,10 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
 };

examples/example-app-v13/jest-esm.config.js

@@ -1,4 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
@@ -12,6 +11,7 @@ module.exports = {
       tsconfig: '<rootDir>/tsconfig-esm.spec.json',
     },
   },
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: {
     ...pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
     tslib: 'tslib/tslib.es6.js',

examples/example-app-v13/jest.config.js

@@ -1,10 +1,10 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
 };

examples/example-app-yarn-workspace/packages/angular-app/jest-esm.config.js

@@ -1,4 +1,3 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
@@ -12,6 +11,7 @@ module.exports = {
       tsconfig: '<rootDir>/tsconfig-esm.spec.json',
     },
   },
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: {
     ...pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
     tslib: 'tslib/tslib.es6.js',

examples/example-app-yarn-workspace/packages/angular-app/jest.config.js

@@ -1,10 +1,10 @@
-require('jest-preset-angular/ngcc-jest-processor');
 const { pathsToModuleNameMapper } = require('ts-jest/utils');
 const { paths } = require('./tsconfig.json').compilerOptions;
 
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'jest-preset-angular',
+  globalSetup: 'jest-preset-angular/global-setup',
   moduleNameMapper: pathsToModuleNameMapper(paths, { prefix: '<rootDir>' }),
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
 };

global-setup.js

@@ -0,0 +1 @@
+module.exports = require('./build/config/global-setup');

ngcc-jest-processor.js

@@ -1 +1,11 @@
+console.warn(
+  'ng-jest-processor is deprecated and will be removed in the next major version v12.' +
+    ' Please use jest-preset-angular/global-setup in Jest config instead, e.g. \n' +
+    `
+    module.exports = {
+       globalSetup: 'jest-preset-angular/global-setup',
+    };
+  `
+);
+
 module.exports = require('./build/utils/ngcc-jest-processor');

scripts/test-examples.js

@@ -35,7 +35,15 @@ const executeTest = (projectPath) => {
   logger.log('installing bundled version of jest-preset-angular');
   logger.log();
 
-  ['build', 'presets', 'jest-preset.js', 'ngcc-jest-processor.js', 'package.json', 'setup-jest.js'].forEach((asset) => {
+  [
+    'build',
+    'presets',
+    'global-setup.js',
+    'jest-preset.js',
+    'ngcc-jest-processor.js',
+    'package.json',
+    'setup-jest.js',
+  ].forEach((asset) => {
     const assetToReplace = join(projectPath, 'node_modules', 'jest-preset-angular', asset);
     const assetToCopy = join(rootDir, asset);
     copySync(assetToCopy, assetToReplace);

src/config/global-setup.ts

@@ -0,0 +1,3 @@
+export = async () => {
+  await import('../utils/ngcc-jest-processor');
+};

src/utils/ngcc-jest-processor.ts

@@ -23,7 +23,7 @@ const nodeModuleDirPath = findNodeModulesDirectory();
 
 if (!process.argv.find((arg) => IGNORE_ARGS.includes(arg))) {
   if (nodeModuleDirPath) {
-    process.stdout.write('ngcc-jest-processor: running ngcc\n');
+    process.stdout.write('\nngcc-jest-processor: running ngcc\n');
     // We spawn instead of using the API because:
     // - NGCC Async uses clustering which is problematic when used via the API which means
     // that we cannot setup multiple cluster masters with different options.