Skip to content

[Docs] Fix typo in changelog for dropped ErrorMap #4496

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

Merged
merged 1 commit into from
May 28, 2025

Conversation

valgaze
Copy link
Contributor

@valgaze valgaze commented May 23, 2025

Fixes a minor typo here that can potentially confuse folks migrating: https://zod.dev/v4/changelog?id=drops-errormap

image

Without specifying a min for the string in the example there is no issue code other than "invalid_type":
image

This comparison appears to be unintentional because the types '"invalid_type"' and '"too_small"' have no overlap.ts(2367)

image

tl;dr: tweak the example to specify a min for that string for the example to make sense and not cause type whining

z.string().min(5{
  error: (issue) => {
    if (issue.code === "too_small") {
      return `Value must be >${issue.minimum}`;
    }
  },
});

Summary by CodeRabbit

  • Documentation
    • Corrected the code example for error customization in Zod 4 to use the proper method for specifying custom error messages.

Copy link
Contributor

coderabbitai bot commented May 23, 2025

Walkthrough

This update corrects a code example in the documentation for Zod 4. The example now uses the proper method for customizing error messages by chaining .min() with options, instead of incorrectly passing options to the z.string() constructor.

Changes

File(s) Change Summary
packages/docs/content/v4/changelog.mdx Fixed the error customization example to use .min(5, { error: ... }) instead of z.string({})

Poem

In docs where code examples dwell,
A tiny tweak now rings the bell—
No more options in the string,
Use .min() now, let errors sing!
The docs are clear, the code is right,
Zod 4’s guidance shining bright.
📚✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 29aba82 and 42748ed.

📒 Files selected for processing (1)
  • packages/docs/content/v4/changelog.mdx (1 hunks)
🔇 Additional comments (1)
packages/docs/content/v4/changelog.mdx (1)

82-88: Now .min(5) makes "too_small" valid—awesome fix!
This snippet accurately reflects Zod 4’s API and resolves the previous TS mismatch by ensuring the "too_small" code is in scope.


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.

@colinhacks colinhacks merged commit bc15379 into colinhacks:main May 28, 2025
5 checks passed
timorthi pushed a commit to timorthi/zod that referenced this pull request Jun 3, 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