feat: throw error on malformed tsconfig reference

[JounQin]

close #415

Summary by CodeRabbit

• New Features
  • Improved error handling now reports clear errors when an invalid TypeScript configuration is detected.
• Tests
  • Expanded test coverage to verify that malformed TypeScript configuration references trigger the appropriate error responses.
• Chores
  • Updated size limit for the file located at ./lib/index.js from "1.4kB" to "1.5kB".

[changeset-bot]

🦋 Changeset detected

Latest commit: 03c97f3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
eslint-import-resolver-typescript	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

This change introduces a new error handling feature for the package "eslint-import-resolver-typescript". A new regular expression constant (TSCONFIG_NOT_FOUND_REGEXP) is added to detect malformed tsconfig references. The resolver function now checks errors against this constant, throwing an error when a match is found. A new changeset entry documents the version bump and error handling update. Additionally, test files have been modified to cover this new behavior, including a new tsconfig.json with a non-existent reference and an updated unit test.

Changes

File(s)	Change Summary
.changeset/wise-singers-own.md	Added changeset record with a minor version bump and noted the new error throwing feature for malformed tsconfig references.
src/constants.ts	Added new constant TSCONFIG_NOT_FOUND_REGEXP with a regex matching "Tsconfig not found\b".
src/index.ts	Imported TSCONFIG_NOT_FOUND_REGEXP and updated unrsResolve to throw an error if the result error matches the regex.
tests/unit/malformed-reference/tsconfig.json, tests/unit/unit.spec.ts	Introduced a new tsconfig file simulating a malformed reference and updated test cases to verify the resolver throws an error for this scenario.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant R as unrsResolve()
    participant C as TSCONFIG_NOT_FOUND_REGEXP
    participant E as Error Handler

    U->>R: Call resolver function
    R->>R: Execute resolving logic
    R->>R: Check if result.error matches C
    alt Error matches malformed tsconfig
        R->>E: Throw new error with message
        E-->>U: Return error response
    else Error does not match
        R-->>U: Return normal result
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Throw error for a missing/malformed tsconfig reference (#415)	✅

Poem

Hi there, I'm a rabbit, leaping through the code,
Hopping on new tests, where errors are now bestowed.
A regex guard stands firm, catching tsconfig's slight flaw,
Ensuring every reference is found without a draw.
With code so crisp and tests so tight, I cheer with all my might! 🐰

---

📜 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 259c061 and 03c97f3.

📒 Files selected for processing (1)

• .size-limit.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .size-limit.json

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

• GitHub Check: Analyze (javascript)
• GitHub Check: Lint and Test with Node.js 18 on windows-latest
• GitHub Check: Lint and Test with Node.js 22 on windows-latest
• GitHub Check: Lint and Test with Node.js 20 on windows-latest
• GitHub Check: Lint and Test with Node.js 22 on windows-latest
• GitHub Check: Lint and Test with Node.js 18 on windows-latest
• GitHub Check: Lint and Test with Node.js 20 on windows-latest

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[Copilot]

Pull Request Overview

This PR introduces error handling for malformed tsconfig references by throwing an error when a tsconfig file isn’t found. The key changes include:

• Updating tests to include a new test case for a malformed tsconfig reference.
• Enhancing the resolver in src/index.ts to throw an error when the tsconfig is not found.
• Adding a new constant (TSCONFIG_NOT_FOUND_REGEXP) to define the expected error pattern.

Reviewed Changes

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

File	Description
tests/unit/unit.spec.ts	Adds tests for pnp functionality and malformed tsconfig handling.
src/index.ts	Checks error messages and throws an error when the tsconfig is missing.
src/constants.ts	Introduces a new regexp constant for matching tsconfig not found errors.

Files not reviewed (1)

• tests/unit/malformed-reference/tsconfig.json: Language not supported

Comments suppressed due to low confidence (1)

src/index.ts:54

• Rethrowing the error with a new Error(result.error) may lose context from the original error. Consider preserving the original error by using the Error's cause property (e.g., new Error(result.error, { cause: result.error })) if supported.

if (TSCONFIG_NOT_FOUND_REGEXP.test(result.error)) {

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/eslint-import-resolver-typescript@423

commit: 03c97f3

[github-actions]

size-limit report 📦

Path	Size
lib/index.js	1.41 KB (+3.75% 🔺)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.58%. Comparing base (ffb8ddf) to head (03c97f3).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #423      +/-   ##
==========================================
+ Coverage   57.41%   63.58%   +6.16%     
==========================================
  Files           6        6              
  Lines         364      368       +4     
  Branches       29       48      +19     
==========================================
+ Hits          209      234      +25     
+ Misses        155      134      -21     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.