shareable-twoslash-comments 0.0.11 → 0.0.13

package/dist/index.js

@@ -79,7 +79,12 @@ define(function () { 'use strict';
                             case 2:
                                 quickInfo = _c.sent();
                                 if (quickInfo === null || quickInfo === void 0 ? void 0 : quickInfo.displayParts) {
-                                    return [2 /*return*/, quickInfo.displayParts.map(function (d) { return d.text; }).join("")];
+                                    return [2 /*return*/, compactOutputEnabled
+                                            ? extractTypeFromDisplayParts(quickInfo.displayParts)
+                                            : quickInfo.displayParts.map(function (_a) {
+                                                var text = _a.text;
+                                                return text;
+                                            }).join("")];
                                 }
                                 _c.label = 3;
                             case 3:
@@ -90,25 +95,74 @@ define(function () { 'use strict';
                     });
                 });
             }
+            function extractTypeFromDisplayParts(displayParts) {
+                // For interfaces and enums, return everything after the keyword.
+                var keywordIndex = displayParts.findIndex(function (part) { return part.kind === "keyword" && ["interface", "enum"].includes(part.text); });
+                if (keywordIndex !== -1) {
+                    return displayParts
+                        .slice(keywordIndex + 1)
+                        .map(function (part) { return part.text; })
+                        .join("")
+                        .trim();
+                }
+                var depth = 0;
+                var separatorIndex = displayParts.findIndex(function (part) {
+                    if (part.kind === "punctuation") {
+                        if (["(", "{", "<"].includes(part.text)) {
+                            depth++;
+                        }
+                        else if ([")", "}", ">"].includes(part.text)) {
+                            depth--;
+                        }
+                        else if (part.text === ":" && depth === 0) {
+                            return true;
+                        }
+                    }
+                    else if (part.kind === "operator" && part.text === "=" && depth === 0) {
+                        return true;
+                    }
+                    return false;
+                });
+                // If `separatorIndex` is `-1` (not found), return the entire thing.
+                return displayParts
+                    .slice(separatorIndex + 1)
+                    .map(function (_a) {
+                    var text = _a.text;
+                    return text;
+                })
+                    .join("")
+                    .trim();
+            }
             function getPreviousQuickInfoComment(_a) {
-                var lineNumber = _a.lineNumber, commentPrefix = _a.commentPrefix;
+                var lineNumber = _a.lineNumber;
                 var prevQuickInfoLines = [model.getLineContent(lineNumber)];
                 for (var currLineNumber = lineNumber + 1; currLineNumber <= model.getLineCount(); currLineNumber++) {
                     var lineContent = model.getLineContent(currLineNumber);
-                    if (!lineContent.startsWith(commentPrefix)) {
+                    /*
+                    Non-first lines in plugin generated comments are guaranteed to have 3 spaces after `//`.
+                    ```
+                    let foo = {bar: 1};
+                    foo
+                    //^? let foo: {
+                    //       bar: number; [[ 3 spaces after `//` ]]
+                    //   } [[ 3 spaces after `//` ]]
+                    ```
+                    */
+                    if (!/^ *\/\/ {3}/.test(lineContent)) {
                         break;
                     }
                     prevQuickInfoLines.push(lineContent);
                 }
                 return prevQuickInfoLines.join(model.getEOL());
             }
-            var multilineEnabled, truncationDisabled, pauseOnError, model, worker, diagnostics, text, editOperations, matches, _i, matches_1, _a, match, queryType, textBeforeQuery, commentPrefix, isInlineArrowQuery, lineNumber, column, caretOffset, caretPos, quickInfoLine, quickInfoString, quickInfoComment, prevQuickInfoComment, prevQuickInfoLines, prevQuickInfoEndLine;
+            var multilineEnabled, truncationDisabled, compactOutputEnabled, pauseOnError, model, worker, diagnostics, text, editOperations, matches, _i, matches_1, _a, match, queryType, textBeforeQuery, commentPrefix, isInlineArrowQuery, lineNumber, column, caretOffset, caretPos, quickInfoLine, quickInfoString, quickInfoComment, prevQuickInfoComment, prevQuickInfoLines, prevQuickInfoEndLine;
             if (isUndoRedoChange === void 0) { isUndoRedoChange = false; }
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         multilineEnabled = localStorage.getItem("shareable-twoslash-comments/enable-multiline-comments") === "true";
                         truncationDisabled = localStorage.getItem("shareable-twoslash-comments/disable-truncation") === "true";
+                        compactOutputEnabled = localStorage.getItem("shareable-twoslash-comments/compact-output") === "true";
                         pauseOnError = localStorage.getItem("shareable-twoslash-comments/pause-on-error") === "true";
                         model = sandbox.getModel();
                         return [4 /*yield*/, sandbox.getWorkerProcess()];
@@ -163,7 +217,7 @@ define(function () { 'use strict';
                         quickInfoComment = "".concat(match[0]).concat(quickInfoString.length > 0 ? " " : "").concat(multilineEnabled
                             ? quickInfoString.replace(/\r?\n/g, model.getEOL() + commentPrefix)
                             : truncate(quickInfoString.replace(/\r?\n\s*/g, " "), truncationDisabled ? Number.POSITIVE_INFINITY : 100));
-                        prevQuickInfoComment = getPreviousQuickInfoComment({ lineNumber: lineNumber, commentPrefix: commentPrefix });
+                        prevQuickInfoComment = getPreviousQuickInfoComment({ lineNumber: lineNumber });
                         prevQuickInfoLines = prevQuickInfoComment.split("\n").length;
                         prevQuickInfoEndLine = lineNumber + prevQuickInfoLines - 1;
                         if (prevQuickInfoComment !== quickInfoComment) {
@@ -220,7 +274,6 @@ define(function () { 'use strict';
     function truncate(str, maxLength) {
         return str.length > maxLength ? str.slice(0, maxLength) + "…" : str;
     }
-    //# sourceMappingURL=utils.js.map
 
     var debouncedFillTwoSlashQueries = debounce(fillTwoSlashQueries, 500);
     var makePlugin = function (utils) {
@@ -231,6 +284,28 @@ define(function () { 'use strict';
             shouldBeSelected: function () { return true; },
             didMount: function (sandbox, container) {
                 container.style.paddingRight = "8px";
+                var sponsorBanner = document.createElement("a");
+                sponsorBanner.href = "https://github.com/sponsors/som-sm";
+                sponsorBanner.target = "_blank";
+                sponsorBanner.rel = "noopener noreferrer";
+                sponsorBanner.textContent = "♡ Support this plugin";
+                Object.assign(sponsorBanner.style, {
+                    display: "block",
+                    paddingBottom: "8px",
+                    borderBottom: "1px solid var(--border-color, rgba(128,128,128,0.2))",
+                    color: "var(--text-color, inherit)",
+                    textDecoration: "none",
+                    textAlign: "right",
+                    fontSize: "0.8em",
+                    opacity: "0.6",
+                });
+                sponsorBanner.onmouseenter = function () {
+                    sponsorBanner.style.opacity = "1";
+                };
+                sponsorBanner.onmouseleave = function () {
+                    sponsorBanner.style.opacity = "0.6";
+                };
+                container.appendChild(sponsorBanner);
                 // Create a design system object to handle
                 // making DOM elements which fit the playground (and handle mobile/light/dark etc)
                 var ds = utils.createDesignSystem(container);
@@ -251,6 +326,12 @@ define(function () { 'use strict';
                         display: "Enable multiline comments",
                         onchange: function () { return fillTwoSlashQueries(sandbox); },
                     },
+                    {
+                        blurb: "Generate shorter comments by inserting just the type.",
+                        flag: "shareable-twoslash-comments/compact-output",
+                        display: "Compact output",
+                        onchange: function () { return fillTwoSlashQueries(sandbox); },
+                    },
                     {
                         blurb: "Prevent truncation of single line comments. Otherwise, they will be truncated to 100 characters.",
                         flag: "shareable-twoslash-comments/disable-truncation",
@@ -317,7 +398,6 @@ define(function () { 'use strict';
         };
         return customPlugin;
     };
-    //# sourceMappingURL=index.js.map
 
     return makePlugin;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shareable-twoslash-comments",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "main": "dist/index.js",
   "description": "A TypeScript Playground plugin that embeds twoslash (// ^?) type hints as literal comments in your code, making them easy to copy and share.",
   "license": "MIT",

package/dist/assets/asset-125afa63

@@ -1 +0,0 @@
-

package/dist/assets/asset-e4c236d5

@@ -1,5 +0,0 @@
-.readonly-line {
-  color: gray;
-  background: black;
-}
-

package/dist/bundle.css

@@ -1,5 +0,0 @@
-.readonly-line {
-  color: gray;
-  background: black;
-}
-