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(trpc): make sure "import type" is used for type-only imports #1425

Merged
merged 1 commit into from
May 9, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented May 9, 2024

Fixes #1405

Copy link
Contributor

coderabbitai bot commented May 9, 2024

Walkthrough

Walkthrough

The recent updates in the tRPC plugin primarily involve adjustments to import declarations by eliminating the type keyword for specific entities and introducing the isTypeOnly: true flag for all named imports from the @trpc/server module. This change aligns with TypeScript's best practices for handling type-only imports to prevent runtime import errors.

Changes

File Change Summary
packages/.../generator.ts Removed type keyword and added isTypeOnly flag for imports from @trpc/server

Assessment against linked issues

Objective (Issue Number) Addressed Explanation
Type-only import for unsetMarker and related types (#1405)
Ensure correct import syntax under verbatimModuleSyntax (#1405) The suggested change in the issue was to use import type { ... }, but the summary indicates the use of isTypeOnly: true without specifying the exact import syntax change.

The changes address the main concern of importing types correctly to avoid runtime issues, but there might be a need to verify if the specific syntax (import type { ... }) mentioned in the issue was implemented.


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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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
Contributor

@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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5806a4d and 0cd2100.
Files selected for processing (1)
  • packages/plugins/trpc/src/generator.ts (1 hunks)
Additional comments not posted (4)
packages/plugins/trpc/src/generator.ts (4)

102-111: The changes to import these entities as type-only are correct and align with TypeScript's requirements for type-only imports.


Line range hint 14-45: The generate function is well-structured and handles its responsibilities correctly. Good job maintaining clean and readable code.


Line range hint 57-152: The createAppRouter function is correctly implemented and effectively manages the setup of the application router and dynamic model routers.


Line range hint 154-250: Both createClientHelpers and generateModelCreateRouter functions are implemented correctly and handle dynamic generation based on configurations effectively.

packages/plugins/trpc/src/generator.ts Show resolved Hide resolved
@ymc9 ymc9 merged commit 3b38311 into dev May 9, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1405 branch May 9, 2024 07:23
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.

1 participant