Skip to content

Latest commit

 

History

History
259 lines (137 loc) · 9.91 KB

CHANGELOG.md

File metadata and controls

259 lines (137 loc) · 9.91 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.20.0 - 2024-04-20

Features

  • support component generics via the custom @generics tag

0.19.2 - 2024-04-08

Fixes

  • ComponentParser should remove carriage returns (Windows)

0.19.1 - 2023-10-17

Fixes

  • only print outFile when writing Markdown file
  • upgrade svelte-preprocess and typescript to ameliorate peer dependency warning

0.19.0 - 2023-07-19

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

0.18.1 - 2023-06-04

  • allow data-* attributes for props forwarded to HTML elements for [email protected] compatibility

0.18.0 - 2022-10-22

  • support @slot tag descriptions for named slots
  • support @event tag descriptions
  • remove sveltekit:* attributes from type definitions

0.17.2 - 2022-06-13

  • handle export {} in script block

0.17.1 - 2022-06-02

  • use correct type for forwarded cut/copy/paste events

0.17.0 - 2022-05-21

  • remove @required tag; directly infer if a prop is required

0.16.1 - 2022-05-20

  • additional_tags can be undefined

0.16.0 - 2022-05-19

  • support @required tag to denote required component props
  • support wildcard export in svelte entry point

0.15.3 - 2022-05-14

  • preserve JSDoc tags in prop comments

0.15.2 - 2022-05-13

  • dispatched event type without detail should default to null, not any

0.15.1 - 2022-05-01

  • function exported from <script context="module"> should be typed as functions, not types

0.15.0 - 2022-04-14

  • add jsonOptions.outDir option to emit JSON files for individual components
  • add sveltekit:reload attributes to props that extend a attributes

0.14.1 - 2022-04-09

  • svg $$restProps should extend the correct attributes

0.14.0 - 2022-04-09

  • add sveltekit:prefetch, sveltekit:noscroll attributes to props that extend a attributes
  • use type-only imports for SvelteComponentTyped and extended props

0.13.4 - 2022-02-26

  • use file name as module name if library only has a single default export

0.13.3 - 2022-02-13

  • component module exports should not be recognized as accessors

0.13.2 - 2022-02-10

  • do not wrap TS @event detail in CustomEvent if type contains CustomEvent

0.13.1 - 2022-01-22

  • return original entry point instead of resolved path in getSvelteEntry

0.13.0 - 2022-01-22

  • export sveld for programmatic usage
  • upgrade prettier, rollup, svelte, svelte-preprocess, typescript

0.12.1 - 2022-01-20

  • specify @default undefined for undefined prop values (i.e., let prop1; let prop2 = undefined)

0.12.0 - 2022-01-02

  • support props defined via renamed exports (i.e., let className; export { className as class })

0.11.1 - 2021-12-31

  • replace backslashes with forward slashes in COMPONENT_API.json filePath values

0.11.0 - 2021-12-16

  • support writing <!-- @component --> comments in Svelte components to TypeScript definitions

0.10.2 - 2021-08-29

  • tolerate slot spread syntax (<slot {...props} />) when parsing Svelte components

0.10.1 - 2021-08-28

  • include .svelte extension in index.d.ts exports

0.10.0 - 2021-08-28

  • use .svelte.d.ts for Svelte files in type definitions to enable direct imports

0.9.0 - 2021-08-28

  • omit @constant, @default notations for component accessors

0.8.3 - 2021-07-29

  • replace backslashes with slashes on Windows when reading Svelte files using the glob method

0.8.2 - 2021-07-11

  • write constant props as accessors in the SvelteComponentTyped interface

0.8.1 - 2021-07-10

  • type function declarations as accessors in the SvelteComponentTyped interface
  • omit module name from generated TypeScript class if it's the reserved keyword "default"
  • move typescript to direct dependencies

0.8.0 - 2021-06-17

  • use svelte-preprocess to preprocess TypeScript in Svelte files and remove style blocks

0.7.1 - 2021-02-20

  • only parse files with the .svelte file extension

0.7.0 - 2021-02-06

  • add a glob option to resolve Svelte files from entry file exports using fast-glob (default is false)

0.6.1 - 2021-01-09

  • use parsed exports to determine module name, Svelte source file path

0.6.0 - 2021-01-09

  • use acorn to parse/create TypeScript exports
  • use fast-glob to collect all *.svelte files from the Svelte source folder specified in package.json#svelte
  • format TS definitions using a prettier printWidth of 80 instead of 120

Breaking Changes

  • filePath in generated JSON output is relative instead of absolute (normalized using path.normalize)

0.5.0 - 2020-12-05

  • generate TypeScript definitions to use SvelteComponentTyped interface instead of SvelteComponent

Breaking Changes

  • Svelte version >=3.31 is required to use generated TypeScript definitions

0.4.2 - 2020-11-25

Fixes

  • account for : when clamping object keys

0.4.1 - 2020-11-25

Fixes

  • clamp slot/event keys in TypeScript definitions

0.4.1 - 2020-11-25

  • output format for TypeScript definitions extends SvelteComponent instead of stubbing class internals used by the Svelte Language Server

Breaking Changes

  • Svelte version >=3.30 is required to use generated TypeScript definitions

0.3.0 - 2020-11-25

  • export component typedefs in TypeScript definitions

0.2.1 - 2020-11-19

  • extend interface for empty props use case

0.2.0 - 2020-11-19

  • support @extends tag to extend imported component prop interfaces

0.1.0 - 2020-11-19

  • support @restProps tag
  • fix "undefined" event by checking if the event name is undefined

0.1.0-rc.5 - 2020-11-18

  • use package.json#svelte for the entry point to uncompiled Svelte source code

0.1.0-rc.4 - 2020-11-17

  • add rollup to dependencies

0.1.0-rc.3 - 2020-11-17

  • add svelte to dependencies

0.1.0-rc.2 - 2020-11-17

  • add cli.js to publishable files

0.1.0-rc.1 - 2020-11-17

  • enable CLI usage by wrapping Rollup plugin

0.1.0-rc.0 - 2020-11-16

  • initial release