fix: ignore file from typechecking

[genu]

Generating the zod schemas in a project causes the schemas to be subject to typechecking.

There can be cases where the zod plugin adds an import which doens't end up being used. This raises typechecking errors.

I don't see a reason why these files need to be typechecked.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve the ZodSchemaGenerator class located in packages/schema/src/plugins/zod/generator.ts. A new comment has been added to the addPreludeAndImports method to suppress TypeScript checks using // @ts-nocheck. Despite this addition, the overall structure, method signatures, and error handling of the class remain unchanged, ensuring that the schema generation logic continues to function as before without any modifications to its core functionalities.

Changes

File	Change Summary
packages/schema/src/plugins/zod/generator.ts	Added // @ts-nocheck comment to the addPreludeAndImports method to suppress TypeScript checks. No other changes to methods or error handling.

Possibly related PRs

• fix(zod): createMany types shouldn't be generated when Prisma version doesn't support it #1434: Modifies the ZodSchemaGenerator class in packages/schema/src/plugins/zod/generator.ts, directly related to this PR.
• fix: generated code fails to compile when prisma's output path overlaps with zenstack #1765: Introduces a new property mode in the ZodSchemaGenerator class, relevant to the modifications in this PR.
• fix(zmodel): prefer to use triple-slash comments as ZModel documentation #1817: Focuses on documentation practices related to the ZModel framework, closely connected to schema generation.
• fix(json): false error when using typed json in multi-file schemas #1836: Addresses JSON typing issues in schemas, which may intersect with the schema generation processes discussed in this PR.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a003be9 and 05bcc93.

📒 Files selected for processing (1)

• packages/schema/src/plugins/zod/generator.ts (1 hunks)

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

• packages/schema/src/plugins/zod/generator.ts

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 resolve resolve all the CodeRabbit review comments.
• @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]

Hi @genu , thanks for making the PR. Is this the only error you see with the generated code? I'm thinking if we should actually prevent the error from being there.

[genu]

So far in my testing, that is the only error I see with the generated code.

Fixing the error would be resolve it, true.

Does type checking in these files have any benefit though?

[ymc9]

So far in my testing, that is the only error I see with the generated code.

Fixing the error would be resolve it, true.

Does type checking in these files have any benefit though?

The generated code is supposed to always pass typechecking 😄, but just in case there is a real problem, I think it's still nice for typescript compiler to catch it before failing at runtime ... what do you think?

[genu]

Hmm, well, my thought process is that this is generated code, so even if there are type issues, there is nothing that I would be able to do about it.

The type checks would maybe make more sense during testing on the zenstack side? 🤔

[ymc9]

Hmm, well, my thought process is that this is generated code, so even if there are type issues, there is nothing that I would be able to do about it.

The type checks would maybe make more sense during testing on the zenstack side? 🤔

Right, if it fails it's a zenstack bug. With a second thought, I think we can proceed with adding ts-nocheck first.

[ymc9]

Merging it now. Will include it in the next patch release. Thank you!