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

feat: create Zod's default function for entity's booleans #1773

Merged
merged 2 commits into from
Oct 14, 2024

Conversation

Arkanii
Copy link
Contributor

@Arkanii Arkanii commented Oct 14, 2024

I'm using Superforms in my Svelte project and it use the default function from the Zod schema to fulfill the default value of the form.

It was not implemented for booleans in the Zod plugin, so here is my PR !

Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request introduce a new import for isBooleanLiteral in the schema-gen.ts file, allowing the getFieldSchemaDefault function to process boolean literals when determining default field values. This enhancement expands the function's capabilities, which previously only supported string and number literals. The overall structure of the code remains intact, ensuring that existing functionalities are preserved while adding support for boolean types.

Changes

File Path Change Summary
packages/schema/src/plugins/zod/utils/schema-gen.ts Added import for isBooleanLiteral and updated getFieldSchemaDefault to handle boolean literals.

Possibly related PRs

  • fix(zod): support @default for BigInt values #1486: This PR modifies the makeFieldSchema function in schema-gen.ts to handle default values for BigInt, indicating a shared focus on enhancing default value handling for different data types in the schema generation process.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between aae9b60 and 1c7157f.

📒 Files selected for processing (1)
  • packages/schema/src/plugins/zod/utils/schema-gen.ts (2 hunks)
🧰 Additional context used
🔇 Additional comments (3)
packages/schema/src/plugins/zod/utils/schema-gen.ts (3)

23-23: LGTM: Import statement addition is appropriate.

The addition of isBooleanLiteral to the import statement is consistent with the changes made in the getFieldSchemaDefault function. This import is necessary to support the new functionality for handling boolean literals in default values.


286-287: LGTM: Boolean literal handling is correctly implemented.

The addition of boolean literal handling in the getFieldSchemaDefault function is well-implemented and aligns with the PR objectives. This change enhances the function's capabilities to support default boolean values in Zod schemas, which is consistent with the existing handling of string and number literals. The implementation follows the established pattern and maintains the overall code structure.


23-23: Summary: Successful implementation of boolean literal handling for default values.

The changes made in this file successfully implement the handling of boolean literals for default values in Zod schemas. The addition of the isBooleanLiteral import and the corresponding logic in the getFieldSchemaDefault function enhance the schema generation capabilities without disrupting existing functionality. These modifications align well with the PR objectives and maintain the overall code structure and style.

Great job on implementing this feature!

Also applies to: 286-287


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:

‼️ 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
Copy link
Member

ymc9 commented Oct 14, 2024

Thank you for the fix @Arkanii ! It looks to me and I'll merge it after the CI passes. I'll be part of the upcoming 2.7 release.

@ymc9 ymc9 merged commit 383b8fe into zenstackhq:dev Oct 14, 2024
13 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