Improve Zod errors #1542
Merged
Improve Zod errors #1542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: fa1cd88 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
size-limit report 📦
|
HiDeoo
reviewed
Feb 21, 2024
Includes support for setting custom snapshot serializers globally, see vitest-dev/vitest#5092
Co-Authored-By: HiDeoo <494699+HiDeoo@users.noreply.github.com>
Merged
HiDeoo
added a commit
to HiDeoo/starlight
that referenced
this pull request
Feb 26, 2024
* main: [ci] format [ci] release (withastro#1555) Update lockfile & patch version of EC to latest (withastro#1553) [ci] format [ci] release (withastro#1546) Improve Zod errors (withastro#1542) Update `astro-expressive-code` dependency to `^0.33.2` (withastro#1541) i18n(ja): Update pages.mdx (withastro#1551) i18n(es): update `plugins` (withastro#1548)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improves our Zod error map:
Better handling of unions.
Previously they logged only “Did not match union” and no further information.
An example of the new format:
Better formatting of expected values.
Stringified objects/arrays now have some whitespace around items, e.g.
{ "label": "Text" }instead of{"label":"Text"}. They are also now wrapped in code backticks so they render as code in Astro’s error screens.Better handling of deeply nested issues. (Thanks @HiDeoo!)
Union errors that were found deep in a schema previously only reported the top-level path, e.g.
sidebar.0. We are now able to show the full path, e.g.sidebar.0.items.1.Refactors all
safeParse()calls on Zod schemas to use a newparseWithFriendlyErrors()utility which bundles up our logic for throwing an error with the error map.When throwing errors, uses
AstroErrorfor nicer formatting:Testing error messages is improved with a Vitest custom snapshot serializer, which captures both the
messageand thehintfields onAstroError. I updated Vitest to 1.3 to be able to configure this for all tests in one place (this feature was added in feat(config): addsnapshotSerializersoption vitest-dev/vitest#5092).