v0.4.0

Author: metonym

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0](https://github.com/IBM/carbon-icons-svelte/releases/tag/v0.4.0) - 2020-11-25
+
+- Output format for TypeScript definitions extends `SvelteComponent` instead of stubbing class internals used by the Svelte Language Server
+
+**Breaking Changes**
+
+- Requires svelte version 3.30 or greater
+
 ## [0.3.0](https://github.com/IBM/carbon-icons-svelte/releases/tag/v0.3.0) - 2020-11-25
 
 - Export component `typedefs` in TypeScript definitions

README.md

@@ -9,6 +9,8 @@ The purpose of this project is to make third party Svelte components and librari
 
 The core of this library is extracted from [carbon-components-svelte](https://github.com/IBM/carbon-components-svelte).
 
+**Note:** The generated TS definitions require [Svelte version 3.30](https://github.com/sveltejs/svelte/blob/master/CHANGELOG.md#3300) or greater.
+
 ---
 
 Given a Svelte file, sveld can infer basic prop types to generate TypeScript definitions compatible with the [Svelte Language Server](https://github.com/sveltejs/language-tools):
@@ -26,10 +28,13 @@ Given a Svelte file, sveld can infer basic prop types to generate TypeScript def
 </button>
 ```
 
+The generated definition extends the typed `SvelteComponent` interface.
+
 **Button.d.ts**
 
 ```ts
 /// <reference types="svelte" />
+import { SvelteComponent } from "svelte";
 
 export interface ButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
   /**
@@ -43,15 +48,7 @@ export interface ButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNam
   primary?: boolean;
 }
 
-export default class Button {
-  $$prop_def: ButtonProps;
-  $$slot_def: {
-    default: {};
-  };
-
-  $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
-  $on(eventname: string, cb: (event: Event) => void): () => void;
-}
+export default class Button extends SvelteComponent<ButtonProps, { click: WindowEventMap["click"] }, { default: {} }> {}
 ```
 
 Sometimes, inferring prop types is insufficient.
@@ -72,6 +69,7 @@ The accompanying JSDoc annotations would generate the following:
 
 ```ts
 /// <reference types="svelte" />
+import { SvelteComponent } from "svelte";
 
 export interface ButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
   /**
@@ -86,15 +84,7 @@ export interface ButtonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNam
   primary?: boolean;
 }
 
-export default class Button {
-  $$prop_def: ButtonProps;
-  $$slot_def: {
-    default: {};
-  };
-
-  $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
-  $on(eventname: string, cb: (event: Event) => void): () => void;
-}
+export default class Button extends SvelteComponent<ButtonProps, { click: WindowEventMap["click"] }, { default: {} }> {}
 ```
 
 ---

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sveld",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "Apache-2.0",
   "description": "Generate TypeScript definitions for your Svelte components.",
   "author": "Eric Liu (https://github.com/metonym)",