Skip to content

feat: fix accessors and support migration of accessors #13456

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 5 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/large-rules-hang.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

feat: fix accessors and support migration of accessors
10 changes: 9 additions & 1 deletion packages/svelte/src/compiler/migrate/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { get_rune } from '../phases/scope.js';
import { reset, reset_warning_filter } from '../state.js';
import { extract_identifiers } from '../utils/ast.js';
import { migrate_svelte_ignore } from '../utils/extract_svelte_ignore.js';
import { determine_slot } from '../utils/slot.js';
import { validate_component_options } from '../validate-options.js';

const regex_style_tags = /(<style[^>]+>)([\S\s]*?)(<\/style>)/g;
Expand Down Expand Up @@ -54,6 +53,8 @@ export function migrate(source) {
const analysis = analyze_component(parsed, source, combined_options);
const indent = guess_indent(source);

str.replaceAll(/(<svelte:options\s.*?\s?)accessors\s?/g, (_, $1) => $1);

for (const content of style_contents) {
str.overwrite(content[0], content[0] + style_placeholder.length, content[1]);
}
Expand Down Expand Up @@ -265,6 +266,13 @@ export function migrate(source) {
);
}

if (state.props.length > 0 && state.analysis.accessors) {
str.appendRight(
insertion_point,
`\n${indent}export {${state.props.reduce((acc, prop) => (prop.slot_name ? acc : `${acc}\n${indent}\t${prop.local},`), '')}\n${indent}}\n`
);
}

if (!parsed.instance && need_script) {
str.appendRight(insertion_point, '\n</script>\n\n');
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,10 @@ export function client_component(analysis, options) {
}
}

if (binding?.kind === 'prop' || binding?.kind === 'bindable_prop') {
return [getter, b.set(alias ?? name, [b.stmt(b.call(name, b.id('$$value')))])];
}

if (binding?.kind === 'state' || binding?.kind === 'raw_state') {
const value = binding.kind === 'state' ? b.call('$.proxy', b.id('$$value')) : b.id('$$value');
return [getter, b.set(alias ?? name, [b.stmt(b.call('$.set', b.id(name), value))])];
Expand Down
14 changes: 14 additions & 0 deletions packages/svelte/tests/migrate/samples/accessors/input.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<script lang="ts">
type $$Props = {
test: string;
}

export let count = 0;
export let stuff;
</script>

<button>
<slot name="cool" />
</button>

<svelte:options accessors immutable/>
29 changes: 29 additions & 0 deletions packages/svelte/tests/migrate/samples/accessors/output.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<script lang="ts">


interface Props {
test: string;
count?: number;
stuff: any;
cool?: import('svelte').Snippet;
}

let {
test,
count = 0,
stuff,
cool
}: Props = $props();

export {
test,
count,
stuff,
}
</script>

<button>
{@render cool?.()}
</button>

<svelte:options immutable/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ok, test } from '../../test';
import { flushSync } from 'svelte';

export default test({
html: `<p>0</p>`,

async test({ assert, target, instance }) {
const p = target.querySelector('p');
ok(p);
flushSync(() => {
instance.count++;
});
assert.equal(p.innerHTML, '1');
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script>
let { count=0 } = $props();

export {
count
}
</script>

<p>{count}</p>