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.

Sign up for GitHub

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

Improve Zod error messages and user config error messages #12634

Merged
merged 13 commits into from
Dec 5, 2024
Merged

Improve Zod error messages and user config error messages #12634

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
541e4d1
Upstream Zod error map improvements from Starlight
delucis Dec 4, 2024
84fbe30
Update tests
delucis Dec 4, 2024
49dd376
Use Zod error map when validating user config
delucis Dec 4, 2024
bab3a8c
Update user config error formatting for error map
delucis Dec 4, 2024
94dcab6
Tweak colours
delucis Dec 4, 2024
f0aad56
Separate colour and indentation steps for clarity
delucis Dec 4, 2024
b6f17bc
Fix broken link to experimental flag documentation
delucis Dec 4, 2024
00ae858
Add changeset
delucis Dec 4, 2024
66674d6
Update tests
delucis Dec 4, 2024
7e8c299
Fix one more test
delucis Dec 4, 2024
ecc28a2
Use existing utility for bold and other Markdown formatting
delucis Dec 4, 2024
2c93b93
Extract codeRegex to top level
delucis Dec 4, 2024
2170904
Don’t dim text and tweak indentation
delucis Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update tests
  • Loading branch information
@delucis
delucis committed Dec 4, 2024
commit 66674d697efedec0f9288d6f057dd2de9a02e2f8
15 changes: 11 additions & 4 deletions packages/astro/test/units/config/config-validate.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ describe('Config Validation', () => {
assert.equal(
formattedError,
`[config] Astro found issue(s) with your configuration:
! site Expected string, received number.`,

! site Expected type "string", received "number"`,
);
});

Expand All @@ -38,8 +39,11 @@ describe('Config Validation', () => {
assert.equal(
formattedError,
`[config] Astro found issue(s) with your configuration:
! integrations.0 Expected object, received number.
! build.format Invalid input.`,

! integrations.0: Expected type "object", received "number"

! build.format: Did not match union.
> Expected "file" | "directory" | "preserve", received "invalid"`,
);
});

Expand Down Expand Up @@ -118,7 +122,10 @@ describe('Config Validation', () => {
process.cwd(),
).catch((err) => err);
assert.equal(configError instanceof z.ZodError, true);
assert.equal(configError.errors[0].message, 'Array must contain at least 1 element(s)');
assert.equal(
configError.errors[0].message,
'**i18n.locales.1.codes**: Array must contain at least 1 element(s)',
);
});

it('errors if the default locale is not in path', async () => {
Expand Down
Loading