fix(zod): generate optional field as z.optional() rather than z.nullish() to be consistent with Prisma's typing

[ymc9]

Fixes #1378

[coderabbitai]

Walkthrough

Walkthrough

The update enhances the schema generation logic in the Zod utility by replacing .nullish() method calls with .optional(). This change aims to improve how optional fields and default values are handled in data models during schema compilation.

Changes

File Path	Change Summary
packages/schema/src/plugins/zod/utils/schema-gen.ts	Updated method calls from .nullish() to .optional()
packages/schema/src/utils/pkg-utils.ts	Refactored formatting for better readability and added semicolons
tests/regression/tests/issue-1378.test.ts	Added a new test file for issue 1378 with schema loading and validation tests

Assessment against linked issues

Objective	Addressed	Explanation
Zod schemas should use .optional() instead of .nullish() to represent optional fields (#1378)	✅

---

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:

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.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3b38311 and 17e91fe.

Files selected for processing (1)

• packages/schema/src/plugins/zod/utils/schema-gen.ts (1 hunks)

Additional comments not posted (2)

packages/schema/src/plugins/zod/utils/schema-gen.ts (2)

147-147: Ensure that the addition of .optional() here correctly handles fields with auth() in @default(). This change aligns with the PR's objective to treat such fields as optional rather than having a default value.

---

155-155: The addition of .optional() here is crucial for handling fields explicitly marked as optional in the data model. This change is consistent with the PR's goal to align Zod schema generation with Prisma's typing for optional fields.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17e91fe and 4de48c1.

Files selected for processing (3)

• packages/schema/src/plugins/zod/utils/schema-gen.ts (1 hunks)
• packages/schema/src/utils/pkg-utils.ts (5 hunks)
• tests/regression/tests/issue-1378.test.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• packages/schema/src/utils/pkg-utils.ts

Files skipped from review as they are similar to previous changes (1)

• packages/schema/src/plugins/zod/utils/schema-gen.ts

Additional comments not posted (1)

tests/regression/tests/issue-1378.test.ts (1)

3-46: Ensure the test case accurately reflects the changes made in the PR.