sveld 0.11.0 → 0.13.0

package/CHANGELOG.md

@@ -10,6 +10,23 @@ 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.13.0](https://github.com/carbon-design-system/sveld/releases/tag/v0.13.0) - 2022-01-22
+
+- export `sveld` for programmatic usage
+- upgrade prettier, rollup, svelte, svelte-preprocess, typescript
+
+## [0.12.1](https://github.com/carbon-design-system/sveld/releases/tag/v0.12.1) - 2022-01-20
+
+- specify `@default undefined` for undefined prop values (i.e., `let prop1; let prop2 = undefined`)
+
+## [0.12.0](https://github.com/carbon-design-system/sveld/releases/tag/v0.12.0) - 2022-01-02
+
+- support props defined via renamed exports (i.e., `let className; export { className as class }`)
+
+## [0.11.1](https://github.com/carbon-design-system/sveld/releases/tag/v0.11.1) - 2021-12-31
+
+- replace backslashes with forward slashes in COMPONENT_API.json `filePath` values
+
 ## [0.11.0](https://github.com/carbon-design-system/sveld/releases/tag/v0.11.0) - 2021-12-16
 
 - support writing `<!-- @component -->` comments in Svelte components to TypeScript definitions

package/README.md

@@ -149,7 +149,7 @@ yarn add -D sveld
 npm i -D sveld
 ```
 
-### Set-up with Rollup
+### Rollup
 
 Import and add `sveld` as a plugin to your `rollup.config.js`.
 
@@ -194,9 +194,36 @@ Append `--json` or `--markdown` flags to generate documentation in JSON/Markdown
 npx sveld --json --markdown
 ```
 
+### Node.js
+
+You can also use `sveld` programmatically in Node.js.
+
+If no `input` is specified, `sveld` will infer the entry point based on the `package.json#svelte` field.
+
+```js
+const { sveld } = require("sveld");
+const pkg = require("./package.json");
+
+sveld({
+  input: "./src/index.js",
+  glob: true,
+  markdown: true,
+  markdownOptions: {
+    onAppend: (type, document, components) => {
+      if (type === "h1")
+        document.append("quote", `${components.size} components exported from ${pkg.name}@${pkg.version}.`);
+    },
+  },
+  json: true,
+  jsonOptions: {
+    outFile: "docs/src/COMPONENT_API.json",
+  },
+});
+```
+
 ### Publishing to NPM
 
-Specify the entry point for the TypeScript definitions in your `package.json`.
+TypeScript definitions are outputted to the `types` folder by default. Don't forget to include the folder in your `package.json` when publishing the package to NPM.
 
 ```diff
 {

package/lib/ComponentParser.d.ts

@@ -68,6 +68,7 @@ export default class ComponentParser {
     private extends?;
     private componentComment?;
     private readonly reactive_vars;
+    private readonly vars;
     private readonly props;
     private readonly slots;
     private readonly events;

package/lib/ComponentParser.js

@@ -27,6 +27,7 @@ var DEFAULT_SLOT_NAME = "__default__";
 var ComponentParser = /** @class */ (function () {
     function ComponentParser(options) {
         this.reactive_vars = new Set();
+        this.vars = new Set();
         this.props = new Map();
         this.slots = new Map();
         this.events = new Map();
@@ -148,7 +149,7 @@ var ComponentParser = /** @class */ (function () {
                             type: type,
                             name: name,
                             description: ComponentParser.assignValue(description),
-                            ts: /(\}|\};)$/.test(type) ? "interface " + name + " " + type : "type " + name + " = " + type
+                            ts: /(\}|\};)$/.test(type) ? "interface ".concat(name, " ").concat(type) : "type ".concat(name, " = ").concat(type)
                         });
                         break;
                 }
@@ -172,7 +173,7 @@ var ComponentParser = /** @class */ (function () {
         var _this = this;
         var _a;
         if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.verbose) {
-            process.stdout.write("[parsing] \"" + diagnostics.moduleName + "\" " + diagnostics.filePath + "\n");
+            process.stdout.write("[parsing] \"".concat(diagnostics.moduleName, "\" ").concat(diagnostics.filePath, "\n"));
         }
         this.cleanup();
         this.source = source;
@@ -183,7 +184,7 @@ var ComponentParser = /** @class */ (function () {
         var callees = [];
         (0, compiler_1.walk)(this.compiled.ast, {
             enter: function (node, parent, prop) {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
                 if (node.type === "CallExpression") {
                     if (node.callee.name === "createEventDispatcher") {
                         dispatcher_name = parent === null || parent === void 0 ? void 0 : parent.id.name;
@@ -201,9 +202,28 @@ var ComponentParser = /** @class */ (function () {
                         };
                     }
                 }
-                if (node.type === "ExportNamedDeclaration" && node.declaration != null) {
-                    var _l = node.declaration.declarations ? node.declaration.declarations[0] : node.declaration, declaration_type = _l.type, id = _l.id, init = _l.init, body = _l.body;
-                    var prop_name = id.name;
+                if (node.type === "VariableDeclaration") {
+                    _this.vars.add(node);
+                }
+                if (node.type === "ExportNamedDeclaration") {
+                    // Handle renamed exports
+                    var prop_name = void 0;
+                    if (node.declaration == null && ((_a = node.specifiers[0]) === null || _a === void 0 ? void 0 : _a.type) === "ExportSpecifier") {
+                        var specifier = node.specifiers[0];
+                        var localName_1 = specifier.local.name, exportedName = specifier.exported.name;
+                        var declaration_1;
+                        // Search through all variable declarations for this variable
+                        //  Limitation: the variable must have been declared before the export
+                        _this.vars.forEach(function (varDecl) {
+                            if (varDecl.declarations.some(function (decl) { return decl.id.type === "Identifier" && decl.id.name === localName_1; })) {
+                                declaration_1 = varDecl;
+                            }
+                        });
+                        node.declaration = declaration_1;
+                        prop_name = exportedName;
+                    }
+                    var _m = node.declaration.declarations ? node.declaration.declarations[0] : node.declaration, declaration_type = _m.type, id = _m.id, init = _m.init, body = _m.body;
+                    prop_name !== null && prop_name !== void 0 ? prop_name : (prop_name = id.name);
                     var value = undefined;
                     var type = undefined;
                     var kind = node.declaration.kind;
@@ -215,7 +235,7 @@ var ComponentParser = /** @class */ (function () {
                             init.type === "BinaryExpression" ||
                             init.type === "ArrayExpression" ||
                             init.type === "ArrowFunctionExpression") {
-                            value = (_a = _this.sourceAtPos(init.start, init.end)) === null || _a === void 0 ? void 0 : _a.replace(/\n/g, " ");
+                            value = (_b = _this.sourceAtPos(init.start, init.end)) === null || _b === void 0 ? void 0 : _b.replace(/\n/g, " ");
                             type = value;
                             isFunction = init.type === "ArrowFunctionExpression";
                             if (init.type === "BinaryExpression") {
@@ -227,7 +247,7 @@ var ComponentParser = /** @class */ (function () {
                         else {
                             if (init.type === "UnaryExpression") {
                                 value = _this.sourceAtPos(init.start, init.end);
-                                type = typeof ((_b = init.argument) === null || _b === void 0 ? void 0 : _b.value);
+                                type = typeof ((_c = init.argument) === null || _c === void 0 ? void 0 : _c.value);
                             }
                             else {
                                 value = init.raw;
@@ -236,7 +256,7 @@ var ComponentParser = /** @class */ (function () {
                         }
                     }
                     if (declaration_type === "FunctionDeclaration") {
-                        value = "() => " + ((_c = _this.sourceAtPos(body.start, body.end)) === null || _c === void 0 ? void 0 : _c.replace(/\n/g, " "));
+                        value = "() => " + ((_d = _this.sourceAtPos(body.start, body.end)) === null || _d === void 0 ? void 0 : _d.replace(/\n/g, " "));
                         type = "() => any";
                         kind = "function";
                         isFunction = true;
@@ -245,10 +265,10 @@ var ComponentParser = /** @class */ (function () {
                     if (node.leadingComments) {
                         var last_comment = node.leadingComments[node.leadingComments.length - 1];
                         var comment = commentParser(ComponentParser.formatComment(last_comment.value));
-                        var tag = (_d = comment[0]) === null || _d === void 0 ? void 0 : _d.tags[((_e = comment[0]) === null || _e === void 0 ? void 0 : _e.tags.length) - 1];
+                        var tag = (_e = comment[0]) === null || _e === void 0 ? void 0 : _e.tags[((_f = comment[0]) === null || _f === void 0 ? void 0 : _f.tags.length) - 1];
                         if ((tag === null || tag === void 0 ? void 0 : tag.tag) === "type")
                             type = _this.aliasType(tag.type);
-                        description = ComponentParser.assignValue((_f = comment[0]) === null || _f === void 0 ? void 0 : _f.description);
+                        description = ComponentParser.assignValue((_g = comment[0]) === null || _g === void 0 ? void 0 : _g.description);
                     }
                     if (!description && _this.typedefs.has(type)) {
                         description = _this.typedefs.get(type).description;
@@ -266,13 +286,13 @@ var ComponentParser = /** @class */ (function () {
                     });
                 }
                 if (node.type === "Comment") {
-                    var data = (_h = (_g = node === null || node === void 0 ? void 0 : node.data) === null || _g === void 0 ? void 0 : _g.trim()) !== null && _h !== void 0 ? _h : "";
+                    var data = (_j = (_h = node === null || node === void 0 ? void 0 : node.data) === null || _h === void 0 ? void 0 : _h.trim()) !== null && _j !== void 0 ? _j : "";
                     if (/^@component/.test(data)) {
                         _this.componentComment = data.replace(/^@component/, "");
                     }
                 }
                 if (node.type === "Slot") {
-                    var slot_name = (_j = node.attributes.find(function (attr) { return attr.name === "name"; })) === null || _j === void 0 ? void 0 : _j.value[0].data;
+                    var slot_name = (_k = node.attributes.find(function (attr) { return attr.name === "name"; })) === null || _k === void 0 ? void 0 : _k.value[0].data;
                     var slot_props = node.attributes
                         .filter(function (attr) { return attr.name !== "name"; })
                         .reduce(function (slot_props, _a) {
@@ -309,7 +329,7 @@ var ComponentParser = /** @class */ (function () {
                         }
                         return __assign(__assign({}, slot_props), (_b = {}, _b[name] = slot_prop_value, _b));
                     }, {});
-                    var fallback = (_k = node.children) === null || _k === void 0 ? void 0 : _k.map(function (_a) {
+                    var fallback = (_l = node.children) === null || _l === void 0 ? void 0 : _l.map(function (_a) {
                         var start = _a.start, end = _a.end;
                         return _this.sourceAtPos(start, end);
                     }).join("").trim();
@@ -375,7 +395,7 @@ var ComponentParser = /** @class */ (function () {
                         }
                         if (slot_props_1[key].value === undefined)
                             slot_props_1[key].value = "any";
-                        new_props_1.push(key + ": " + slot_props_1[key].value);
+                        new_props_1.push("".concat(key, ": ").concat(slot_props_1[key].value));
                     });
                     var formatted_slot_props = new_props_1.length === 0 ? "{}" : "{ " + new_props_1.join(", ") + " }";
                     return __assign(__assign({}, slot), { slot_props: formatted_slot_props });

package/lib/create-exports.js

@@ -6,11 +6,11 @@ function createExports(parsed_exports) {
         var id = _a[0], exportee = _a[1];
         if (id === "default" || exportee["default"]) {
             if (exportee.mixed) {
-                return "export { default as " + id + " } from \"" + exportee.source + "\";\nexport { default } from \"" + exportee.source + "\";";
+                return "export { default as ".concat(id, " } from \"").concat(exportee.source, "\";\nexport { default } from \"").concat(exportee.source, "\";");
             }
-            return "export { default } from \"" + exportee.source + "\";";
+            return "export { default } from \"".concat(exportee.source, "\";");
         }
-        return "export { default as " + id + " } from \"" + exportee.source + "\";";
+        return "export { default as ".concat(id, " } from \"").concat(exportee.source, "\";");
     });
     return source.join("\n");
 }

package/lib/get-svelte-entry.d.ts

@@ -1,6 +1,6 @@
 export declare type SvelteEntryPoint = string;
 /**
- * Get the file path entrypoint for uncompiled Svelte source code
+ * Get the file path entry point for uncompiled Svelte source code
  * Expects a "svelte" field in the consumer's `package.json`
  */
-export declare function getSvelteEntry(): SvelteEntryPoint | null;
+export declare function getSvelteEntry(entryPoint?: SvelteEntryPoint): SvelteEntryPoint | null;

package/lib/get-svelte-entry.js

@@ -4,17 +4,27 @@ exports.getSvelteEntry = void 0;
 var fs = require("fs");
 var path = require("path");
 /**
- * Get the file path entrypoint for uncompiled Svelte source code
+ * Get the file path entry point for uncompiled Svelte source code
  * Expects a "svelte" field in the consumer's `package.json`
  */
-function getSvelteEntry() {
+function getSvelteEntry(entryPoint) {
+    if (entryPoint) {
+        var entry_path = path.join(process.cwd(), entryPoint);
+        if (fs.existsSync(entry_path)) {
+            return entry_path;
+        }
+        else {
+            process.stdout.write("Invalid entry point: ".concat(entry_path, ".\n"));
+            return null;
+        }
+    }
     var pkg_path = path.join(process.cwd(), "package.json");
     if (fs.existsSync(pkg_path)) {
         var pkg = JSON.parse(fs.readFileSync(pkg_path, "utf-8"));
         if (pkg.svelte !== undefined)
             return pkg.svelte;
-        process.stdout.write("Could not determine an entrypoint.\n");
-        process.stdout.write('Specify an entrypoint to your Svelte code in the "svelte" field of your package.json.\n');
+        process.stdout.write("Could not determine an entry point.\n");
+        process.stdout.write('Specify an entry point to your Svelte code in the "svelte" field of your package.json.\n');
         return null;
     }
     else {

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export { default } from "./rollup-plugin";
 export { default as ComponentParser } from "./ComponentParser";
 export { cli } from "./cli";
+export { sveld } from "./sveld";

package/lib/index.js

@@ -7,10 +7,12 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 exports.__esModule = true;
-exports.cli = exports.ComponentParser = exports["default"] = void 0;
+exports.sveld = exports.cli = exports.ComponentParser = exports["default"] = void 0;
 var rollup_plugin_1 = require("./rollup-plugin");
 __createBinding(exports, rollup_plugin_1, "default");
 var ComponentParser_1 = require("./ComponentParser");
 __createBinding(exports, ComponentParser_1, "default", "ComponentParser");
 var cli_1 = require("./cli");
 __createBinding(exports, cli_1, "cli");
+var sveld_1 = require("./sveld");
+__createBinding(exports, sveld_1, "sveld");

package/lib/path.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Normalize directory separators to always use `/`.
+ * @param filePath A file path.
+ * @returns Path with normalized separators.
+ */
+export declare function normalizeSeparators(filePath: string): string;

package/lib/path.js

@@ -0,0 +1,13 @@
+"use strict";
+exports.__esModule = true;
+exports.normalizeSeparators = void 0;
+var path_1 = require("path");
+/**
+ * Normalize directory separators to always use `/`.
+ * @param filePath A file path.
+ * @returns Path with normalized separators.
+ */
+function normalizeSeparators(filePath) {
+    return path_1.sep === "/" ? filePath : filePath.split(path_1.sep).join("/");
+}
+exports.normalizeSeparators = normalizeSeparators;

package/lib/rollup-plugin.js

@@ -59,6 +59,7 @@ var get_svelte_entry_1 = require("./get-svelte-entry");
 var parse_exports_1 = require("./parse-exports");
 var compiler_1 = require("svelte/compiler");
 var svelte_preprocess_1 = require("svelte-preprocess");
+var path_1 = require("./path");
 function pluginSveld(opts) {
     var result;
     var input;
@@ -99,12 +100,9 @@ function generateBundle(input, glob) {
                     entry = fs.readFileSync(input, "utf-8");
                     exports = (0, parse_exports_1.parseExports)(entry);
                     if (glob) {
-                        fg.sync([dir + "/**/*.svelte"]).forEach(function (file) {
+                        fg.sync(["".concat(dir, "/**/*.svelte")]).forEach(function (file) {
                             var moduleName = path.parse(file).name.replace(/\-/g, "");
-                            var source = "./" + path.relative(dir, file);
-                            if (path.sep !== "/") {
-                                source = source.split(path.sep).join("/");
-                            }
+                            var source = (0, path_1.normalizeSeparators)("./" + path.relative(dir, file));
                             if (exports[moduleName]) {
                                 exports[moduleName].source = source;
                             }

package/lib/sveld.d.ts

@@ -0,0 +1,11 @@
+import { PluginSveldOptions } from "./rollup-plugin";
+interface SveldOptions extends PluginSveldOptions {
+    /**
+     * Specify the input to the uncompiled Svelte source.
+     * If no value is provided, `sveld` will attempt to infer
+     * the entry point from the `package.json#svelte` field.
+     */
+    input?: string;
+}
+export declare function sveld(opts?: SveldOptions): Promise<void>;
+export {};

