fix: enabled extension of referenced configs

[mauriceackel]

This PR enables extension of referenced configs as explained in this issue: import-js/eslint-import-resolver-typescript#400

For reference, to for tsconfigs in the references field have not been post-processed (i.e. no resolution of "extends" keyword). This PR introduces the default load_config function for all referenced configs, which also ensures that extended configs will be loaded properly.

⚠️ I am not a RUST developer and the changes have been untested @JounQin, can you please take a look at this! The PR is allowed to be updated by maintainers.

---

Important

Enhances load_tsconfig in src/lib.rs to extend referenced TypeScript configs by resolving extends keyword.

• Behavior:
  • load_tsconfig in src/lib.rs now extends referenced TypeScript configs using extend_tsconfig and load_tsconfig_references.
  • Ensures extends keyword in tsconfigs is resolved.
• Functions:
  • New extend_tsconfig function to handle extending tsconfigs.
  • New load_tsconfig_references function to load references in tsconfigs.

^{This description was created by for 690aa39. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• Refactor
  • Improved internal structure for loading configuration files, resulting in clearer and more maintainable logic. No changes to user-facing functionality.

[coderabbitai]

Walkthrough

The logic within the load_tsconfig method of ResolverGeneric has been refactored by extracting the processes for handling "extends" and "references" into two new private methods: extend_tsconfig and load_tsconfig_references. The main method now calls these helpers in sequence, maintaining the original functionality.

Changes

File(s)	Change Summary
src/lib.rs	Refactored load_tsconfig by extracting "extends" logic into extend_tsconfig and "references" logic into load_tsconfig_references. Added both as private methods to the ResolverGeneric implementation.

Poem

In the warren of code, two paths did appear,
"Extends" and "references"—now crystal clear!
With helpers to guide, the logic’s refined,
Tsconfig’s a puzzle, no longer entwined.
Modular and neat, the burrow’s well swept—
This rabbit’s refactor is perfectly kept! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3acfa56 and f8a9f08.

📒 Files selected for processing (1)

• src/lib.rs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/lib.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Codacy Static Code Analysis

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/lib.rs (1)

1351-1372: Excellent implementation that addresses the core issue.

This method enables the extension of referenced tsconfigs by ensuring they go through the full load_tsconfig process, which includes extend_tsconfig. Key improvements:

• Self-reference check prevents direct cycles
• Referenced tsconfigs now have their "extends" processed (the main PR objective)
• Proper error handling and path normalization

Note: This prevents direct self-references but not indirect circular references (A→B→A). Consider if additional cycle detection is needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 395df2a and 690aa39.

📒 Files selected for processing (1)

• src/lib.rs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (2)

src/lib.rs (2)

1319-1329: LGTM! Clean refactoring that improves modularity.

The method maintains the original functionality while delegating to focused helper methods. The sequential order (extend first, then references) is correct.

---

1331-1349: Well-implemented extends processing.

The method correctly processes the extends chain by:

• Loading each extended tsconfig with references disabled (preventing recursion)
• Allowing extended configs to have their own extends processed
• Proper error propagation throughout the chain

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed everything up to 690aa39 in 2 minutes and 5 seconds. Click for details.

• Reviewed 94 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 3 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. src/lib.rs:1320

• Draft comment:
  Good extraction: the inline block for extending tsconfigs & loading references was nicely refactored into extend_tsconfig and load_tsconfig_references, improving readability and reducing duplication.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50% None

2. src/lib.rs:1348

• Draft comment:
  Ensure that the use of the root flag is correct: the original inline code used root: true when loading referenced tsconfigs, but the new load_tsconfig_references uses root: false. Confirm that this change in behavior is intentional.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 0% vs. threshold = 50% Looking at the code: 1. The change from root:true to root:false does appear to be a real change in behavior 2. However, this appears to be an intentional change, not an oversight: - The code was carefully refactored into a separate function - The root:false parameter is consistently used for all referenced tsconfigs - The original code may have had a bug by using root:true 3. The comment is asking for confirmation/explanation rather than pointing out a clear issue 4. Per the rules, we should not ask authors to confirm their intentions or explain changes The behavior change could potentially cause issues if root:true was actually needed for some reason. I may be missing some important context about why root:true was used originally. While the change could theoretically cause issues, there's no clear evidence that this is a bug rather than an intentional improvement. The rules state we should not ask authors to confirm their intentions. Delete the comment. It violates the rule against asking authors to confirm their intentions, and there's no clear evidence that the change is incorrect.

3. src/lib.rs:1348

• Draft comment:
  Consider adding doc comments to the new helper functions (extend_tsconfig and load_tsconfig_references) to clarify their purpose and usage.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

Workflow ID: wflow_bYOg1c0UqyzZs1Yo

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[JounQin]

@mauriceackel Thanks for this! Could you do better by adding a new test fixture under https://github.com/unrs/unrs-resolver/tree/main/fixtures/tsconfig and a new test case after the following?

unrs-resolver/src/tests/tsconfig_project_references.rs

Line 196 in 395df2a

fn self_reference() {

If you are not familiar with Rust, that's also OK, I'll do it myself later.

[codspeed-hq]

CodSpeed Performance Report

Merging #138 will not alter performance

_{Comparing mauriceackel:fix/extend-referenced-configs (f8a9f08) with main (6f3d3d4)}

Summary

✅ 3 untouched benchmarks

[mauriceackel]

@mauriceackel Thanks for this! Could you do better by adding a new test fixture under https://github.com/unrs/unrs-resolver/tree/main/fixtures/tsconfig and a new test case after the following?

unrs-resolver/src/tests/tsconfig_project_references.rs

Line 196 in 395df2a

fn self_reference() {

If you are not familiar with Rust, that's also OK, I'll do it myself later.

Unfortunately, I'm not 🙈 This was just a crude approach of implementing what I assume we need to fix this issue. If you could take it over from here, this would be highly appreciated @JounQin 💯

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
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

[JounQin]

A fix should start from a failing test case.

cf6de51 (#142)

[JounQin]

Thanks for inspiring me to work on a fix for that issue, and it spent me a whole night for me to find out the key: https://github.com/unrs/unrs-resolver/pull/142/files#diff-b1a35a68f14e696205874893c07fd24fdb88882b47c23cc0e0c80a30c7d53759R1348-R1351.