Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: load the tsconfig extends with the specific extension name #111

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ChenPt
Copy link

@ChenPt ChenPt commented Apr 19, 2024

support load the tsconfig extends like that The following code is shown

{
  "extends": "@tsconfig/node16/tsconfig.json",
  "compilerOptions": {
    "module": "CommonJS",
    "declaration": true,
  },
}

support for version@2

Summary by CodeRabbit

  • Refactor
    • Improved handling of extending TypeScript configuration files, specifically for extension patterns from node_modules.

Copy link

coderabbitai bot commented Apr 19, 2024

Walkthrough

The overarching change focuses on enhancing the loadTsConfig function in src/utils.ts to adeptly manage TypeScript configuration extensions, particularly those stemming from node_modules. This update ensures precise path handling, streamlining the configuration loading process.

Changes

File Change Summary
src/utils.ts Refactored loadTsConfig to handle TypeScript configuration extensions from node_modules.
package.json Added @tsconfig/node14 as a dev dependency.
test/fixtures/test-tsconfig/tsconfig... Introduced tsconfig.node.json extending settings for Node.js development from @tsconfig/node14.
test/utils.test.ts Added loading and assertion of tsConfig3 using a different tsconfig for Node environment.

🐇✨
In the garden of code, beneath the syntax trees,
A little rabbit tweaks the TypeScript leaves.
Paths now untangled, with a hop and a cheer,
Configs from node_modules, crystal clear.
So hop along now, let the new code deploy,
In the digital meadow, our rabbit's joy! 🌟
🐇✨


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f396e5f and 4e0ce5a.
Files selected for processing (4)
  • package.json (1 hunks)
  • src/utils.ts (1 hunks)
  • test/fixtures/test-tsconfig/tsconfig.node.json (1 hunks)
  • test/utils.test.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • test/fixtures/test-tsconfig/tsconfig.node.json
Files skipped from review as they are similar to previous changes (1)
  • src/utils.ts
Additional comments not posted (2)
package.json (1)

52-52: The addition of @tsconfig/node14 as a dev dependency is appropriate for supporting TypeScript configurations specific to Node.js version 14.

test/utils.test.ts (1)

224-227: The addition of the test case for tsConfig3 is well-implemented. It effectively verifies the new functionality by checking the strict and skipLibCheck properties of the loaded tsconfig.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

src/utils.ts Outdated Show resolved Hide resolved
@ChenPt
Copy link
Author

ChenPt commented Apr 19, 2024

fix the issuse #112

@fengmk2
Copy link
Member

fengmk2 commented Apr 22, 2024

能否增加一个单测,确保修复生效。

@ChenPt
Copy link
Author

ChenPt commented Apr 23, 2024

@fengmk2 好的,晚点我补个单测,并lint下代码

@ChenPt ChenPt force-pushed the fix-read-tsconfig-v2 branch from 59ddfb6 to 4e0ce5a Compare April 23, 2024 07:52
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@tsconfig/[email protected] None 0 2.36 kB typescript-deploys

View full report↗︎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ets执行时,tsconfig.json的extends里的内容没有被加载进来
2 participants