@kupcad/playground 0.1.7 → 0.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kupcad/playground",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "KupCAD in the browser: a script's editor, its model and its parameters, running on the core compiled to WebAssembly in a worker. One Svelte component a page embeds.",
   "license": "AGPL-3.0-only",
   "repository": {
@@ -24,10 +24,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@kupcad/editor": "0.1.7",
-    "@kupcad/protocol": "0.1.7",
-    "@kupcad/ui": "0.1.7",
-    "@kupcad/wasm": "0.1.7"
+    "@kupcad/editor": "0.1.8",
+    "@kupcad/protocol": "0.1.8",
+    "@kupcad/ui": "0.1.8",
+    "@kupcad/wasm": "0.1.8"
   },
   "devDependencies": {
     "@codemirror/language": "^6.13.1",

package/src/Playground.svelte

@@ -27,6 +27,7 @@
     linesOfLog,
     linesOfRun,
     localSettings,
+    paneKeys,
     ParamsPanel,
     plainValues,
     problemsOf,
@@ -38,7 +39,7 @@
   import { createKupcadWorker } from '@kupcad/wasm';
   import { download } from './download.js';
   import { marksOf } from './marks.js';
-  import { Runner } from './runner.js';
+  import { DELAY_MS, Runner } from './runner.js';
 
   /** @import { Editor as EditorClass, EditorLanguage } from '@kupcad/editor' */
   /** @import { ExportFormat, Finding, ParamValues, Preview } from '@kupcad/protocol/types' */
@@ -67,6 +68,8 @@
    *   (`.kc-control` gives them its look)
    * @property {readonly ShortcutGroup[]} [shortcuts] the host's own, listed before the viewer's
    * @property {boolean} [shortcutsOpen] whether the shortcuts' dialog shows; bindable
+   * @property {number} [runDelayMs] how long the script stays as it is after an edit before it
+   *   runs (runner.js's DELAY_MS); a test gives 0, so a run that would come comes at once
    */
 
   /** @type {Props} */
@@ -82,20 +85,14 @@
     actions: hostActions,
     shortcuts = [],
     shortcutsOpen = $bindable(false),
+    runDelayMs = DELAY_MS,
   } = $props();
 
   /**
    * The settings' keys: the editor's and the parameters' widths, whether the parameters and the
    * view's panel show, the console's height and state.
    */
-  const KEYS = {
-    editor: 'playground.editor',
-    params: 'playground.params',
-    paramsOpen: 'playground.paramsOpen',
-    panelOpen: 'playground.panelOpen',
-    console: 'playground.console',
-    open: 'playground.consoleOpen',
-  };
+  const KEYS = { editor: 'playground.editor', ...paneKeys('playground') };
   /** The least the model is given, however wide the editor is made. */
   const MIN_VIEW = 320;
   const id = $props.id();
@@ -151,18 +148,22 @@
   onMount(() => {
     const made = kupcad ? null : createKupcadWorker(wasm ? { wasm, log } : { log });
     core = kupcad ?? made;
-    runner = new Runner(/** @type {KupcadApi} */ (core), {
-      onfindings: (next, of) => {
-        if (runs && of === value) findings = next;
+    runner = new Runner(
+      /** @type {KupcadApi} */ (core),
+      {
+        onfindings: (next, of) => {
+          if (runs && of === value) findings = next;
+        },
+        onpreview: (preview, of) => {
+          if (!runs) return;
+          ran = { preview, source: of };
+          notice = '';
+          consoleLines = appendLines(consoleLines, linesOfRun(preview.header, name));
+        },
+        onerror: (error) => (notice = errorText(error)),
       },
-      onpreview: (preview, of) => {
-        if (!runs) return;
-        ran = { preview, source: of };
-        notice = '';
-        consoleLines = appendLines(consoleLines, linesOfRun(preview.header, name));
-      },
-      onerror: (error) => (notice = errorText(error)),
-    });
+      { delayMs: runDelayMs },
+    );
     if (value !== '') runner.run(value, {}, { now: true, files });
     return () => {
       runner?.stop();
@@ -251,9 +252,13 @@
     runner?.run(value, values, { now: true, files });
   }
 
-  /** @param {Problem | ConsoleLine} place a problem or a console line with a line, clicked */
+  /**
+   * Shows the script where a problem or a console line is, clicked; one in a library (`file`),
+   * another file than the editor's, isn't shown.
+   * @param {{ line: number | null, column: number | null, file?: string | null }} place
+   */
   function reveal(place) {
-    if (place.line !== null) editor?.reveal(place.line, place.column ?? 1);
+    if (place.line !== null && !place.file) editor?.reveal(place.line, place.column ?? 1);
   }
 
   /** @param {ExportFormat} format */
@@ -313,6 +318,7 @@
           {status}
           {problems}
           onproblem={reveal}
+          onsource={(part) => part.source && reveal({ file: null, ...part.source })}
           onscreenshot={screenshot}
           {settings}
           {shortcuts}

package/src/marks.js

@@ -8,7 +8,8 @@
 
 /**
  * @param {readonly Finding[]} findings `check`'s
- * @param {readonly Problem[]} problems the run's (`problemsOf(header)`): those with a line
+ * @param {readonly Problem[]} problems the run's (`problemsOf(header)`): those with a line in
+ *   the script (not in a library, `file`)
  * @returns {Mark[]}
  */
 export function marksOf(findings, problems) {
@@ -16,7 +17,8 @@ export function marksOf(findings, problems) {
   /** @type {Mark[]} */
   const placed = [];
   for (const problem of problems) {
-    if (problem.line === null || (checked && problem.severity === 'error')) continue;
+    if (problem.line === null || problem.file || (checked && problem.severity === 'error'))
+      continue;
     const { severity, message, line } = problem;
     placed.push({ severity, message, line, column: problem.column ?? 1 });
   }