feat(jest-config):Support loading TS config files via docblock loader by k-rajat19 · Pull Request #15190 · jestjs/jest

k-rajat19 · 2024-07-15T06:34:47Z

Summary

Unblocks #13143
Unblocks #11989

Added support for loading Typescript configuration files by specifying a loader in a docblock comment in config file.
this is a continuation of work done in #13742
one can define a loader in a docblock comment like this:

/**@jest-config-loader ts-node(or esbuild-register)*/

import type {Config} from 'jest';

const config: Config = {
  verbose: true,
};

export default config;

if there is no loader defined it uses ts-node by default for loading a config file.
currently there is support for esbuild-register and ts-node.

Test plan

Added e2e tests

netlify · 2024-07-15T06:35:08Z

✅ Deploy Preview for jestjs ready!

Name	Link
🔨 Latest commit	`4d71390`
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/669f622d772cf40008556d1b
😎 Deploy Preview	https://deploy-preview-15190--jestjs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

SimenB · 2024-07-15T07:25:43Z

Thanks for sending a PR!

this PR also opt-out using ts-node by default which was initially set as a default loader for loading ts
configs (#13143 (comment))
So Jest will not do anything by default for loading ts configs, one has to define a loader in a docblock comment like this:

I think we should change default behaviour in a separate PR, just to keep the scope per PR down a bit

k-rajat19 · 2024-07-15T09:55:37Z

I think we should change default behaviour in a separate PR, just to keep the scope per PR down a bit

Should I update docs in a separate PR ? after current one and PR which changes default behaviour lands
or in this one according to current changes :)

SimenB · 2024-07-15T10:10:28Z

Updating the docs here with info about the docblock makes sense. Even though we might delete parts of the new docs when changing default behaviour 🙂

SimenB

looks good! just some nits 🙂

docs/Configuration.md

e2e/__tests__/readInitialOptions.test.ts

packages/jest-config/package.json

e2e/__tests__/readInitialOptions.test.ts

…to jest-config-ts

e2e/read-initial-options/async-config/jest.config.js

SimenB · 2024-07-17T05:33:49Z

packages/jest-config/src/readConfigFileAndSetRootDir.ts

 };

-let registeredCompilerPromise: Promise<Service>;
+let registeredCompilerPromise: Promise<TsLoader>;


I wonder if this needs to be a Map<TsLoaderModule, Promise<TsLoader>>? I'm thinking in cases where multi projects are used, and some project uses a different TS loader. That might already not work if the loaders get in the way of each other, tho.

Maybe a better thing would just be to save what module was loaded, and then throw an error if later another one is attempted to be used?

I have added integration tests for different loaders in different projects and they seem to be working fine d2c3a8d
do we still need to save the loader and doesn't allow using a different one?

SimenB · 2024-07-17T05:40:15Z

docs/Configuration.md

