Skip to content

[fix] Throw on invalid browser options #6086

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

Merged
merged 2 commits into from
Aug 19, 2022
Merged

[fix] Throw on invalid browser options #6086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b56f2a0
[fix] Throw on invalid browser options
dummdidumm Aug 19, 2022
caf3300
typo
dummdidumm Aug 19, 2022
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
5 changes: 5 additions & 0 deletions .changeset/ten-gorillas-itch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': patch
---

Throw error if browser.hydrate is false and browser.router is true
13 changes: 13 additions & 0 deletions packages/kit/src/core/config/index.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,19 @@ test('fails if kit.appDir ends with slash', () => {
}, /^config\.kit\.appDir cannot start or end with '\/'. See https:\/\/kit\.svelte\.dev\/docs\/configuration$/);
});

test('fails if browser.hydrate is false and browser.router is true', () => {
assert.throws(() => {
validate_config({
kit: {
browser: {
hydrate: false,
router: true
}
}
});
}, /^config\.kit\.browser\.router cannot be true if config\.kit\.browser\.hydrate is false$/);
});

test('fails if paths.base is not root-relative', () => {
assert.throws(() => {
validate_config({
Expand Down
11 changes: 8 additions & 3 deletions packages/kit/src/core/config/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,14 @@ const options = object(
return input;
}),

browser: object({
hydrate: boolean(true),
router: boolean(true)
browser: validate({ hydrate: true, router: true }, (input, keypath) => {
const value = object({ hydrate: boolean(true), router: boolean(true) })(input, keypath);
if (!value.hydrate && value.router) {
throw new Error(
'config.kit.browser.router cannot be true if config.kit.browser.hydrate is false'
);
}
return value;
}),

csp: object({
Expand Down