sveld 0.19.2 → 0.20.0

package/README.md

@@ -122,6 +122,7 @@ export default class Button extends SvelteComponentTyped<
   - [@event](#event)
   - [@restProps](#restprops)
   - [@extends](#extends)
+  - [@generics](#generics)
   - [@component comments](#component-comments)
 - [Contributing](#contributing)
 - [License](#license)
@@ -147,11 +148,17 @@ This library adopts a progressively enhanced approach. Any property type that ca
 Install `sveld` as a development dependency.
 
 ```sh
-yarn add -D sveld
-# OR
+# npm
 npm i -D sveld
-# OR
+
+# pnpm
 pnpm i -D sveld
+
+# Bun
+bun i -D sveld
+
+# Yarn
+yarn add -D sveld
 ```
 
 ### Rollup
@@ -188,15 +195,15 @@ sveld({
 })
 ```
 
-The [integration](integration) folder contains example set-ups:
+The [tests/e2e](tests/e2e) folder contains example set-ups:
 
-- [single-export](integration/single-export): library that exports one component
-- [single-export-default-only](integration/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax
-- [multi-export](integration/multi-export): multi-component library without JSDoc annotations (types are inferred)
-- [multi-export-typed](integration/multi-export-typed): multi-component library with JSDoc annotations
-- [multi-export-typed-ts-only](integration/multi-export-typed-ts-only): multi-component library that only generates TS definitions
-- [glob](integration/glob): library that uses the glob strategy to collect/analyze \*.svelte files
-- [carbon](integration/carbon): full `carbon-components-svelte` example
+- [single-export](tests/e2e/single-export): library that exports one component
+- [single-export-default-only](tests/e2e/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax
+- [multi-export](tests/e2e/multi-export): multi-component library without JSDoc annotations (types are inferred)
+- [multi-export-typed](tests/e2e/multi-export-typed): multi-component library with JSDoc annotations
+- [multi-export-typed-ts-only](tests/e2e/multi-export-typed-ts-only): multi-component library that only generates TS definitions
+- [glob](tests/e2e/glob): library that uses the glob strategy to collect/analyze \*.svelte files
+- [carbon](tests/e2e/carbon): full `carbon-components-svelte` example
 
 ### CLI
 
@@ -496,6 +503,45 @@ export const secondary = true;
 import Button from "./Button.svelte";
 ```
 
+### `@generics`
+
+Currently, to define generics for a Svelte component, you must use [`generics` attribute](https://github.com/dummdidumm/rfcs/blob/bfb14dc56a70ec6ddafebf2242b8e1500e06a032/text/ts-typing-props-slots-events.md#generics) on the script tag. Note that this feature is [experimental](https://svelte.dev/docs/typescript#experimental-advanced-typings) 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"`.
+
+```svelte
+<!-- 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:
+
+```js
+/**
+ * @generics {GenericParameter} GenericName
+ */
+```
+
+Example
+
+```js
+/**
+ * @generics {Row extends DataTableRow = any} Row
+ */
+```
+
+The generated TypeScript definition will resemble the following:
+
+```ts
+export default class Component<Row extends DataTableRow = any> extends SvelteComponentTyped<
+  ComponentProps<Row>,
+  Record<string, any>,
+  Record<string, any>
+> {}
+```
+
 ### `@component` comments
 
 The Svelte Language Server supports component-level comments through the following syntax: `<!-- @component [comment] -->`.

package/lib/ComponentParser.d.ts

@@ -42,6 +42,7 @@ interface TypeDef {
     description?: string;
     ts: string;
 }
+type ComponentGenerics = [name: string, type: string];
 interface ComponentInlineElement {
     type: "InlineComponent";
     name: string;
@@ -61,6 +62,7 @@ export interface ParsedComponent {
     slots: ComponentSlot[];
     events: ComponentEvent[];
     typedefs: TypeDef[];
+    generics: null | ComponentGenerics;
     rest_props: RestProps;
     extends?: Extends;
     componentComment?: string;
@@ -80,6 +82,7 @@ export default class ComponentParser {
     private readonly slots;
     private readonly events;
     private readonly typedefs;
+    private readonly generics;
     private readonly bindings;
     constructor(options?: ComponentParserOptions);
     private static mapToArray;