+export default config;
+```
+
+If you are using `ts-node`, you can set `JEST_CONFIG_TRANSPILE_ONLY` environment variable to `true` (case insensitive) to read configuration files without typechecking.


not for this PR, but maybe in a follow-up - should we drop this new env variable and use docblock config instead (like we support for test environment: https://jestjs.io/blog/2022/04/25/jest-28#inline-testenvironmentoptions)? Then people could also e.g. opt into using swc (https://typestrong.org/ts-node/docs/swc/)

that would be better, will send PR for that
we might also need to add support for swc based loader at some point #12156

k-rajat19 · 2024-07-18T07:22:41Z

packages/jest-config/src/readConfigFileAndSetRootDir.ts

+  const tsLoader = docblockPragmas['jest-config-loader'] || 'ts-node';
+
+  if (Array.isArray(tsLoader)) {
+    throw new TypeError(


This is not working when passing multiple loaders like this
/**@jest-config-loader ts-node esbuild-register*/ it simply returns a string 'ts-node esbuild-register' instead of returning an array of strings ['ts-node','esbuild-register']
is this an expected behavior or a bug in jest-docblock?

that's expected - for it to be an array you'd need to do

/** * @jest-config-loader ts-node * @jest-config-loader esbuild-register */

SimenB

great job, thanks!

SimenB · 2024-08-08T07:49:59Z

https://github.com/jestjs/jest/releases/tag/v30.0.0-alpha.6

github-actions · 2024-09-19T00:10:12Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

k-rajat19 and others added 3 commits July 15, 2024 00:57

load ts configs via loader

7f17fe2

more e2e tests

7dab201

add loader in 2e tests

7a9e2b1

k-rajat19 marked this pull request as draft July 15, 2024 06:39

k-rajat19 added 3 commits July 15, 2024 09:02

fix:set ts-node to default

dc23020

fix: failing checks

a729f80

Update Changelog

849f6b0

k-rajat19 marked this pull request as ready for review July 15, 2024 09:55

k-rajat19 and others added 3 commits July 15, 2024 10:46

Update docs

1bd881a

Update CHANGELOG.md

b9c6ee5

Update CHANGELOG.md

9cd57e8

SimenB requested changes Jul 16, 2024

View reviewed changes

docs/Configuration.md Outdated Show resolved Hide resolved

e2e/__tests__/readInitialOptions.test.ts Show resolved Hide resolved

packages/jest-config/package.json Outdated Show resolved Hide resolved

e2e/__tests__/readInitialOptions.test.ts Outdated Show resolved Hide resolved

k-rajat19 added 2 commits July 16, 2024 12:27

fix: requested changes

9747160

Merge branch 'jest-config-ts' of https://github.com/k-rajat19/jest in…

3c321f4

…to jest-config-ts

SimenB reviewed Jul 16, 2024

View reviewed changes

e2e/read-initial-options/async-config/jest.config.js Outdated Show resolved Hide resolved

k-rajat19 added 2 commits July 16, 2024 16:41

fix: tests

deea0d6

fix: passing 3rd arg in test.each

afb4509

SimenB reviewed Jul 17, 2024

View reviewed changes

e2e tests for different loaders and for unsupported loaders

d2c3a8d

k-rajat19 commented Jul 18, 2024

View reviewed changes

SimenB added 2 commits July 23, 2024 09:51

newlines

8b70b95

newlines

b05a5f5

SimenB approved these changes Jul 23, 2024

View reviewed changes

Merge branch 'main' into jest-config-ts

4d71390

SimenB enabled auto-merge (squash) July 23, 2024 07:56

SimenB merged commit 798d6c0 into jestjs:main Jul 23, 2024

k-rajat19 deleted the jest-config-ts branch July 23, 2024 08:33

k-rajat19 mentioned this pull request Aug 2, 2024

feat: allow passing TS config loader options #15234

Merged

SimenB mentioned this pull request Aug 9, 2024

[Bug]: jest ts-node ignores provided tsconfig.json #12952

Open

github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2024

Uh oh!

Conversation

k-rajat19 commented Jul 15, 2024 • edited by SimenB Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

netlify bot commented Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for jestjs ready!

Uh oh!

SimenB commented Jul 15, 2024

Uh oh!

k-rajat19 commented Jul 15, 2024

Uh oh!

SimenB commented Jul 15, 2024

Uh oh!

SimenB left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SimenB Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

k-rajat19 Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

SimenB Jul 17, 2024

Choose a reason for hiding this comment

Uh oh!

k-rajat19 Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

k-rajat19 Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SimenB Jul 21, 2024

Choose a reason for hiding this comment

Uh oh!

SimenB left a comment

Choose a reason for hiding this comment

Uh oh!

SimenB commented Aug 8, 2024

Uh oh!

github-actions bot commented Sep 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

k-rajat19 commented Jul 15, 2024 •

edited by SimenB

Loading

netlify bot commented Jul 15, 2024 •

edited

Loading

SimenB Jul 17, 2024 •

edited

Loading

k-rajat19 Jul 18, 2024 •

edited

Loading