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.

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

Extract slot prop types from $$Slots #273

Closed
marekdedic opened this issue Feb 6, 2023 · 4 comments
Closed

Extract slot prop types from $$Slots #273

marekdedic opened this issue Feb 6, 2023 · 4 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@marekdedic
Copy link
Contributor

Description

In sveltejs/eslint-plugin-svelte#347 I proposed a rule to require slots and their props to be typed. In this package, those types should be used if they're present.

An example of what currently doesn't work:

App.svelte:

<Component let:arrayProp={arrayValue}>
  {#each arrayValue.filter( (val) => val.length > 10 ) as val} <!-- HERE -->
    {val}
  {/each}
</Component>

Component.svelte:

<script lang="ts">
  interface $$Slots {
    default: { arrayProp: Array<string> };
  }
</script>

<slot arrayProp={["Hello", "World", "Hello World"]} />

Here, on the marked line, I get the eslint error @typescript-eslint/no-unsafe-call - I presume that's because the parser does not infer that arrayValue is of type Array<string> and leaves it as any...

@marekdedic marekdedic added the enhancement New feature or request label Feb 6, 2023
@marekdedic
Copy link
Contributor Author

Actually, in general, the parser should probably eventually support the whole RFC...

@ota-meshi ota-meshi added the help wanted Extra attention is needed label Mar 22, 2023
@zaporter-work
Copy link

zaporter-work commented May 25, 2024

I've also recently run into this.

However, I don't understand why this doesn't already work. It seems like the code is sound.

parser/converts/attrs.ts:buildLetDirectiveType generates:

  return `${String(componentName)}['$$slot_def'][${JSON.stringify(
    slotName,
  )}][${JSON.stringify(letName)}]`;

Which in your example should translate to Component['$$slot_def']["default"]["arrayProp"]

My LSP & my other svelte tools have no problems understanding the type of the let:xyz bind from a interface $$Slots {...}.

Does anyone know why this isn't working with eslint? I'd be happy to figure out how to fix this but I'm out of ideas right now.

EDIT: I understand that nothing is generated for $$Slots, but I don't understand why this code to type the let binding exists if there are no corresponding types that are generated

@ptrxyz
Copy link

ptrxyz commented Sep 17, 2024

I randomly stumbled into the same problem, coming from a different angle. My observation is, that this line won't work at all when the component is generic. I don't know how this could be fixed, the buildLetDirectiveType code would somehow have to infer the correct generics and put them to the output.

@marekdedic
Copy link
Contributor Author

Slots are deprecated in Svelte 5, closing.

@marekdedic marekdedic closed this as not planned Won't fix, can't repro, duplicate, stale Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants