Allow jest.config.cts #14070

DerTimonius · 2023-04-13T10:46:46Z

Summary

This PR will allow loading jest.config.cts files for ESM projects like proposed in PR #14064 and issue #13118
Additionally, this PR will add fixtures and snapshots that should fix the tests.

Closes #14064

Test plan

mrazauskas · 2023-04-16T11:43:55Z

Good idea. These are the missing parts:

change log entry
some integration tests here (perhaps: to check that it works, and that type errors are reported as expected): https://github.com/facebook/jest/blob/main/e2e/__tests__/tsIntegration.test.ts
documentation should be altered here: https://github.com/facebook/jest/blob/15af9b3b6f53a4f2f2e39d328eb6ef9f46ba91c4/docs/Configuration.md?plain=1#L8

DerTimonius · 2023-04-17T15:50:02Z

@mrazauskas Thanks for the hints, I added some things now, please tell me if something is missing 🙂

mrazauskas · 2023-04-17T17:29:43Z

Thanks!

Did you try running these new e2e tests? To do so, you build the repo and run yarn test-ts --selectProjects ts-integration. It is passing on main, but if I checkout your branch few tests fail. They all have "CTS config" in their names.

CHANGELOG.md

DerTimonius · 2023-04-18T06:23:17Z

Interesting, I ran yarn test after writing the tests and did not get any errors. Will get into this later today!

DerTimonius · 2023-04-18T13:49:16Z

I investigated the failing tests and was able to recognize two separate issues:

I can't use imports
TS is not really working in those files. I tried a different strategy to import the Config type and got the following error:

"const config: Config.InitialOptions = {displayName: 'ts-object-config', verbose: true};\n" +
        '      ^^^^^^\n' +
        '\n' +
        'SyntaxError: Missing initializer in const declaration\n' +

I then tried to move it to the back using as Config.InitialOptions but this also did not work.

I don't have any idea how to solve this...

linux-foundation-easycla · 2023-04-29T15:30:48Z

The committers listed above are authorized under a signed CLA.

✅ login: DerTimonius / name: Timon Jurschitsch (faa4fff, 2e0088b, 19ade29, a5690d3, 80bbbf6, bf0e377, f528d35, a8cdf6d)
✅ login: SimenB / name: Simen Bekkhus (cddd949, b57de1f, 28e1b1e, a71fab1)

netlify · 2023-04-29T15:30:53Z

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`a71fab1`
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/6597ab59675f0c00087d55b7
😎 Deploy Preview	https://deploy-preview-14070--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.

DerTimonius · 2023-06-17T15:39:36Z

Still trying, but still really have no idea how to fix the issue that the .cts files appear not to be recognized as valid TypeScript...
Maybe some hints?

karlhorky · 2023-06-17T17:47:32Z

@DerTimonius can you post a new short summary about what the problem is?

From the error message and your conclusions above, it seems like the tests are not running .cts files as TypeScript - maybe as part of your summary, check into how the tests are running Jest? Maybe also useful would be to check if Jest works with .cts files outside of the testing environment.

Maybe @mrazauskas can assist...?

karlhorky · 2023-06-17T17:49:45Z

One thing that I can see without looking too deeply into it is that you have an export in your .cts file:

Since .cts is compiled to CommonJS, maybe you need to use the module.exports = {} format as you see in the other jest.config.cjs fixture:

jest/packages/jest-cli/src/init/__tests__/__fixtures__/has-jest-config-file-cjs/jest.config.cjs

Lines 1 to 8 in cddd949

    
           /** 
        
            * Copyright (c) Meta Platforms, Inc. and affiliates. 
        
            * 
        
            * This source code is licensed under the MIT license found in the 
        
            * LICENSE file in the root directory of this source tree. 
        
            */ 
        
           module.exports = {};

karlhorky · 2023-06-17T17:52:24Z

Ah no, I'm wrong about that, export keyword is just fine:

https://github.com/withastro/astro/blob/d2020c29cf285e699f92143a70ffa30a85122bb4/packages/integrations/svelte/src/editor.cts

DerTimonius · 2023-06-17T17:58:45Z

@karlhorky Sure. The issues I'm currently facing are solely in the new integration tests that were necessary to write.

Initially I got an error, telling me that I can't use import in the .cts files. I changed the type import, but I'm pretty sure that this is the first issue.
If I'm running the tests now I get the following error

"const config: Config.InitialOptions = {displayName: 'ts-object-config', verbose: true};\n" +
        '      ^^^^^^\n' +
        '\n' +
        'SyntaxError: Missing initializer in const declaration\n' +

It appears to me that the normal TypeScript code is not recognized as such - if I change the code to this:

const config = {displayName: 'ts-object-config', verbose: true} as Config.InitialOptions

I get almost a different error, telling me that as is an unknown token.

What I tried so far

I looked a bit in the TS docs regarding .cts files and found that maybe it is necessary to add "module": "NodeNext" to the tsconfig.json file. I then put it in the tsconfig of the e2e directory, but still got the same errors.
I then tried to adapt the tsconfig.json file in the root dir by adding "module": "NodeNext". The errors remained the same.
I then looked if maybe somewhere in the code the possibility for .cts files is missing and need to be added, but I'm not sure where this should be the case.

github-actions · 2023-09-15T18:14:02Z

This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.

SimenB · 2023-10-05T06:48:30Z

Hiya, sorry about the radio silence. Let's get this in 🙂

I tried to merge in main - the only conflict was in the changelog, but it seems like there might have been other changes causing test failures?

DerTimonius · 2023-10-05T13:00:18Z

Hi @SimenB
thanks for your response!
I had issues with the tests before, because the .cts files were not recognized as TS files - so typical TS syntax did throw errors. I will take a look into this later today, maybe there has been an update somewhere that solved this in some way?

DerTimonius · 2023-10-05T17:11:17Z

