sveld 0.16.1 → 0.17.0

package/CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - add isAccessor field to API
 - update Markdown writer to generate a separate table for accessors -->
 
+## [0.17.0](https://github.com/carbon-design-system/sveld/releases/tag/v0.17.0) - 2022-05-21
+
+- remove `@required` tag; directly infer if a prop is required
+
 ## [0.16.1](https://github.com/carbon-design-system/sveld/releases/tag/v0.16.1) - 2022-05-20
 
 - `additional_tags` can be `undefined`

package/README.md

@@ -115,7 +115,6 @@ export default class Button extends SvelteComponentTyped<
 - [API Reference](#api-reference)
   - [@type](#type)
   - [@typedef](#typedef)
-  - [@required](#required)
   - [@slot](#slot)
   - [@event](#event)
   - [@restProps](#restprops)
@@ -351,36 +350,6 @@ export let author = {};
 export let authors = [];
 ```
 
-### `@required`
-
-By default, all props are typed as optional.
-
-Use the `@required` tag to denote a component prop as required.
-
-Example:
-
-```js
-/**
- * This prop is required
- * @required
- */
-export let isRequired = true;
-```
-
-TypeScript output:
-
-```ts
-export interface ComponentProps {
-  /**
-   * This prop is required
-   * @default true
-   */
-  isRequired: boolean;
-}
-```
-
-Because `@required` is non-standard JSDoc tag, it is omitted from the prop comment in the TypeScript definitions.
-
 ### `@slot`
 
 Use the `@slot` tag for typing component slots. Note that `@slot` is a non-standard JSDoc tag.

package/lib/ComponentParser.js

@@ -349,7 +349,7 @@ var ComponentParser = /** @class */ (function () {
                     var description_1 = undefined;
                     var isFunction = false;
                     var isFunctionDeclaration = false;
-                    var isRequired_1 = false;
+                    var isRequired = kind === "let" && init == null;
                     if (init != null) {
                         if (init.type === "ObjectExpression" ||
                             init.type === "BinaryExpression" ||
@@ -396,10 +396,7 @@ var ComponentParser = /** @class */ (function () {
                             description_1 = "";
                         }
                         additional_tags.forEach(function (tag) {
-                            isRequired_1 = tag.tag === "required";
-                            if (!isRequired_1) {
-                                description_1 += "".concat(description_1 ? "\n" : "", "@").concat(tag.tag, " ").concat(tag.name).concat(tag.description ? " ".concat(tag.description) : "");
-                            }
+                            description_1 += "".concat(description_1 ? "\n" : "", "@").concat(tag.tag, " ").concat(tag.name).concat(tag.description ? " ".concat(tag.description) : "");
                         });
                     }
                     if (!description_1 && _this.typedefs.has(type)) {
@@ -413,7 +410,7 @@ var ComponentParser = /** @class */ (function () {
                         value: value,
                         isFunction: isFunction,
                         isFunctionDeclaration: isFunctionDeclaration,
-                        isRequired: isRequired_1,
+                        isRequired: isRequired,
                         constant: kind === "const",
                         reactive: _this.reactive_vars.has(prop_name)
                     });

package/package.json

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