Skip to content

feat(v3): Migrate to Zod V4 and improve zod-utils #584

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

Draft
wants to merge 1 commit into
base: v3-main
Choose a base branch
from

Conversation

ntatoud
Copy link
Contributor

@ntatoud ntatoud commented May 21, 2025

Describe your changes

Some examples of the current vs new syntax proposal

// BEFORE
const nonEmptyString = zu.string.nonEmpty(zod.string());
// AFTER
const nonEmptyString = zu.string().nonEmpty();
// BEFORE
const email = zu.string.email(zod.string());
// AFTER
const email = zu.email().strict();
// BEFORE
const emailNullish = zu.string.emailNullish(zod.string());
// AFTER
const emailNullish = zu.email().strictNullish();
// BEFORE
const nonEmptyArray = zu.array.nonEmpty(z.string().array());
// AFTER
const nonEmptyArray = zu.array(zu.string()).nonempty();
// BEFORE
const nonEmptyNullableArray = zu.array.nonEmptyNullable(z.string().array());
// AFTER
const nonEmptyNullableArray = zu.array(zu.string()).nonEmptyNullable();

With Custom error message

// BEFORE
const withCustomMessages = zu.string.nonEmpty(
  z
    .string()
    .min(length, `Code is ${length} digits`)
    .max(length, `Code is ${length} digits`),
  {
    required_error: 'Code is required', // => Deprectated
  }
);
// AFTER
const withCustomMessages = zu
  .string()
  .min(length, `Code is ${length} digits`)
  .max(length, `Code is ${length} digits`)
  .nonEmpty({
    // Might be improved but this is from zod/v4 documentation
    error: (issue) => {
      if (issue.input === undefined) return `Code is required`;
    },
  });

Copy link

vercel bot commented May 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
start-ui ❌ Failed (Inspect) May 21, 2025 1:07pm
start-ui-web-restart ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2025 1:07pm

Copy link
Contributor

coderabbitai bot commented May 21, 2025

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

160 files out of 270 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ 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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

@ntatoud ntatoud changed the base branch from master to v3-main May 21, 2025 13:07
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
D Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

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.

1 participant