package/lib/sveld.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.sveld = void 0;
+var get_svelte_entry_1 = require("./get-svelte-entry");
+var rollup_plugin_1 = require("./rollup-plugin");
+function sveld(opts) {
+    return __awaiter(this, void 0, void 0, function () {
+        var input, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    input = (0, get_svelte_entry_1.getSvelteEntry)(opts === null || opts === void 0 ? void 0 : opts.input);
+                    if (input === null)
+                        return [2 /*return*/];
+                    return [4 /*yield*/, (0, rollup_plugin_1.generateBundle)(input, (opts === null || opts === void 0 ? void 0 : opts.glob) === true)];
+                case 1:
+                    result = _a.sent();
+                    (0, rollup_plugin_1.writeOutput)(result, opts || {}, input);
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.sveld = sveld;

package/lib/writer/WriterMarkdown.js

@@ -40,9 +40,9 @@ var WriterMarkdown = /** @class */ (function (_super) {
             case "h5":
             case "h6":
                 var length_1 = Number(type.slice(-1));
-                this.source += Array.from({ length: length_1 })
+                this.source += "".concat(Array.from({ length: length_1 })
                     .map(function (_) { return "#"; })
-                    .join("") + " " + raw;
+                    .join(""), " ").concat(raw);
                 if (this.hasToC && type === "h2") {
                     this.toc.push({
                         array: Array.from({ length: (length_1 - 1) * 2 }),
@@ -51,7 +51,7 @@ var WriterMarkdown = /** @class */ (function (_super) {
                 }
                 break;
             case "quote":
-                this.source += "> " + raw;
+                this.source += "> ".concat(raw);
                 break;
             case "p":
                 this.source += raw;
@@ -78,7 +78,7 @@ var WriterMarkdown = /** @class */ (function (_super) {
         this.source = this.source.replace("<!-- __TOC__ -->", this.toc
             .map(function (_a) {
             var array = _a.array, raw = _a.raw;
-            return array.join(" ") + " - [" + raw + "](#" + raw.toLowerCase().replace(/\`/g, "").replace(/\s+/g, "-") + ")";
+            return "".concat(array.join(" "), " - [").concat(raw, "](#").concat(raw.toLowerCase().replace(/\`/g, "").replace(/\s+/g, "-"), ")");
         })
             .join("\n"));
         return this.source;

package/lib/writer/writer-json.js

@@ -48,6 +48,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 exports.__esModule = true;
 var path = require("path");
+var path_1 = require("../path");
 var Writer_1 = require("./Writer");
 function writeJson(components, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -59,7 +60,7 @@ function writeJson(components, options) {
                         total: components.size,
                         components: Array.from(components, function (_a) {
                             var moduleName = _a[0], component = _a[1];
-                            return (__assign(__assign({}, component), { filePath: path.join(options.inputDir, path.normalize(component.filePath)) }));
+                            return (__assign(__assign({}, component), { filePath: (0, path_1.normalizeSeparators)(path.join(options.inputDir, path.normalize(component.filePath))) }));
                         }).sort(function (a, b) {
                             if (a.moduleName < b.moduleName)
                                 return -1;
@@ -73,7 +74,7 @@ function writeJson(components, options) {
                     return [4 /*yield*/, writer.write(output_path, JSON.stringify(output))];
                 case 1:
                     _a.sent();
-                    process.stdout.write("created \"" + options.outFile + "\".\n");
+                    process.stdout.write("created \"".concat(options.outFile, "\".\n"));
                     return [2 /*return*/];
             }
         });

package/lib/writer/writer-markdown.js

@@ -55,15 +55,15 @@ var MD_TYPE_UNDEFINED = "--";
 function formatPropType(type) {
     if (type === undefined)
         return MD_TYPE_UNDEFINED;
-    return "<code>" + type.replace(/\|/g, "&#124;") + "</code>";
+    return "<code>".concat(type.replace(/\|/g, "&#124;"), "</code>");
 }
 function escapeHtml(text) {
     return text.replace(/\</g, "&lt;").replace(/\>/g, "&gt;");
 }
 function formatPropValue(value) {
     if (value === undefined)
-        return MD_TYPE_UNDEFINED;
-    return "<code>" + value.replace(/`/g, "\\`").replace(/\|/g, "&#124;") + "</code>";
+        return "<code>".concat(value, "</code>");
+    return "<code>".concat(value.replace(/`/g, "\\`").replace(/\|/g, "&#124;"), "</code>");
 }
 function formatPropDescription(description) {
     if (description === undefined || description.trim().length === 0)
@@ -104,11 +104,11 @@ function writeMarkdown(components, options) {
                     keys = Array.from(components.keys()).sort();
                     keys.forEach(function (key) {
                         var component = components.get(key);
-                        document.append("h2", "`" + component.moduleName + "`");
+                        document.append("h2", "`".concat(component.moduleName, "`"));
                         if (component.typedefs.length > 0) {
-                            document.append("h3", "Types").append("raw", "```ts\n" + (0, writer_ts_definitions_1.getTypeDefs)({
+                            document.append("h3", "Types").append("raw", "```ts\n".concat((0, writer_ts_definitions_1.getTypeDefs)({
                                 typedefs: component.typedefs
-                            }) + "\n```\n\n");
+                            }), "\n```\n\n"));
                         }
                         document.append("h3", "Props");
                         if (component.props.length > 0) {
@@ -121,7 +121,7 @@ function writeMarkdown(components, options) {
                                 return 0;
                             })
                                 .forEach(function (prop) {
-                                document.append("raw", "| " + prop.name + " | " + ("<code>" + prop.kind + "</code>") + " | " + (prop.reactive ? "Yes" : "No") + " | " + formatPropType(prop.type) + " | " + formatPropValue(prop.value) + " | " + formatPropDescription(prop.description) + " |\n");
+                                document.append("raw", "| ".concat(prop.name, " | ").concat("<code>".concat(prop.kind, "</code>"), " | ").concat(prop.reactive ? "Yes" : "No", " | ").concat(formatPropType(prop.type), " | ").concat(formatPropValue(prop.value), " | ").concat(formatPropDescription(prop.description), " |\n"));
                             });
                         }
                         else {
@@ -131,7 +131,7 @@ function writeMarkdown(components, options) {
                         if (component.slots.length > 0) {
                             document.append("raw", SLOT_TABLE_HEADER);
                             component.slots.forEach(function (slot) {
-                                document.append("raw", "| " + (slot["default"] ? MD_TYPE_UNDEFINED : slot.name) + " | " + (slot["default"] ? "Yes" : "No") + " | " + formatSlotProps(slot.slot_props) + " | " + formatSlotFallback(slot.fallback) + " |\n");
+                                document.append("raw", "| ".concat(slot["default"] ? MD_TYPE_UNDEFINED : slot.name, " | ").concat(slot["default"] ? "Yes" : "No", " | ").concat(formatSlotProps(slot.slot_props), " | ").concat(formatSlotFallback(slot.fallback), " |\n"));
                             });
                         }
                         else {
@@ -141,7 +141,7 @@ function writeMarkdown(components, options) {
                         if (component.events.length > 0) {
                             document.append("raw", EVENT_TABLE_HEADER);
                             component.events.forEach(function (event) {
-                                document.append("raw", "| " + event.name + " | " + event.type + " | " + (event.type === "dispatched" ? formatEventDetail(event.detail) : MD_TYPE_UNDEFINED) + " |\n");
+                                document.append("raw", "| ".concat(event.name, " | ").concat(event.type, " | ").concat(event.type === "dispatched" ? formatEventDetail(event.detail) : MD_TYPE_UNDEFINED, " |\n"));
                             });
                         }
                         else {
@@ -151,7 +151,7 @@ function writeMarkdown(components, options) {
                     return [4 /*yield*/, document.write(output_path, document.end())];
                 case 1:
                     _a.sent();
-                    process.stdout.write("created \"" + options.outFile + "\".\n");
+                    process.stdout.write("created \"".concat(options.outFile, "\".\n"));
                     return [2 /*return*/];
             }
         });

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

@@ -69,19 +69,19 @@ exports.formatTsProps = formatTsProps;
 function getTypeDefs(def) {
     if (def.typedefs.length === 0)
         return EMPTY_STR;
-    return def.typedefs.map(function (typedef) { return "export " + typedef.ts; }).join("\n\n");
+    return def.typedefs.map(function (typedef) { return "export ".concat(typedef.ts); }).join("\n\n");
 }
 exports.getTypeDefs = getTypeDefs;
 function clampKey(key) {
     if (/(\-|\s+|\:)/.test(key)) {
-        return /(\"|\')/.test(key) ? key : "[\"" + key + "\"]";
+        return /(\"|\')/.test(key) ? key : "[\"".concat(key, "\"]");
     }
     return key;
 }
 function addCommentLine(value, returnValue) {
     if (!value)
         return undefined;
-    return "* " + (returnValue || value) + "\n";
+    return "* ".concat(returnValue || value, "\n");
 }
 function genPropDef(def) {
     var _a;
@@ -89,28 +89,35 @@ function genPropDef(def) {
         .filter(function (prop) { return !prop.isFunctionDeclaration && prop.kind !== "const"; })
         .map(function (prop) {
         var _a;
+        var defaultValue = prop.value;
+        if (typeof prop.value === "string") {
+            defaultValue = prop.value.replace(/\s+/g, " ");
+        }
+        if (prop.value === undefined) {
+            defaultValue = "undefined";
+        }
         var prop_comments = [
             addCommentLine((_a = prop.description) === null || _a === void 0 ? void 0 : _a.replace(/\n/g, "\n* ")),
             addCommentLine(prop.constant, "@constant"),
-            addCommentLine(prop.value, "@default " + (typeof prop.value === "string" ? prop.value.replace(/\s+/g, " ") : prop.value)),
+            "* @default ".concat(defaultValue, "\n"),
         ]
             .filter(Boolean)
             .join("");
         var prop_value = prop.constant && !prop.isFunction ? prop.value : prop.type;
-        return "\n      " + (prop_comments.length > 0 ? "/**\n" + prop_comments + "*/" : EMPTY_STR) + "\n      " + prop.name + "?: " + prop_value + ";";
+        return "\n      ".concat(prop_comments.length > 0 ? "/**\n".concat(prop_comments, "*/") : EMPTY_STR, "\n      ").concat(prop.name, "?: ").concat(prop_value, ";");
     })
         .join("\n");
-    var props_name = def.moduleName + "Props";
+    var props_name = "".concat(def.moduleName, "Props");
     var prop_def = EMPTY_STR;
     if (((_a = def.rest_props) === null || _a === void 0 ? void 0 : _a.type) === "Element") {
         var extend_tag_map = def.rest_props.name
             .split("|")
-            .map(function (name) { return "svelte.JSX.HTMLAttributes<HTMLElementTagNameMap[\"" + name.trim() + "\"]>"; })
+            .map(function (name) { return "svelte.JSX.HTMLAttributes<HTMLElementTagNameMap[\"".concat(name.trim(), "\"]>"); })
             .join(",");
-        prop_def = "\n    export interface " + props_name + " extends " + (def["extends"] !== undefined ? def["extends"].interface + ", " : "") + extend_tag_map + " {\n      " + props + "\n    }\n  ";
+        prop_def = "\n    export interface ".concat(props_name, " extends ").concat(def["extends"] !== undefined ? "".concat(def["extends"].interface, ", ") : "").concat(extend_tag_map, " {\n      ").concat(props, "\n    }\n  ");
     }
     else {
-        prop_def = "\n    export interface " + props_name + " " + (def["extends"] !== undefined ? "extends " + def["extends"].interface : "") + " {\n      " + props + "\n    }\n  ";
+        prop_def = "\n    export interface ".concat(props_name, " ").concat(def["extends"] !== undefined ? "extends ".concat(def["extends"].interface) : "", " {\n      ").concat(props, "\n    }\n  ");
     }
     return {
         props_name: props_name,
@@ -122,14 +129,14 @@ function genSlotDef(def) {
         .map(function (_a) {
         var name = _a.name, slot_props = _a.slot_props, rest = __rest(_a, ["name", "slot_props"]);
         var key = rest["default"] ? "default" : clampKey(name);
-        return clampKey(key) + ": " + formatTsProps(slot_props) + ";";
+        return "".concat(clampKey(key), ": ").concat(formatTsProps(slot_props), ";");
     })
         .join("\n");
 }
 function genEventDef(def) {
     return def.events
         .map(function (event) {
-        return clampKey(event.name) + ": " + (event.type === "dispatched" ? "CustomEvent<" + (event.detail || ANY_TYPE) + ">" : "WindowEventMap[\"" + event.name + "\"]") + ";";
+        return "".concat(clampKey(event.name), ": ").concat(event.type === "dispatched" ? "CustomEvent<".concat(event.detail || ANY_TYPE, ">") : "WindowEventMap[\"".concat(event.name, "\"]"), ";");
     })
         .join("\n");
 }
@@ -139,24 +146,24 @@ function genAccessors(def) {
         .map(function (prop) {
         var _a;
         var prop_comments = [addCommentLine((_a = prop.description) === null || _a === void 0 ? void 0 : _a.replace(/\n/g, "\n* "))].filter(Boolean).join("");
-        return "\n    " + (prop_comments.length > 0 ? "/**\n" + prop_comments + "*/" : EMPTY_STR) + "\n    " + prop.name + ": " + prop.type + ";";
+        return "\n    ".concat(prop_comments.length > 0 ? "/**\n".concat(prop_comments, "*/") : EMPTY_STR, "\n    ").concat(prop.name, ": ").concat(prop.type, ";");
     })
         .join("\n");
 }
 function genImports(def) {
     if (def["extends"] === undefined)
         return "";
-    return "import { " + def["extends"].interface + " } from " + def["extends"]["import"] + ";";
+    return "import { ".concat(def["extends"].interface, " } from ").concat(def["extends"]["import"], ";");
 }
 function genComponentComment(def) {
     if (!def.componentComment)
         return "";
     if (!/\n/.test(def.componentComment))
-        return "/** " + def.componentComment.trim() + " */";
-    return "/*" + def.componentComment
+        return "/** ".concat(def.componentComment.trim(), " */");
+    return "/*".concat(def.componentComment
         .split("\n")
-        .map(function (line) { return "* " + line; })
-        .join("\n") + "\n*/";
+        .map(function (line) { return "* ".concat(line); })
+        .join("\n"), "\n*/");
 }
 function writeTsDefinition(component) {
     var moduleName = component.moduleName, typedefs = component.typedefs, props = component.props, slots = component.slots, events = component.events, rest_props = component.rest_props, _extends = component["extends"], componentComment = component.componentComment;
@@ -166,7 +173,7 @@ function writeTsDefinition(component) {
         rest_props: rest_props,
         "extends": _extends
     }), props_name = _a.props_name, prop_def = _a.prop_def;
-    return "\n  /// <reference types=\"svelte\" />\n  import { SvelteComponentTyped } from \"svelte\";\n  " + genImports({ "extends": _extends }) + "\n  " + getTypeDefs({ typedefs: typedefs }) + "\n  " + prop_def + "\n  " + genComponentComment({ componentComment: componentComment }) + "\n  export default class " + (moduleName === "default" ? "" : moduleName) + " extends SvelteComponentTyped<\n      " + props_name + ",\n      {" + genEventDef({ events: events }) + "},\n      {" + genSlotDef({ slots: slots }) + "}\n    > {\n      " + genAccessors({ props: props }) + "\n    }";
+    return "\n  /// <reference types=\"svelte\" />\n  import { SvelteComponentTyped } from \"svelte\";\n  ".concat(genImports({ "extends": _extends }), "\n  ").concat(getTypeDefs({ typedefs: typedefs }), "\n  ").concat(prop_def, "\n  ").concat(genComponentComment({ componentComment: componentComment }), "\n  export default class ").concat(moduleName === "default" ? "" : moduleName, " extends SvelteComponentTyped<\n      ").concat(props_name, ",\n      {").concat(genEventDef({ events: events }), "},\n      {").concat(genSlotDef({ slots: slots }), "}\n    > {\n      ").concat(genAccessors({ props: props }), "\n    }");
 }
 exports.writeTsDefinition = writeTsDefinition;
 function writeTsDefinitions(components, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sveld",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "license": "Apache-2.0",
   "description": "Generate TypeScript definitions for your Svelte components.",
   "main": "./lib/index.js",
@@ -11,7 +11,7 @@
     "test": "run-p test:*",
     "test:unit": "tsnd node_modules/tape/bin/tape tests/*.test.ts",
     "test:integration": "node tests/integration",
-    "format": "prettier --write '{src,tests}/**/*.{ts,svelte}'",
+    "format": "prettier --write \"{src,tests}/**/*.{js,ts,svelte}\"",
     "prepack": "run-s build test"
   },
   "peerDependencies": {
@@ -23,12 +23,12 @@
     "comment-parser": "^0.7.6",
     "fast-glob": "^3.2.7",
     "fs-extra": "^9.0.1",
-    "prettier": "^2.3.2",
-    "rollup": "^2.56.3",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
     "rollup-plugin-svelte": "^7.1.0",
-    "svelte": "^3.42.4",
-    "svelte-preprocess": "^4.8.0",
-    "typescript": "^4.4.2"
+    "svelte": "^3.46.2",
+    "svelte-preprocess": "^4.10.2",
+    "typescript": "^4.5.5"
   },
   "devDependencies": {
     "@types/fs-extra": "^9.0.12",