Skip to content

False-positive error in require-event-prefix for get* props #1413

@ai

Description

@ai

Description

Let’s ignore get* props in svelte/require-event-prefix rule.

I think component structure like this is pretty popular:

<script
  generics="Value extends { id: string }"
  lang="ts"
>
  import type { Snippet } from 'svelte'

  let {
    getHref,
    item,
    list
  }: {
    // ERROR: Component event name must start with "on". (eslint svelte/require-event-prefix)
    getHref: (value: Value) => string
    item: Snippet<[Value]>
    list: Value[]
  } = $props()
</script>

<ul>
  {#each list as i (i.id)}
    <li>
      <a href={getHref(i)}>
        {@render item(i)}
      </Clickable>
    </li>
  {/each}
</ul>

But svelte/require-event-prefix raise an error on getHref prop function. The rule think it could be an event listener and enforce on prefix.

I suggest fixing it by ignoring all props with get* prefix since they are definatelly not events.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions