Skip to content

Jest.mergePreset: Fix compatibility with NodeNext #1481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .changeset/hip-ears-punch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
'skuba': patch
---

Jest.mergePreset: Fudge `Node16` and `NodeNext` module resolutions

This works around a `ts-jest` issue where test cases fail to run if your `moduleResolution` is set to a modern mode:

```json
{
"compilerOptions": {
"moduleResolution": "Node16 | NodeNext"
}
}
```

```console
error TS5110: Option 'module' must be set to 'Node16' when option 'moduleResolution' is set to 'Node16'.
error TS5110: Option 'module' must be set to 'NodeNext' when option 'moduleResolution' is set to 'NodeNext'.
```
5 changes: 5 additions & 0 deletions .changeset/slow-moons-matter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'skuba': patch
---

pkg: Exclude `jest/*.test.ts` files
33 changes: 28 additions & 5 deletions jest/transform.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const { defaults } = require('ts-jest/presets');
const { ModuleResolutionKind } = require('typescript');

const { tryParseTsConfig } = require('./tsConfig');

Expand All @@ -14,6 +15,29 @@ const TS_JEST_PATH = require.resolve(TS_JEST_NAME);

const maybeTsConfig = tryParseTsConfig();

const isolatedModules = maybeTsConfig?.options.isolatedModules ?? true;

const BROKEN_MODULE_RESOLUTIONS = new Set([
ModuleResolutionKind.Node16,
ModuleResolutionKind.NodeNext,
]);

/**
* Passing through `Node16` or `NodeNext` seems to break `ts-jest`.
*
* ```
* error TS5110: Option 'module' must be set to 'Node16' when option 'moduleResolution' is set to 'Node16'.
* error TS5110: Option 'module' must be set to 'NodeNext' when option 'moduleResolution' is set to 'NodeNext'.
* ```
*
* https://github.com/kulshekhar/ts-jest/issues/4198
*/
const tsconfig = BROKEN_MODULE_RESOLUTIONS.has(
maybeTsConfig?.options.moduleResolution,
)
? { tsconfig: { moduleResolution: 'Node' } }
: undefined;

// Rewrite `ts-jest` transformations using our resolved `TS_JEST_PATH`.
module.exports.transform = Object.fromEntries(
Object.entries(defaults.transform).map(([key, value]) => {
Expand All @@ -24,7 +48,8 @@ module.exports.transform = Object.fromEntries(
? [
TS_JEST_PATH,
{
isolatedModules: maybeTsConfig?.options.isolatedModules ?? true,
...tsconfig,
isolatedModules,
},
]
: value,
Expand All @@ -38,10 +63,8 @@ module.exports.transform = Object.fromEntries(
TS_JEST_PATH,
{
...value[1],
isolatedModules:
value[1]?.isolatedModules ??
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed some of this complexity because defaults.transform doesn't populate isolatedModules nor tsconfig. We can always update this in future if that changes.

maybeTsConfig?.isolatedModules ??
true,
...tsconfig,
isolatedModules,
},
]
: value,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
"files": [
"config/**/*",
"jest/**/*",
"jest/**/*.js",
"lib*/**/*.d.ts",
"lib*/**/*.js",
"lib*/**/*.js.map",
Expand Down