feat: support tsconfig references #4689

sushruth · 2025-02-06T08:00:38Z

Summary

Fixes #1648 -

By actively checking if at least some files in the parsed tsconfig actually pass isTestFile() check.
If project references are found in the parsed tsconfig, we iterate over each reference until we find a config which has at least one file that passes isTestFile() check.
If we do not find any within references, we default to previous behavior.

Test plan

TODO

Does this PR introduce a breaking change?

Yes
No

Other information

ahnpnl · 2025-02-06T09:16:26Z

Would you pls add some tests for this change?

sushruth · 2025-02-06T21:35:26Z

@ahnpnl Absolutely. That is the reason I have left it in draft stage. Thanks.

sushruth · 2025-02-11T11:06:33Z

@ahnpnl I added an e2e test case covering the tsconfig project references scenario. Please check it out when you can. Thanks!

src/legacy/config/config-set.ts

sushruth · 2025-02-11T17:37:58Z

src/legacy/config/config-set.spec.ts

@@ -790,7 +790,6 @@ describe('_resolveTsConfig', () => {
      expect(conf.options.configFilePath).toBeUndefined()
      expect(findConfig).not.toHaveBeenCalled()
      expect(readConfig.mock.calls[0][0]).toBe('/foo/tsconfig.bar.json')
-      expect(parseConfig).not.toHaveBeenCalled()


this will now be called to find out if we there are project references in the tsconfig to check.

sushruth · 2025-02-11T17:38:05Z

src/legacy/config/config-set.spec.ts

@@ -918,7 +917,6 @@ describe('_resolveTsConfig', () => {

        const conf = cs.parsedTsConfig
        expect(conf.options.path).toBe(tscfgPathStub)
-        expect(findConfig).not.toHaveBeenCalled()


this will now be called to find out if we there are project references in the tsconfig to check.

Copilot

PR Overview

This PR implements support for tsconfig project references by enhancing the tsconfig resolution and parsing logic in the configuration module while adding additional Jest configuration files for ESM and CJS compatibility.

Updated configuration resolution in src/legacy/config/config-set.ts to recursively resolve tsconfig references.
Added new Jest configuration files for both compiler and transpiler modes with ESM and CJS support in the e2e/tsconfig-projects directory.
Updated tests in config-set.spec.ts and provided a minimal test and implementation for foo functionality.

Reviewed Changes

File	Description
e2e/tsconfig-projects/src/foo.spec.ts	Added basic test spec for foo.
e2e/tsconfig-projects/jest-compiler-esm.config.ts	Added Jest ESM configuration for compiler.
e2e/tsconfig-projects/jest-transpiler-esm.config.ts	Added Jest ESM configuration for transpiler.
e2e/tsconfig-projects/jest-compiler-cjs.config.ts	Added Jest CJS configuration for compiler.
e2e/tsconfig-projects/jest-transpiler-cjs.config.ts	Added Jest CJS configuration for transpiler.
src/legacy/config/config-set.ts	Refactored tsconfig resolution to support project references.
e2e/tsconfig-projects/src/foo.ts	Updated foo to be an exported function.
src/legacy/config/config-set.spec.ts	Adjusted tests in accordance with the new tsconfig resolution logic.

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

src/legacy/config/config-set.ts

coveralls · 2025-03-04T05:28:42Z

Pull Request Test Coverage Report for Build 13685876864

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

44 of 53 (83.02%) changed or added relevant lines in 1 file are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.1%) to 95.139%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/legacy/config/config-set.ts	44	53	83.02%

Totals
Change from base Build 13608443062:	-0.1%
Covered Lines:	4807
Relevant Lines:	4994

💛 - Coveralls

Through this change, we restrict the use of jest globals in the shared source file of the monorepo-app, while allowing them in test files.

Copilot

PR Overview

This PR adds support for tsconfig references, enabling the tool to resolve project references and verify test files across projects.

Implements logic to traverse tsconfig project references and validate files using the isTestFile() check.
Introduces several new Jest configuration files to support both ESM and CJS setups.
Adds a basic test and corresponding source file for the foo function.

Reviewed Changes

File	Description
e2e/tsconfig-projects/src/foo.spec.ts	Adds a basic test for the exported foo function.
e2e/tsconfig-projects/jest-compiler-esm.config.ts	Adds Jest configuration for ESM via compiler.
e2e/tsconfig-projects/jest-transpiler-esm.config.ts	Adds Jest configuration for ESM via transpiler.
e2e/tsconfig-projects/jest-compiler-cjs.config.ts	Adds Jest configuration for CJS via compiler.
e2e/tsconfig-projects/jest-transpiler-cjs.config.ts	Adds Jest configuration for CJS via transpiler.
e2e/tsconfig-projects/src/foo.ts	Exports the foo function.

Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

e2e/tsconfig-projects/src/foo.spec.ts:1

The new tsconfig references behavior is not explicitly covered by tests. Consider adding tests that exercise the traversal of project references and validate the isTestFile() check in a dedicated test file.

import { foo } from './foo'

sushruth · 2025-03-05T21:28:49Z

@kulshekhar Please review once. This supports typescript project references for ts-jest.

ahnpnl · 2025-03-07T05:03:08Z

Hi @sushruth would you pls sync with main due to a conflict? Thanks 🙏

…erence Co-authored-by: Copilot <[email protected]>

sonarqubecloud · 2025-03-15T21:09:29Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sushruth force-pushed the sushruth/feat-support-tsconfig-references branch 2 times, most recently from 3644197 to c2eee48 Compare February 6, 2025 08:27

sushruth mentioned this pull request Feb 6, 2025

Tests fail when using TypeScript project references #1648

Open

ahnpnl marked this pull request as ready for review February 6, 2025 09:15

ahnpnl requested a review from kulshekhar as a code owner February 6, 2025 09:15

ahnpnl marked this pull request as draft February 6, 2025 09:15

sushruth force-pushed the sushruth/feat-support-tsconfig-references branch from c2eee48 to daec5b7 Compare February 11, 2025 07:04

sushruth marked this pull request as ready for review February 11, 2025 11:05

sushruth commented Feb 11, 2025

View reviewed changes

src/legacy/config/config-set.ts Outdated Show resolved Hide resolved

sushruth commented Feb 11, 2025

View reviewed changes

ahnpnl requested a review from Copilot February 28, 2025 20:03

Copilot AI reviewed Feb 28, 2025

View reviewed changes

src/legacy/config/config-set.ts Outdated Show resolved Hide resolved

doc: update example for stricter globals using project references

d19aee3

Through this change, we restrict the use of jest globals in the shared source file of the monorepo-app, while allowing them in test files.

ahnpnl requested a review from Copilot March 5, 2025 12:05

Copilot AI reviewed Mar 5, 2025

View reviewed changes

ahnpnl previously approved these changes Mar 5, 2025

View reviewed changes

sushruth and others added 7 commits March 12, 2025 15:46

Merge branch 'kulshekhar:main' into main

bcf64da

feat: support tsconfig references

2ba46d1

fix: fixing early return issue + function rename

89b4647

fix: fixing tsconfig file read issue + variable renames

cd97416

test: added an e2e test for the project reference case

f148a0d

fix: fixing to pass existing test cases + fixing some tests

9baa753

[copilot] use ts util to get the actual tsconfig name for project ref…

d0d9136

…erence Co-authored-by: Copilot <[email protected]>

sushruth dismissed ahnpnl’s stale review via d0d9136 March 12, 2025 22:52

sushruth force-pushed the sushruth/feat-support-tsconfig-references branch from fe0fbb9 to d0d9136 Compare March 12, 2025 22:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support tsconfig references #4689

feat: support tsconfig references #4689

sushruth commented Feb 6, 2025 •

edited

Loading

ahnpnl commented Feb 6, 2025

sushruth commented Feb 6, 2025 •

edited

Loading

sushruth commented Feb 11, 2025

sushruth Feb 11, 2025

sushruth Feb 11, 2025

Copilot AI left a comment

coveralls commented Mar 4, 2025 •

edited

Loading

Copilot AI left a comment

sushruth commented Mar 5, 2025

ahnpnl commented Mar 7, 2025

sonarqubecloud bot commented Mar 15, 2025

feat: support tsconfig references #4689

Are you sure you want to change the base?

feat: support tsconfig references #4689

Conversation

sushruth commented Feb 6, 2025 • edited Loading

Summary

Test plan

Does this PR introduce a breaking change?

Other information

ahnpnl commented Feb 6, 2025

sushruth commented Feb 6, 2025 • edited Loading

sushruth commented Feb 11, 2025

sushruth Feb 11, 2025

Choose a reason for hiding this comment

sushruth Feb 11, 2025

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

coveralls commented Mar 4, 2025 • edited Loading

Pull Request Test Coverage Report for Build 13685876864

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

sushruth commented Mar 5, 2025

ahnpnl commented Mar 7, 2025

sonarqubecloud bot commented Mar 15, 2025

Quality Gate passed

sushruth commented Feb 6, 2025 •

edited

Loading

sushruth commented Feb 6, 2025 •

edited

Loading

coveralls commented Mar 4, 2025 •

edited

Loading