Skip to content

feat: include rest props object name in error message #10868

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 4 commits into from
Mar 22, 2024
Merged

feat: include rest props object name in error message #10868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96e3fb6
tweak error message for readonly rest props
Rich-Harris Mar 22, 2024
0fda425
remove property in prod
Rich-Harris Mar 22, 2024
6a39559
Update packages/svelte/src/internal/client/reactivity/props.js
dummdidumm Mar 22, 2024
26d9ae0
Merge branch 'props-bindable-2' into props-bindable-2-error-message
dummdidumm Mar 22, 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
21 changes: 11 additions & 10 deletions packages/svelte/src/compiler/phases/3-transform/client/visitors/javascript-runes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,16 +220,17 @@ export const javascript_visitors_runes = {
}
} else {
// RestElement
declarations.push(
b.declarator(
property.argument,
b.call(
'$.rest_props',
b.id('$$props'),
b.array(seen.map((name) => b.literal(name)))
)
)
);
/** @type {import('estree').Expression[]} */
const args = [b.id('$$props'), b.array(seen.map((name) => b.literal(name)))];

if (state.options.dev) {
// include rest name, so we can provide informative error messages
args.push(
b.literal(/** @type {import('estree').Identifier} */ (property.argument).name)
);
}

declarations.push(b.declarator(property.argument, b.call('$.rest_props', ...args)));
}
}

Expand Down
16 changes: 8 additions & 8 deletions packages/svelte/src/internal/client/reactivity/props.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,18 @@ export function update_pre_prop(fn, d = 1) {
/**
* The proxy handler for rest props (i.e. `const { x, ...rest } = $props()`).
* Is passed the full `$$props` object and excludes the named props.
* @type {ProxyHandler<{ props: Record<string | symbol, unknown>, exclude: Array<string | symbol> }>}}
* @type {ProxyHandler<{ props: Record<string | symbol, unknown>, exclude: Array<string | symbol>, name?: string }>}}
*/
const rest_props_handler = {
get(target, key) {
if (target.exclude.includes(key)) return;
return target.props[key];
},
set(_, key) {
set(target, key) {
if (DEV) {
throw new Error(
`Cannot write to property '${String(key)}' of rest element of $props(). It is always readonly.`
);
throw new Error(`Rest element properties of $props() such as ${target.name}.${String(key)} are readonly`);
}

return false;
},
getOwnPropertyDescriptor(target, key) {
Expand All @@ -72,11 +71,12 @@ const rest_props_handler = {

/**
* @param {Record<string, unknown>} props
* @param {string[]} rest
* @param {string[]} exclude
* @param {string} [name]
* @returns {Record<string, unknown>}
*/
export function rest_props(props, rest) {
return new Proxy({ props, exclude: rest }, rest_props_handler);
export function rest_props(props, exclude, name) {
return new Proxy(DEV ? { props, exclude, name } : { props, exclude }, rest_props_handler);
}

/**
Expand Down