v0.20.0

Features

• support component generics via the custom @generics tag

---

Currently, to define generics for a Svelte component, you must use generics attribute on the script tag. Note that this feature is experimental and may change in the future.

However, the generics attribute only works if using lang="ts"; the language server will produce an error if generics is used without specifying lang="ts".

<!-- This causes an error because `lang="ts"` must be used. -->
<script generics="Row extends DataTableRow = any"></script>

Because sveld is designed to support JavaScript-only usage as a baseline, the API design to specify generics uses a custom JSDoc tag @generics.

Signature:

/**
 * @generics {GenericParameter} GenericName
 */

Example

/**
 * @generics {Row extends DataTableRow = any} Row
 */

The generated TypeScript definition will resemble the following:

export default class Component<Row extends DataTableRow = any> extends SvelteComponentTyped<
  ComponentProps<Row>,
  Record<string, any>,
  Record<string, any>
> {}

v0.19.2

Fixes

• ComponentParser should remove carriage returns (Windows)

---

This package is now published with provenance.

v0.19.1

Fixes

• only print outFile when writing Markdown file (#110)
• upgrade svelte-preprocess and typescript to ameliorate peer dependency warning (#111)

v0.19.0

Breaking Changes

• if using Svelte 3, the generated TypeScript definitions now require version 3.55 or higher

Features

• support Svelte 4 in the generated TypeScript definitions (#109)

v0.18.1

Fixes

• allow data-* attributes for props forwarded to HTML elements for [email protected] compatibility (#106, 0d6e6ab)

v0.18.0

Breaking Changes

• remove sveltekit:* attributes from type definitions (ce06f35, #96)

Features

• support @slot tag descriptions for named slots (f2ad4aa, #100)
• support @event tag descriptions (0f04d91, #99)

v0.17.2

Fixes

• handle export {} in script block (50885b1, #93 contributed by @SevereCloud)

v0.17.1

Fixes

• use correct type for forwarded cut/copy/paste events (0dc6cf8, #92)

v0.17.0

Breaking Changes

• remove @required tag; directly infer if a prop is required (06997cf, #91)

  Input

  /**
    * @type {boolean}
    */
  export let prop;

  Output

  export interface InputProps {
    /**
    * @default undefined
    */
    prop: boolean;
  }

v0.16.1

Fixes

• additional_tags can be undefined (c6cd5a2, #90 contributed by @ethan-jones-vizio)