Still getting the same errors that I mentioned above (#14070 (comment))

I really don't get this error: writing TS code in a .cts file and it's not recognized...

github-actions · 2024-01-03T18:04:44Z

This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.

SimenB · 2024-01-04T14:14:07Z

packages/jest-config/src/readConfigFileAndSetRootDir.ts

@@ -26,7 +27,7 @@ import {
 export default async function readConfigFileAndSetRootDir(
  configPath: string,
 ): Promise<Config.InitialOptions> {
-  const isTS = configPath.endsWith(JEST_CONFIG_EXT_TS);
+  const isTS = configPath.endsWith(JEST_CONFIG_EXT_TS || JEST_CONFIG_EXT_CTS);


Suggested change

const isTS = configPath.endsWith(JEST_CONFIG_EXT_TS || JEST_CONFIG_EXT_CTS);

const isTS =

configPath.endsWith(JEST_CONFIG_EXT_TS) ||

configPath.endsWith(JEST_CONFIG_EXT_CTS);

@DerTimonius I think this is your issue - cts was never considered

oh man. you're right 🙈
implemented this change with the last commit and fixed the tests (all running locally! they did not before, so this is a huge improvement)

SimenB · 2024-01-04T16:06:10Z

nice! seems like we just need to fix packages/create-jest/src/__tests__/init.test.ts and it's good to go

DerTimonius · 2024-01-04T17:32:09Z

Hm, I don't know why the last check is failing. I did not remove the file in question: /home/runner/work/jest/jest/packages/jest-cli/src/init/__tests__/tsconfig.json

SimenB · 2024-01-05T02:34:56Z

packages/jest-cli/src/init/ have been moved to packages/create-jest - this is probably some remnant of that?

#14490

SimenB

thanks!

karlhorky · 2024-01-13T15:10:08Z

@SimenB @DerTimonius thanks for the PR, review and merge!

Look forward to trying this out in a release! Will this be a part of jest@29.8.0 or jest@30.0.0?

karlhorky · 2024-01-27T15:29:42Z

@SimenB if the next minor or major releases are still going to be pending for a while, what do you think of creating and publishing a new alpha release eg. jest@30.0.0-alpha.3?

karlhorky · 2024-02-20T11:25:04Z

Nice, this has been released in jest@30.0.0-alpha.3 🎉

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

github-actions · 2024-03-23T00:08:15Z

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.

Allow for jest.config.cts, add fixture and snapshots

faa4fff

facebook-github-bot added the cla signed label Apr 13, 2023

DerTimonius mentioned this pull request Apr 13, 2023

Allow jest.config.cts #14064

Closed

DerTimonius added 2 commits April 13, 2023 13:16

Remove unnecessary snapshot

2e0088b

Remove single line in array of file extensions

19ade29

karlhorky mentioned this pull request Apr 13, 2023

[Feature]: Support loading jest.config.ts as ESM #13118

Open

DerTimonius added 2 commits April 17, 2023 17:34

Add changelog entry, docs

a5690d3

Add integration test for .cts config files

80bbbf6

mrazauskas reviewed Apr 17, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Change type import for .cts files in integration tests

bf0e377

Merge branch 'main' into patch

cddd949

github-actions bot added the Stale label Sep 15, 2023

psychobolt mentioned this pull request Oct 4, 2023

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

Open

Merge branch 'main' into patch

b57de1f

SimenB removed the Stale label Oct 5, 2023

github-actions bot added the Stale label Jan 3, 2024

Merge branch 'main' into patch

28e1b1e

github-actions bot removed the Stale label Jan 4, 2024

SimenB force-pushed the patch branch from 5d8ca69 to 28e1b1e Compare January 4, 2024 14:12

SimenB reviewed Jan 4, 2024

View reviewed changes

implement suggested change, fix tests

f528d35

add missing files in test fixtures

a8cdf6d

remove unused files

a71fab1

SimenB approved these changes Jan 5, 2024

View reviewed changes

SimenB enabled auto-merge (squash) January 5, 2024 07:13

SimenB merged commit b6f27ab into jestjs:main Jan 5, 2024
73 checks passed

DerTimonius deleted the patch branch January 5, 2024 07:29

github-actions bot locked as resolved and limited conversation to collaborators Mar 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow jest.config.cts #14070

Allow jest.config.cts #14070

DerTimonius commented Apr 13, 2023 •

edited by SimenB

mrazauskas commented Apr 16, 2023

DerTimonius commented Apr 17, 2023

mrazauskas commented Apr 17, 2023

DerTimonius commented Apr 18, 2023

DerTimonius commented Apr 18, 2023

linux-foundation-easycla bot commented Apr 29, 2023 •

edited

netlify bot commented Apr 29, 2023 •

edited

DerTimonius commented Jun 17, 2023

karlhorky commented Jun 17, 2023 •

edited

karlhorky commented Jun 17, 2023

karlhorky commented Jun 17, 2023

DerTimonius commented Jun 17, 2023 •

edited

github-actions bot commented Sep 15, 2023

SimenB commented Oct 5, 2023

DerTimonius commented Oct 5, 2023

DerTimonius commented Oct 5, 2023

github-actions bot commented Jan 3, 2024

SimenB Jan 4, 2024

DerTimonius Jan 4, 2024

SimenB commented Jan 4, 2024

DerTimonius commented Jan 4, 2024

SimenB commented Jan 5, 2024 •

edited

SimenB left a comment

karlhorky commented Jan 13, 2024 •

edited

karlhorky commented Jan 27, 2024

karlhorky commented Feb 20, 2024

github-actions bot commented Mar 23, 2024

Allow jest.config.cts #14070

Allow jest.config.cts #14070

Conversation

DerTimonius commented Apr 13, 2023 • edited by SimenB

Summary

Test plan

mrazauskas commented Apr 16, 2023

DerTimonius commented Apr 17, 2023

mrazauskas commented Apr 17, 2023

DerTimonius commented Apr 18, 2023

DerTimonius commented Apr 18, 2023

linux-foundation-easycla bot commented Apr 29, 2023 • edited

netlify bot commented Apr 29, 2023 • edited

✅ Deploy Preview for jestjs ready!

DerTimonius commented Jun 17, 2023

karlhorky commented Jun 17, 2023 • edited

karlhorky commented Jun 17, 2023

karlhorky commented Jun 17, 2023

DerTimonius commented Jun 17, 2023 • edited

What I tried so far

github-actions bot commented Sep 15, 2023

SimenB commented Oct 5, 2023

DerTimonius commented Oct 5, 2023

DerTimonius commented Oct 5, 2023

github-actions bot commented Jan 3, 2024

SimenB Jan 4, 2024

Choose a reason for hiding this comment

DerTimonius Jan 4, 2024

Choose a reason for hiding this comment

SimenB commented Jan 4, 2024

DerTimonius commented Jan 4, 2024

SimenB commented Jan 5, 2024 • edited

SimenB left a comment

Choose a reason for hiding this comment

karlhorky commented Jan 13, 2024 • edited

karlhorky commented Jan 27, 2024

karlhorky commented Feb 20, 2024

github-actions bot commented Mar 23, 2024

DerTimonius commented Apr 13, 2023 •

edited by SimenB

linux-foundation-easycla bot commented Apr 29, 2023 •

edited

netlify bot commented Apr 29, 2023 •

edited

karlhorky commented Jun 17, 2023 •

edited

DerTimonius commented Jun 17, 2023 •

edited

SimenB commented Jan 5, 2024 •

edited

karlhorky commented Jan 13, 2024 •

edited