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

@zenstackhq/trpc : $Schema import compatibility update #1181

Merged
merged 16 commits into from
Mar 27, 2024

Conversation

jbruxelle
Copy link
Contributor

@jbruxelle jbruxelle commented Mar 27, 2024

πŸ†• Changes related to #1177

  1. Update trpc generated router $Schema import to use import * as instead of default import
  2. Generate test project routers

βœ… Tests ran successfully

Summary by CodeRabbit

  • Refactor
    • Updated import method for $Schema in the router schema generation process to enhance compatibility and maintainability.

Copy link
Contributor

coderabbitai bot commented Mar 27, 2024

Walkthrough

Walkthrough

The modification in question involves a technical adjustment in the way the $Schema is imported within the generateRouterSchemaImport function. Specifically, the import approach was altered from utilizing a default import method to employing a namespace import strategy. This change likely aims to enhance compatibility or consistency with the project's import patterns or to align with TypeScript's best practices for type importation.

Changes

File Change Summary
.../trpc/src/helpers.ts Changed $Schema import from default to namespace import.

Related issues

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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ac60a6a and e3add36.
Files ignored due to path filters (2)
  • packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/Post.router.ts is excluded by: !**/generated/**
  • packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/User.router.ts is excluded by: !**/generated/**
Files selected for processing (1)
  • packages/plugins/trpc/src/helpers.ts (1 hunks)
Additional comments: 1
packages/plugins/trpc/src/helpers.ts (1)
  • 241-241: The change to use a namespace import for $Schema aligns with the PR objectives and should improve compatibility and maintainability. Ensure that all usages of $Schema throughout the project are updated to reflect this new import methodology.

@jbruxelle jbruxelle changed the title Fix/issue 1177 @zenstackhq/trpc : $Schema import compatibility update Mar 27, 2024
@ymc9 ymc9 changed the base branch from main to dev March 27, 2024 16:25
@ymc9
Copy link
Member

ymc9 commented Mar 27, 2024

Thank you @jbruxelle . The change looks great! I'll merge and include it in the upcoming release around the end of this week.

@ymc9 ymc9 merged commit 10b492b into zenstackhq:dev Mar 27, 2024
3 checks passed
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.

2 participants