shareable-twoslash-comments 0.0.3 → 0.0.5

package/README.md

@@ -2,6 +2,8 @@
 
 A TypeScript Playground plugin that embeds twoslash (// ^?) type hints as literal comments in your code, making them easy to copy and share.
 
+https://github.com/user-attachments/assets/2224eec7-3011-4a08-b157-9eb6da700675
+
 ## Running this plugin
 
 - [Click this link](https://www.typescriptlang.org/play?install-plugin=shareable-twoslash-comments) to install

package/dist/index.js

@@ -60,12 +60,13 @@ define(function () { 'use strict';
 
     var twoSlashQueryRegex = /(^[ \t]*)(\/\/\s*\^\?)/gm;
     var fillTwoSlashQueries = function (sandbox) { return __awaiter(void 0, void 0, void 0, function () {
-        var multilineEnabled, model, worker, diagnostics, text, editOperations, _i, _a, match, commentPrefix, caretOffset, caretPos, quickInfoPos, quickInfoOffset, quickInfo, quickInfoString, quickInfoComment, prevQuickInfoComment, prevQuickInfoLines, prevQuickInfoEndLine;
+        var multilineEnabled, truncationDisabled, model, worker, diagnostics, text, editOperations, _i, _a, match, commentPrefix, caretOffset, caretPos, quickInfoPos, quickInfoOffset, quickInfo, quickInfoString, quickInfoComment, prevQuickInfoComment, prevQuickInfoLines, prevQuickInfoEndLine;
         var _b, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
                     multilineEnabled = localStorage.getItem("shareable-twoslash-comments/enable-multiline-comments") === "true";
+                    truncationDisabled = localStorage.getItem("shareable-twoslash-comments/disable-truncation") === "true";
                     model = sandbox.getModel();
                     return [4 /*yield*/, sandbox.getWorkerProcess()];
                 case 1:
@@ -97,7 +98,7 @@ define(function () { 'use strict';
                     quickInfoString = (_c = (_b = quickInfo === null || quickInfo === void 0 ? void 0 : quickInfo.displayParts) === null || _b === void 0 ? void 0 : _b.map(function (d) { return d.text; }).join("")) !== null && _c !== void 0 ? _c : "";
                     quickInfoComment = "".concat(match[0], " ").concat(multilineEnabled
                         ? quickInfoString.replace(/\r?\n/g, model.getEOL() + commentPrefix)
-                        : quickInfoString.replace(/\r?\n\s*/g, " "));
+                        : truncate(quickInfoString.replace(/\r?\n\s*/g, " "), truncationDisabled ? Number.POSITIVE_INFINITY : 100));
                     prevQuickInfoComment = getPreviousQuickInfoComment({
                         model: model,
                         lineNumber: caretPos.lineNumber,
@@ -152,13 +153,17 @@ define(function () { 'use strict';
             }, delay);
         };
     };
+    var truncate = function (str, maxLength) {
+        return str.length > maxLength ? str.slice(0, maxLength) + "…" : str;
+    };
     //# sourceMappingURL=utils.js.map
 
-    var debouncedFillTwoSlashQueries = debounce(fillTwoSlashQueries, 600);
+    var debouncedFillTwoSlashQueries = debounce(fillTwoSlashQueries, 500);
     var makePlugin = function (utils) {
         var customPlugin = {
             id: "shareable-twoslash-comments",
             displayName: "Shareable Twoslash Comments",
+            data: { firstMount: true },
             didMount: function (sandbox, container) {
                 // Create a design system object to handle
                 // making DOM elements which fit the playground (and handle mobile/light/dark etc)
@@ -171,17 +176,29 @@ define(function () { 'use strict';
                         display: "Enable multiline comments",
                         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",
+                        display: "Disable truncation",
+                        onchange: function () { return fillTwoSlashQueries(sandbox); },
+                    },
                 ], {
                     style: "separated",
                 });
+                var model = sandbox.getModel();
+                if (customPlugin.data.firstMount) {
+                    model.onDidChangeContent(function () {
+                        debouncedFillTwoSlashQueries(sandbox);
+                    });
+                    customPlugin.data.firstMount = false;
+                }
             },
             // This is called occasionally as text changes in monaco,
             // it does not directly map 1 keyup to once run of the function
             // because it is intentionally called at most once every 0.3 seconds
             // and then will always run at the end.
-            modelChangedDebounce: function (sandbox, model) { return __awaiter(void 0, void 0, void 0, function () {
+            modelChangedDebounce: function (_sandbox, _model) { return __awaiter(void 0, void 0, void 0, function () {
                 return __generator(this, function (_a) {
-                    debouncedFillTwoSlashQueries(sandbox);
                     return [2 /*return*/];
                 });
             }); },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shareable-twoslash-comments",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "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",