@rohal12/spindle 0.52.5 → 0.52.6

package/dist/pkg/macro-registry.json

@@ -3,6 +3,13 @@
     "name": "set",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "code",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -11,6 +18,13 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -18,6 +32,22 @@
     "block": false,
     "subMacros": [],
     "merged": true,
+    "parameters": [
+      {
+        "name": "target",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "=",
+        "type": "separator"
+      },
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -26,6 +56,22 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "current",
+        "type": "expression",
+        "required": true
+      },
+      {
+        "name": "max",
+        "type": "expression",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -42,6 +88,22 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "variables",
+        "type": "names",
+        "required": true
+      },
+      {
+        "name": "of",
+        "type": "separator"
+      },
+      {
+        "name": "list",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -55,6 +117,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "delay",
+        "type": "delay",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -62,6 +131,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "label",
+        "type": "text",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -69,6 +145,17 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "text",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "passage",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -79,6 +166,13 @@
       "default"
     ],
     "merged": true,
+    "parameters": [
+      {
+        "name": "expression",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -101,6 +195,13 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "delay",
+        "type": "delay",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -162,6 +263,17 @@
     "block": true,
     "subMacros": [],
     "interpolate": true,
+    "parameters": [
+      {
+        "name": "label",
+        "type": "text",
+        "required": true
+      },
+      {
+        "name": "noclose",
+        "type": "flag"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -182,6 +294,17 @@
     "subMacros": [],
     "interpolate": true,
     "merged": true,
+    "parameters": [
+      {
+        "name": "inline",
+        "type": "flag"
+      },
+      {
+        "name": "passage",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -195,12 +318,26 @@
     "block": false,
     "subMacros": [],
     "merged": true,
+    "parameters": [
+      {
+        "name": "passage",
+        "type": "expression",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
     "name": "unset",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -208,6 +345,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -215,6 +363,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -222,6 +381,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "placeholder",
+        "type": "string"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -229,6 +399,17 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "text"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -236,6 +417,22 @@
     "block": false,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      },
+      {
+        "name": "value",
+        "type": "text",
+        "required": true
+      },
+      {
+        "name": "label",
+        "type": "text"
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -245,6 +442,13 @@
       "option"
     ],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -252,6 +456,13 @@
     "block": true,
     "subMacros": [],
     "storeVar": true,
+    "parameters": [
+      {
+        "name": "variable",
+        "type": "variable",
+        "required": true
+      }
+    ],
     "source": "builtin"
   },
   {
@@ -271,12 +482,56 @@
     "name": "watch",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "condition",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "options",
+        "type": "options",
+        "parameters": [
+          {
+            "name": "goto",
+            "type": "string"
+          },
+          {
+            "name": "dialog",
+            "type": "string"
+          },
+          {
+            "name": "run",
+            "type": "string"
+          },
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "priority",
+            "type": "number"
+          },
+          {
+            "name": "once",
+            "type": "flag"
+          }
+        ]
+      }
+    ],
     "source": "builtin"
   },
   {
     "name": "unwatch",
     "block": false,
     "subMacros": [],
+    "parameters": [
+      {
+        "name": "name",
+        "type": "text",
+        "required": true
+      }
+    ],
     "source": "builtin"
   }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rohal12/spindle",
-  "version": "0.52.5",
+  "version": "0.52.6",
   "type": "module",
   "description": "A Preact-based story format for Twine 2.",
   "license": "Unlicense",

package/src/components/macros/Button.tsx

@@ -1,15 +1,13 @@
 import { defineMacro } from '../../define-macro';
-import { readWholeQuoted } from './arg-utils';
 import { useDetachedBody } from './detached-body';
 
 defineMacro({
   name: 'button',
   block: true,
   interpolate: true,
+  parameters: [{ name: 'label', type: 'text', required: true }],
   render({ rawArgs, children = [] }, ctx) {
-    const text =
-      readWholeQuoted(rawArgs.trim()) ?? rawArgs.replace(/^["']|["']$/g, '');
-    const label = ctx.resolve?.(text) ?? rawArgs;
+    const label = ctx.resolve?.(ctx.args.label ?? '') ?? rawArgs;
     const runBody = useDetachedBody();
 
     // Run the body outside the passage tree: all macro side effects ({set},

package/src/components/macros/Checkbox.tsx

@@ -1,21 +1,14 @@
 import { defineMacro } from '../../define-macro';
-import { readWholeQuoted, stripLooseQuotes } from './arg-utils';
-
-export function parseCheckboxLabel(rawArgs: string): string {
-  // `s`: a quoted label may span lines. Its trailing whitespace is trimmed
-  // here, not by the regex: `(.+?)\s*$` tries every position of a run of
-  // spaces in the label, taking time quadratic in its length.
-  const match = rawArgs.match(/^\s*["']?\$?[\w.]+["']?\s+(.+)$/s);
-  if (!match) return '';
-  const rest = match[1]!.trimEnd() || match[1]!;
-  return readWholeQuoted(rest) ?? stripLooseQuotes(rest);
-}
 
 defineMacro({
   name: 'checkbox',
   storeVar: true,
-  render({ rawArgs }, ctx) {
-    const label = parseCheckboxLabel(rawArgs);
+  parameters: [
+    { name: 'variable', type: 'variable', required: true },
+    { name: 'label', type: 'text' },
+  ],
+  render(_props, ctx) {
+    const label = ctx.args.label ?? '';
 
     ctx.useAction({
       type: 'checkbox',

package/src/components/macros/Computed.tsx

@@ -2,9 +2,8 @@ import { useStoryStore } from '../../store';
 import { evaluate } from '../../expression';
 import { readState } from '../../execute-mutation';
 import { deepEqual } from '../../class-registry';
-import { currentSourceLocation } from '../../utils/source-location';
 import { defineMacro } from '../../define-macro';
-import { MacroError } from './MacroError';
+import { MacroError, logMacroError } from './MacroError';
 import { checkVariableName } from '../../utils/namespace';
 
 /**
@@ -14,38 +13,26 @@ import { checkVariableName } from '../../utils/namespace';
  */
 const UNSET: unique symbol = Symbol('unset');
 
-function parseComputedArgs(rawArgs: string): { target: string; expr: string } {
-  const trimmed = rawArgs.trim();
-
-  let depth = 0;
-  for (let i = 0; i < trimmed.length; i++) {
-    const ch = trimmed[i];
-    if (ch === '(' || ch === '[' || ch === '{') depth++;
-    else if (ch === ')' || ch === ']' || ch === '}') depth--;
-    else if (ch === '=' && depth === 0) {
-      if (trimmed[i + 1] === '=') {
-        i++;
-        continue;
-      }
-      if (i > 0 && trimmed[i - 1] === '!') continue;
-
-      const target = trimmed.slice(0, i).trim();
-      const expr = trimmed.slice(i + 1).trim();
-
-      if (!target.match(/^[$_@]\w+$/)) {
-        throw new Error(
-          `{computed}: target must be $name, _name, or @name, got "${target}"`,
-        );
-      }
+/** Check the arguments of "target = expression". */
+function assignmentArgs(
+  rawArgs: string,
+  args: { target?: string; '=': boolean; expression?: string },
+): { target: string; expr: string } {
+  if (!args['=']) {
+    throw new Error(
+      `{computed}: expected "target = expression", got "${rawArgs}"`,
+    );
+  }
 
-      checkVariableName(target.slice(1), target);
-      return { target, expr };
-    }
+  const { target = '', expression: expr = '' } = args;
+  if (!target.match(/^[$_@]\w+$/)) {
+    throw new Error(
+      `{computed}: target must be $name, _name, or @name, got "${target}"`,
+    );
   }
 
-  throw new Error(
-    `{computed}: expected "target = expression", got "${rawArgs}"`,
-  );
+  checkVariableName(target.slice(1), target);
+  return { target, expr };
 }
 
 /**
@@ -73,10 +60,7 @@ function computeAndApply(
     const { variables, temporary, transient } = readState();
     newValue = evaluate(expr, variables, temporary, getLocals(), transient);
   } catch (err) {
-    console.error(
-      `spindle: Error in {computed ${rawArgs}}${currentSourceLocation()}:`,
-      err,
-    );
+    logMacroError(`computed ${rawArgs}`, err);
     return;
   }
 
@@ -86,10 +70,7 @@ function computeAndApply(
       try {
         localsUpdate!(name, newValue);
       } catch (err) {
-        console.error(
-          `spindle: Error in {computed ${rawArgs}}${currentSourceLocation()}:`,
-          err,
-        );
+        logMacroError(`computed ${rawArgs}`, err);
       }
     } else {
       const state = useStoryStore.getState();
@@ -102,13 +83,18 @@ function computeAndApply(
 defineMacro({
   name: 'computed',
   merged: true,
+  parameters: [
+    { name: 'target', type: 'variable', required: true },
+    { name: '=', type: 'separator' },
+    { name: 'expression', type: 'expression', required: true },
+  ],
   render({ rawArgs }, ctx) {
     const [mergedVars, mergedTemps, mergedLocals, mergedTrans] = ctx.merged!;
 
     let target: string;
     let expr: string;
     try {
-      ({ target, expr } = parseComputedArgs(rawArgs));
+      ({ target, expr } = assignmentArgs(rawArgs, ctx.args));
     } catch (err) {
       return (
         <MacroError
@@ -124,9 +110,7 @@ defineMacro({
 
     const prevOutput = ctx.hooks.useRef<unknown>(UNSET);
 
-    const ran = ctx.hooks.useRef(false);
-    if (!ran.current) {
-      ran.current = true;
+    const compute = () =>
       computeAndApply(
         expr,
         name,
@@ -137,22 +121,21 @@ defineMacro({
         prevOutput,
         localsUpdate,
       );
+
+    const ran = ctx.hooks.useRef(false);
+    if (!ran.current) {
+      ran.current = true;
+      compute();
     }
 
     // The merged values only decide when to recompute; computeAndApply reads
     // the current ones.
-    ctx.hooks.useLayoutEffect(() => {
-      computeAndApply(
-        expr,
-        name,
-        isTemp,
-        isLocal,
-        ctx.getValues,
-        rawArgs,
-        prevOutput,
-        localsUpdate,
-      );
-    }, [mergedVars, mergedTemps, mergedLocals, mergedTrans]);
+    ctx.hooks.useLayoutEffect(compute, [
+      mergedVars,
+      mergedTemps,
+      mergedLocals,
+      mergedTrans,
+    ]);
 
     return null;
   },

package/src/components/macros/Cycle.tsx

@@ -4,6 +4,7 @@ defineMacro({
   name: 'cycle',
   block: true,
   storeVar: true,
+  parameters: [{ name: 'variable', type: 'variable', required: true }],
   render({ children = [] }, ctx) {
     const options = ctx.extractOptions(children);
 

package/src/components/macros/Dialog.tsx

@@ -1,20 +1,19 @@
 import { defineMacro } from '../../define-macro';
 import { PassageDialog } from '../PassageDialog';
-import { readWholeQuoted } from './arg-utils';
 
 defineMacro({
   name: 'dialog',
   block: true,
   interpolate: true,
-  render({ rawArgs, children = [] }, ctx) {
+  parameters: [
+    { name: 'label', type: 'text', required: true },
+    { name: 'noclose', type: 'flag' },
+  ],
+  render({ children = [] }, ctx) {
     const [open, setOpen] = ctx.hooks.useState(false);
 
-    const noclose = /\bnoclose\s*$/.test(rawArgs);
-    const labelRaw = rawArgs.replace(/\bnoclose\s*$/, '').trim();
-    const label =
-      ctx.resolve?.(
-        readWholeQuoted(labelRaw) ?? labelRaw.replace(/^["']|["']$/g, ''),
-      ) ?? labelRaw;
+    const { noclose } = ctx.args;
+    const label = ctx.resolve!(ctx.args.label ?? '');
     const passageName = ctx
       .collectText(children)
       .trim()

package/src/components/macros/Do.tsx

@@ -1,4 +1,5 @@
 import { defineMacro } from '../../define-macro';
+import { logMacroError } from './MacroError';
 
 defineMacro({
   name: 'do',
@@ -11,7 +12,7 @@ defineMacro({
       try {
         ctx.mutate(code);
       } catch (err) {
-        console.error(`spindle: Error in {do}${ctx.sourceLocation()}:`, err);
+        logMacroError('do', err);
       }
     }, []);