refactor: remove defaults and defaults-esm presets

BREAKING CHANGE - Use `createCjsPreset` as a replacement for `defaults` preset - Use `createEsmPreset` as a replacement for `defaults` preset
thymikee · Feb 28, 2025 · 75732d6 · 75732d6
1 parent 35819c9
commit 75732d6
Show file tree

Hide file tree

Showing 8 changed files with 4 additions and 216 deletions.
diff --git a/presets/defaults-esm/jest-preset.js b/presets/defaults-esm/jest-preset.js
diff --git a/presets/defaults/jest-preset.js b/presets/defaults/jest-preset.js
diff --git a/presets/index.d.ts b/presets/index.d.ts
@@ -1,23 +1,4 @@
 declare const _default: {
-    defaults: {
-        transformIgnorePatterns: string[];
-        transform: import('ts-jest').JestConfigWithTsJest['transform'];
-        testEnvironment: string;
-        moduleFileExtensions: string[];
-        snapshotSerializers: string[];
-    };
-    defaultsESM: {
-        extensionsToTreatAsEsm: string[];
-        moduleNameMapper: {
-            tslib: string;
-        };
-        transform: import('ts-jest').JestConfigWithTsJest['transform'];
-        transformIgnorePatterns: string[];
-        testEnvironment: string;
-        moduleFileExtensions: string[];
-        snapshotSerializers: string[];
-    };
-    defaultTransformerOptions: import('ts-jest').TsJestTransformerOptions;
     createCjsPreset: typeof import('../build/presets').createCjsPreset;
     createEsmPreset: typeof import('../build/presets').createEsmPreset;
 };

diff --git a/presets/index.js b/presets/index.js
@@ -1,30 +1,6 @@
 const ngJestPresets = require('../build/presets');
 
 module.exports = {
-    get defaults() {
-        console.warn(`
-            This preset is DEPRECATED and will be removed in the next major release.
-            Please use "createCjsPreset" function instead. See documentation at https://thymikee.github.io/jest-preset-angular/docs/getting-started/presets#createcjspresetoptions
-        `);
-
-        return ngJestPresets.defaultPreset;
-    },
-    get defaultsESM() {
-        console.warn(`
-            This preset is DEPRECATED and will be removed in the next major release.
-            Please use "createEsmPreset" function instead. See documentation at https://thymikee.github.io/jest-preset-angular/docs/getting-started/presets#createesmpresetoptions
-        `);
-
-        return ngJestPresets.defaultEsmPreset;
-    },
-    get defaultTransformerOptions() {
-        console.warn(`
-            These options are DEPRECATED and will be removed in the next major release.
-            Please use "createCjsPreset" or "createEsmPreset" function instead. See documentation at https://thymikee.github.io/jest-preset-angular/docs/getting-started/presets
-        `);
-
-        return ngJestPresets.defaultTransformerOptions;
-    },
     createCjsPreset: ngJestPresets.createCjsPreset,
     createEsmPreset: ngJestPresets.createEsmPreset,
 };
