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

Update Zod Generator - Fix Enum Imports #2069

Closed
wants to merge 1 commit into from

Conversation

adnanalbeda
Copy link

Since zod generated models file are all just types. So enum exports from models are also types only.

Accordinlgy, enum imports must also be types only.

This fixed issues for generated models when working with workspaces of pnpm monorepo and NextJS.

Enum exports from `models` are just types.
Accordinlgy, enum imports must also be types only.
This fixed issues for generated models with pnpm monorepo.
Copy link
Contributor

coderabbitai bot commented Apr 6, 2025

📝 Walkthrough

Walkthrough

The PR updates the addPreludeAndImports method of the ZodSchemaGenerator class by modifying the import statement for enums. The change adds the type keyword to the import, ensuring that TypeScript treats these enums as type-only entities rather than runtime values. The modification is localized to the import syntax and does not alter the overall logic or control flow of the code.

Changes

File(s) Change Summary
packages/schema/src/plugins/zod/generator.ts Modified the import statement in the addPreludeAndImports method to include the type keyword for enums, clarifying that they are type-only.

Possibly related PRs


📜 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 79197c6 and 7bf7ee3.

📒 Files selected for processing (1)
  • packages/schema/src/plugins/zod/generator.ts (1 hunks)
🔇 Additional comments (1)
packages/schema/src/plugins/zod/generator.ts (1)

367-369: Correct use of type-only enum import.
By adding the type keyword in the import statement, the generated enums are now clearly treated as types only. This change directly addresses the PR objective, ensuring that, in a pnpm monorepo and Next.js context, the enums don’t get included as runtime values. The implementation is clean and leverages the existing computePrismaClientImport function without side effects.

✨ 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. 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 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.

@ymc9
Copy link
Member

ymc9 commented Apr 7, 2025

Hi @adnanalbeda , thank you for making this PR!

Coincidentally, a related issue was filed for the same issue as well #2065. I think the problem is that enums need to be reexported from ".zenstack/models" as values too (instead of just as types), otherwise at runtime, accessing enum values will still fail even if typescript compilation succeeds.

I've made a separate PR to let ".zenstack/models" reexport all values from the original PrismaClient model (while keeping "models.d.ts" reexport ZenStack-modified Prisma types). I think it should be more robust than fixing the enum imports.

#2070

@adnanalbeda
Copy link
Author

Great, I tested your changes and it's working better than mine.

@ymc9
Copy link
Member

ymc9 commented Apr 7, 2025

Great, I tested your changes and it's working better than mine.

Thanks for confirming it! I'll merge and make a patch release today.

@adnanalbeda
Copy link
Author

#2070 fixed the issue by supporting referencing enum as values instead of types.

@adnanalbeda adnanalbeda closed this Apr 7, 2025
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