Skip to content

Commit 397b907

Browse files
committed
docs: remove unnecessary ESM Jest config examples
1 parent e2fd586 commit 397b907

8 files changed

Lines changed: 10 additions & 88 deletions

File tree

website/docs/getting-started/installation.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ import { setupZoneTestEnv } from 'jest-preset-angular/setup-env/zone/index.mjs';
4242
setupZoneTestEnv();
4343
```
4444

45-
Add the following section to your root Jest config
45+
Update `setupFilesAfterEnv` in your Jest config as following:
4646

47-
```ts title="jest.config.ts" tab={"label":"Jest config CJS"}
47+
```ts title="jest.config.ts"
4848
import type { Config } from 'jest';
4949
import presets from 'jest-preset-angular/presets';
5050

@@ -54,16 +54,6 @@ export default {
5454
} satisfies Config;
5555
```
5656

57-
```ts title="jest.config.ts" tab={"label":"Jest config ESM"}
58-
import type { Config } from 'jest';
59-
import presets from 'jest-preset-angular/presets';
60-
61-
export default {
62-
...presets.createEsmPreset(),
63-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
64-
} satisfies Config;
65-
```
66-
6757
Adjust your `tsconfig.spec.json` to be:
6858

6959
```json5 title="tsconfig.spec.json" tab={"label": "Tsconfig CJS"}

website/docs/getting-started/test-environment.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ setupZoneTestEnv({
5757

5858
- Update your Jest configuration:
5959

60-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
60+
```ts title="jest.config.ts"
6161
import type { Config } from 'jest';
6262
import presets from 'jest-preset-angular/presets';
6363

@@ -67,16 +67,6 @@ export default {
6767
} satisfies Config;
6868
```
6969

70-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
71-
import type { Config } from 'jest';
72-
import presets from 'jest-preset-angular/presets';
73-
74-
export default {
75-
...presets.createEsmPreset(),
76-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
77-
} satisfies Config;
78-
```
79-
8070
### `setupZonelessTestEnv(options)`
8171

8272
Configures a test environment that **DOESN'T** use `zone.js`, as described in [Angular experimental zoneless guide](https://angular.dev/guide/experimental/zoneless).

website/docs/getting-started/testbed-environment.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ setupZoneTestEnv({
5050

5151
- Update your Jest configuration:
5252

53-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
53+
```ts title="jest.config.ts"
5454
import type { Config } from 'jest';
5555
import presets from 'jest-preset-angular/presets';
5656

@@ -60,16 +60,6 @@ export default {
6060
} satisfies Config;
6161
```
6262

63-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
64-
import type { Config } from 'jest';
65-
import presets from 'jest-preset-angular/presets';
66-
67-
export default {
68-
...presets.createEsmPreset(),
69-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
70-
} satisfies Config;
71-
```
72-
7363
### `setupZonelessTestEnv(options)`
7464

7565
Configures an environment that **DOESN'T** use `zone.js`, as described in [Angular experimental zoneless guide](https://angular.dev/guide/experimental/zoneless).

website/docs/guides/angular-13+.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Starting from **v11.0.0**, `jest-preset-angular` introduces a few extra changes
2727

2828
- If one is using the default preset as following:
2929

30-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
30+
```ts title="jest.config.ts"
3131
import type { Config } from 'jest';
3232
import presets from 'jest-preset-angular/presets';
3333

@@ -36,15 +36,6 @@ export default {
3636
} satisfies Config;
3737
```
3838

39-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
40-
import type { Config } from 'jest';
41-
import presets from 'jest-preset-angular/presets';
42-
43-
export default {
44-
...presets.createEsmPreset(),
45-
} satisfies Config;
46-
```
47-
4839
there are no migration steps required
4940

5041
### Using ES Modules

website/versioned_docs/version-14.5/getting-started/installation.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ import { setupZoneTestEnv } from 'jest-preset-angular/setup-env/zone/index.mjs';
4242
setupZoneTestEnv();
4343
```
4444

45-
Add the following section to your root Jest config
45+
Update `setupFilesAfterEnv` in your Jest config as following:
4646

47-
```ts title="jest.config.ts" tab={"label":"Jest config CJS"}
47+
```ts title="jest.config.ts"
4848
import type { Config } from 'jest';
4949
import presets from 'jest-preset-angular/presets';
5050

@@ -54,16 +54,6 @@ export default {
5454
} satisfies Config;
5555
```
5656

57-
```ts title="jest.config.ts" tab={"label":"Jest config ESM"}
58-
import type { Config } from 'jest';
59-
import presets from 'jest-preset-angular/presets';
60-
61-
export default {
62-
...presets.createEsmPreset(),
63-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
64-
} satisfies Config;
65-
```
66-
6757
Adjust your `tsconfig.spec.json` to be:
6858

6959
```json5 title="tsconfig.spec.json" tab={"label": "Tsconfig CJS"}

website/versioned_docs/version-14.5/getting-started/test-environment.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ setupZoneTestEnv({
5757

5858
- Update your Jest configuration:
5959

60-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
60+
```ts title="jest.config.ts"
6161
import type { Config } from 'jest';
6262
import presets from 'jest-preset-angular/presets';
6363

@@ -67,16 +67,6 @@ export default {
6767
} satisfies Config;
6868
```
6969

70-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
71-
import type { Config } from 'jest';
72-
import presets from 'jest-preset-angular/presets';
73-
74-
export default {
75-
...presets.createEsmPreset(),
76-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
77-
} satisfies Config;
78-
```
79-
8070
### `setupZonelessTestEnv(options)`
8171

8272
Configures a test environment that **DOESN'T** use `zone.js`, as described in [Angular experimental zoneless guide](https://angular.dev/guide/experimental/zoneless).

website/versioned_docs/version-14.5/getting-started/testbed-environment.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ setupZoneTestEnv({
5050

5151
- Update your Jest configuration:
5252

53-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
53+
```ts title="jest.config.ts"
5454
import type { Config } from 'jest';
5555
import presets from 'jest-preset-angular/presets';
5656

@@ -60,16 +60,6 @@ export default {
6060
} satisfies Config;
6161
```
6262

63-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
64-
import type { Config } from 'jest';
65-
import presets from 'jest-preset-angular/presets';
66-
67-
export default {
68-
...presets.createEsmPreset(),
69-
setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
70-
} satisfies Config;
71-
```
72-
7363
### `setupZonelessTestEnv(options)`
7464

7565
Configures an environment that **DOESN'T** use `zone.js`, as described in [Angular experimental zoneless guide](https://angular.dev/guide/experimental/zoneless).

website/versioned_docs/version-14.5/guides/angular-13+.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Starting from **v11.0.0**, `jest-preset-angular` introduces a few extra changes
2727

2828
- If one is using the default preset as following:
2929

30-
```ts title="jest.config.ts" tab={"label": "Jest config CJS"}
30+
```ts title="jest.config.ts"
3131
import type { Config } from 'jest';
3232
import presets from 'jest-preset-angular/presets';
3333

@@ -36,15 +36,6 @@ export default {
3636
} satisfies Config;
3737
```
3838

39-
```ts title="jest.config.ts" tab={"label": "Jest config ESM"}
40-
import type { Config } from 'jest';
41-
import presets from 'jest-preset-angular/presets';
42-
43-
export default {
44-
...presets.createEsmPreset(),
45-
} satisfies Config;
46-
```
47-
4839
there are no migration steps required
4940

5041
### Using ES Modules

0 commit comments

Comments
 (0)