diff --git a/src/presets/__snapshots__/index.spec.ts.snap b/src/presets/__snapshots__/index.spec.ts.snap
@@ -2,25 +2,6 @@
 
 exports[`Jest presets should have the correct types which come from \`ts-jest\` 1`] = `
 "declare const _default: {
-    defaults: {
-        transformIgnorePatterns: string[];
-        transform: import('ts-jest').JestConfigWithTsJest['transform'];
-        testEnvironment: string;
-        moduleFileExtensions: string[];
-        snapshotSerializers: string[];
-    };
-    defaultsESM: {
-        extensionsToTreatAsEsm: string[];
-        moduleNameMapper: {
-            tslib: string;
-        };
-        transform: import('ts-jest').JestConfigWithTsJest['transform'];
-        transformIgnorePatterns: string[];
-        testEnvironment: string;
-        moduleFileExtensions: string[];
-        snapshotSerializers: string[];
-    };
-    defaultTransformerOptions: import('ts-jest').TsJestTransformerOptions;
     createCjsPreset: typeof import('../build/presets').createCjsPreset;
     createEsmPreset: typeof import('../build/presets').createEsmPreset;
 };
@@ -163,70 +144,3 @@ exports[`Jest presets should return jest config with ESM preset creator function
   ],
 }
 `;
-
-exports[`Jest presets should return the correct jest config with legacy preset config 1`] = `
-{
-  "moduleFileExtensions": [
-    "ts",
-    "html",
-    "js",
-    "json",
-    "mjs",
-  ],
-  "snapshotSerializers": [
-    "jest-preset-angular/build/serializers/html-comment",
-    "jest-preset-angular/build/serializers/ng-snapshot",
-    "jest-preset-angular/build/serializers/no-ng-attributes",
-  ],
-  "testEnvironment": "jsdom",
-  "transform": {
-    "^.+\\.(ts|js|mjs|html|svg)$": [
-      "jest-preset-angular",
-      {
-        "stringifyContentPathRegex": "\\.(html|svg)$",
-        "tsconfig": "<rootDir>/tsconfig.spec.json",
-      },
-    ],
-  },
-  "transformIgnorePatterns": [
-    "node_modules/(?!.*\\.mjs$)",
-  ],
-}
-`;
-
-exports[`Jest presets should return the correct jest config with legacy preset config 2`] = `
-{
-  "extensionsToTreatAsEsm": [
-    ".ts",
-  ],
-  "moduleFileExtensions": [
-    "ts",
-    "html",
-    "js",
-    "json",
-    "mjs",
-  ],
-  "moduleNameMapper": {
-    "tslib": "tslib/tslib.es6.js",
-  },
-  "snapshotSerializers": [
-    "jest-preset-angular/build/serializers/html-comment",
-    "jest-preset-angular/build/serializers/ng-snapshot",
-    "jest-preset-angular/build/serializers/no-ng-attributes",
-  ],
-  "testEnvironment": "jsdom",
-  "transform": {
-    "^.+\\.(ts|js|html|svg)$": [
-      "jest-preset-angular",
-      {
-        "stringifyContentPathRegex": "\\.(html|svg)$",
-        "tsconfig": "<rootDir>/tsconfig.spec.json",
-        "useESM": true,
-      },
-    ],
-  },
-  "transformIgnorePatterns": [
-    "node_modules/(?!tslib)",
-  ],
-}
-`;
diff --git a/src/presets/index.spec.ts b/src/presets/index.spec.ts
@@ -1,16 +1,9 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 
-import { defaultPreset, defaultEsmPreset, createCjsPreset, createEsmPreset } from './';
+import { createCjsPreset, createEsmPreset } from './';
 
 describe('Jest presets', () => {
-    test.each([defaultPreset, defaultEsmPreset])(
-        'should return the correct jest config with legacy preset config',
-        (preset) => {
-            expect(preset).toMatchSnapshot();
-        },
-    );
-
     it('should return jest config with CJS preset creator function without options', () => {
         expect(createCjsPreset()).toMatchSnapshot();
     });
@@ -35,7 +28,7 @@ describe('Jest presets', () => {
         ).toMatchSnapshot();
     });
 
-    test('should have the correct types which come from `ts-jest`', () => {
+    it('should have the correct types which come from `ts-jest`', () => {
         expect(fs.readFileSync(path.join(__dirname, '..', '..', 'presets/index.d.ts'), 'utf-8')).toMatchSnapshot();
     });
 });
diff --git a/src/presets/index.ts b/src/presets/index.ts
@@ -1,44 +1,2 @@
-import type { JestConfigWithTsJest, TsJestTransformerOptions } from 'ts-jest';
-
-import snapshotSerializers from '../serializers';
-
-const baseConfig: Pick<JestConfigWithTsJest, 'testEnvironment' | 'moduleFileExtensions' | 'snapshotSerializers'> = {
-    testEnvironment: 'jsdom',
-    moduleFileExtensions: ['ts', 'html', 'js', 'json', 'mjs'],
-    snapshotSerializers,
-};
-
-const defaultTransformerOptions: TsJestTransformerOptions = {
-    tsconfig: '<rootDir>/tsconfig.spec.json',
-    stringifyContentPathRegex: '\\.(html|svg)$',
-};
-
-const defaultPreset = {
-    ...baseConfig,
-    transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
-    transform: {
-        '^.+\\.(ts|js|mjs|html|svg)$': ['jest-preset-angular', defaultTransformerOptions],
-    },
-};
-
-const defaultEsmPreset = {
-    ...baseConfig,
-    extensionsToTreatAsEsm: ['.ts'],
-    moduleNameMapper: {
-        tslib: 'tslib/tslib.es6.js',
-    },
-    transform: {
-        '^.+\\.(ts|js|html|svg)$': [
-            'jest-preset-angular',
-            {
-                ...defaultTransformerOptions,
-                useESM: true,
-            },
-        ],
-    },
-    transformIgnorePatterns: ['node_modules/(?!tslib)'],
-};
-
-export { defaultPreset, defaultEsmPreset, defaultTransformerOptions };
 export { createCjsPreset } from './create-cjs-preset';
 export { createEsmPreset } from './create-esm-preset';
diff --git a/website/docs/getting-started/presets.md b/website/docs/getting-started/presets.md
@@ -119,35 +119,3 @@ export default {
   ...presetConfig,
 } satisfies Config;
 ```
-
-### Legacy presets
-
-:::warning
-
-`jest-preset-angular` **DON'T RECOMMEND** to use legacy presets because this approach is not flexible to configure Jest configuration.
-These legacy presets will be removed in the next major release and users are **HIGHLY RECOMMENDED** to migrate to use the above utility functions.
-
-:::
-
-| Preset name                                                        | Description                                                                                                                       |
-| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
-| `jest-preset-angular/presets/default`<br/>or `jest-preset-angular` | TypeScript, JavaScript and HTML files (`js`, `.ts`, `.html`) will be transformed by `jest-preset-angular` to **CommonJS** syntax. |
-| `jest-preset-angular/presets/defaults-esm`<br/>                    | TypeScript, JavaScript and HTML files (`js`, `.ts`, `.html`) will be transformed by `jest-preset-angular` to **ESM** syntax.      |
-
-#### Example
-
-```ts title="jest.config.ts" tab={"label": "TypeScript CJS"}
-import type { Config } from 'jest';
-
-export default {
-  preset: 'jest-preset-angular',
-} satisfies Config;
-```
-
-```ts title="jest.config.mts" tab={"label": "TypeScript ESM"}
-import type { Config } from 'jest';
-
-export default {
-  preset: 'jest-preset-angular/presets/defaults-esm',
-} satisfies Config;
-```