sveld 0.13.1 → 0.13.2

package/CHANGELOG.md

@@ -5,10 +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).
 
-## Unreleased
+<!-- ## Unreleased
 
 - add isAccessor field to API
-- update Markdown writer to generate a separate table for accessors
+- update Markdown writer to generate a separate table for accessors -->
+
+## [0.13.2](https://github.com/carbon-design-system/sveld/releases/tag/v0.13.2) - 2022-02-10
+
+- do not wrap TS `@event` detail in `CustomEvent` if type contains `CustomEvent`
 
 ## [0.13.1](https://github.com/carbon-design-system/sveld/releases/tag/v0.13.1) - 2022-01-22
 

package/README.md

@@ -107,7 +107,8 @@ export default class Button extends SvelteComponentTyped<
 - [Approach](#approach)
 - [Usage](#usage)
   - [Installation](#installation)
-  - [Set-up with Rollup](#set-up-with-rollup)
+  - [Rollup](#rollup)
+  - [Node.js](#nodejs)
   - [CLI](#cli)
   - [Publishing to NPM](#publishing-to-npm)
 - [Available Options](#available-options)
@@ -118,14 +119,15 @@ export default class Button extends SvelteComponentTyped<
   - [@event](#event)
   - [@restProps](#restprops)
   - [@extends](#extends)
+  - [@component comments](#component-comments)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Approach
 
-sveld uses the Svelte compiler to statically analyze all Svelte components exported from a library to generate documentation that is useful for the end user.
+`sveld` uses the Svelte compiler to statically analyze Svelte components exported from a library to generate documentation useful to the end user.
 
-Extracted metadata:
+Extracted metadata include:
 
 - props
 - slots
@@ -133,7 +135,7 @@ Extracted metadata:
 - dispatched events
 - `$$restProps`
 
-This library adopts a progressively enhanced approach. Any property type that cannot be inferred (e.g. "hello" is a string) falls back to "any" to minimize incorrectly typed properties or signatures. To mitigate this, the library author can add JSDoc annotations to specify types that cannot be reliably inferred. This represents a progressively enhanced approach because JSDocs are comments that can be ignored by the compiler.
+This library adopts a progressively enhanced approach. Any property type that cannot be inferred (e.g., "hello" is a string) falls back to "any" to minimize incorrectly typed properties or signatures. To mitigate this, the library author can add JSDoc annotations to specify types that cannot be reliably inferred. This represents a progressively enhanced approach because JSDocs are comments that can be ignored by the compiler.
 
 The generated TypeScript definitions for a component extends the `SvelteComponentTyped` interface available in svelte version 3.31.
 
@@ -147,6 +149,8 @@ Install `sveld` as a development dependency.
 yarn add -D sveld
 # OR
 npm i -D sveld
+# OR
+pnpm i -D sveld
 ```
 
 ### Rollup
@@ -169,7 +173,19 @@ export default {
 };
 ```
 
-When building the library with Rollup, TypeScript definitions will be written to the `types` folder.
+When building the library with Rollup, TypeScript definitions will be written to the `types` folder by default.
+
+Use the `typesOptions.outDir` option to customize the output folder. 
+
+For example, specify the following for the output to be emitted to the `dist` folder:
+
+```diff
+sveld({
++  typesOptions: {
++    outDir: 'dist'
++  }
+})
+```
 
 The [integration](integration) folder contains example set-ups:
 
@@ -255,7 +271,7 @@ sveld({
 
 ### `@type`
 
-Without a `@type` annotation, sveld will infer the primitive type for a prop:
+Without a `@type` annotation, `sveld` will infer the primitive type for a prop:
 
 ```js
 export let kind = "primary";
@@ -318,7 +334,7 @@ export let authors = [];
 
 ### `@slot`
 
-Use the `@slot` tag for typing component slots.
+Use the `@slot` tag for typing component slots. Note that `@slot` is a non-standard JSDoc tag.
 
 Signature:
 
@@ -379,9 +395,9 @@ $: dispatch("button:key", { key });
 
 ### `@restProps`
 
-sveld can pick up inline HTML elements that `$$restProps` is forwarded to. However, it cannot infer the underlying element for instantiated components.
+`sveld` can pick up inline HTML elements that `$$restProps` is forwarded to. However, it cannot infer the underlying element for instantiated components.
 
-You can use the `@restProps` tag to explicitly define element tags that `$$restProps` is forwarded to.
+You can use the `@restProps` tag to specify the element tags that `$$restProps` is forwarded to.
 
 Signature:
 

package/lib/writer/writer-ts-definitions.js

@@ -134,9 +134,15 @@ function genSlotDef(def) {
         .join("\n");
 }
 function genEventDef(def) {
+    var createDispatchedEvent = function (detail) {
+        if (detail === void 0) { detail = ANY_TYPE; }
+        if (/CustomEvent/.test(detail))
+            return detail;
+        return "CustomEvent<".concat(detail, ">");
+    };
     return def.events
         .map(function (event) {
-        return "".concat(clampKey(event.name), ": ").concat(event.type === "dispatched" ? "CustomEvent<".concat(event.detail || ANY_TYPE, ">") : "WindowEventMap[\"".concat(event.name, "\"]"), ";");
+        return "".concat(clampKey(event.name), ": ").concat(event.type === "dispatched" ? createDispatchedEvent(event.detail) : "WindowEventMap[\"".concat(event.name, "\"]"), ";");
     })
         .join("\n");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sveld",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "license": "Apache-2.0",
   "description": "Generate TypeScript definitions for your Svelte components.",
   "main": "./lib/index.js",