Skip to content

feat: remove $.unwrap calls from each block indexes #12640

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 3 commits into from
Jul 28, 2024
Merged

Conversation

Rich-Harris
Copy link
Member

See #12511 and #12530 for more context.

At present, we unnecessarily wrap each block indexes in unwrap:

{#each things as thing, i}
  <p>{i}: {thing.name}</p>
{/each}
$.each(node, 1, () => things, $.index, ($$anchor, thing, i) => {
  var p = root_1();
  var text = $.child(p);

  $.reset(p);
  $.template_effect(() => $.set_text(text, `${$.unwrap(i) ?? ""}: ${$.unwrap(thing).name ?? ""}`));
  $.append($$anchor, p);
});

We know that i is a number, here; $.unwrap(i) is unnecessary. In the case of a keyed block, we can use $.get(i). And in the rare case that a key function references the index, we can always just reference it (and the item) directly.

We shouldn't be using $.unwrap anyway because duck typing doesn't work (I guess we could faff around with a private symbol, but let's not) — this PR doesn't kill it off completely but it gets us part of the way there. Will work on that in a follow-up PR.

I didn't include a snapshot test, because when we remove unwrap from the codebase it'll no longer be necessary.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Jul 28, 2024

🦋 Changeset detected

Latest commit: abc87f4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

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

@Rich-Harris
Copy link
Member Author

going to self-merge this to unblock further work

@Rich-Harris Rich-Harris merged commit 7af0e60 into main Jul 28, 2024
9 checks passed
@Rich-Harris Rich-Harris deleted the remove-unwrap branch July 28, 2024 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant