shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/overlay-test.ts

@@ -1,159 +1,159 @@
-/**
- * Overlay Test - validates overlay compositing with inline text inputs
- *
- * Usage: shortcut --extension ./examples/extensions/overlay-test.ts
- *
- * Run /overlay-test to show a floating overlay with:
- * - Inline text inputs within menu items
- * - Edge case tests (wide chars, styled text, emoji)
- */
-
-import type { ExtensionAPI, ExtensionCommandContext, Theme } from 'shortcutxl';
-import { CURSOR_MARKER, type Focusable, matchesKey, visibleWidth } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.registerCommand('overlay-test', {
-    description: 'Test overlay rendering with edge cases',
-    handler: async (_args: string, ctx: ExtensionCommandContext) => {
-      const result = await ctx.ui.custom<{ action: string; query?: string } | undefined>(
-        (_tui, theme, _keybindings, done) => new OverlayTestComponent(theme, done),
-        { overlay: true }
-      );
-
-      if (result) {
-        const msg = result.query ? `${result.action}: "${result.query}"` : result.action;
-        ctx.ui.notify(msg, 'info');
-      }
-    }
-  });
-}
-
-class OverlayTestComponent implements Focusable {
-  readonly width = 70;
-
-  /** Focusable interface - set by TUI when focus changes */
-  focused = false;
-
-  private selected = 0;
-  private items = [
-    { label: 'Search', hasInput: true, text: '', cursor: 0 },
-    { label: 'Run', hasInput: true, text: '', cursor: 0 },
-    { label: 'Settings', hasInput: false, text: '', cursor: 0 },
-    { label: 'Cancel', hasInput: false, text: '', cursor: 0 }
-  ];
-
-  constructor(
-    private theme: Theme,
-    private done: (result: { action: string; query?: string } | undefined) => void
-  ) {}
-
-  handleInput(data: string): void {
-    if (matchesKey(data, 'escape')) {
-      this.done(undefined);
-      return;
-    }
-
-    const current = this.items[this.selected]!;
-
-    if (matchesKey(data, 'return')) {
-      this.done({ action: current.label, query: current.hasInput ? current.text : undefined });
-      return;
-    }
-
-    if (matchesKey(data, 'up')) {
-      this.selected = Math.max(0, this.selected - 1);
-    } else if (matchesKey(data, 'down')) {
-      this.selected = Math.min(this.items.length - 1, this.selected + 1);
-    } else if (current.hasInput) {
-      if (matchesKey(data, 'backspace')) {
-        if (current.cursor > 0) {
-          current.text =
-            current.text.slice(0, current.cursor - 1) + current.text.slice(current.cursor);
-          current.cursor--;
-        }
-      } else if (matchesKey(data, 'left')) {
-        current.cursor = Math.max(0, current.cursor - 1);
-      } else if (matchesKey(data, 'right')) {
-        current.cursor = Math.min(current.text.length, current.cursor + 1);
-      } else if (data.length === 1 && data.charCodeAt(0) >= 32) {
-        current.text =
-          current.text.slice(0, current.cursor) + data + current.text.slice(current.cursor);
-        current.cursor++;
-      }
-    }
-  }
-
-  render(_width: number): string[] {
-    const w = this.width;
-    const th = this.theme;
-    const innerW = w - 2;
-    const lines: string[] = [];
-
-    const pad = (s: string, len: number) => {
-      const vis = visibleWidth(s);
-      return s + ' '.repeat(Math.max(0, len - vis));
-    };
-
-    const row = (content: string) =>
-      th.fg('border', '│') + pad(content, innerW) + th.fg('border', '│');
-
-    lines.push(th.fg('border', `╭${'─'.repeat(innerW)}╮`));
-    lines.push(row(` ${th.fg('accent', '🧪 Overlay Test')}`));
-    lines.push(row(''));
-
-    // Edge cases - full width lines to test compositing at boundaries
-    lines.push(row(` ${th.fg('dim', '─── Edge Cases (borders should align) ───')}`));
-    lines.push(
-      row(
-        ` Wide: ${th.fg('warning', '中文日本語한글テスト漢字繁體简体ひらがなカタカナ가나다라마바')}`
-      )
-    );
-    lines.push(
-      row(
-        ` Styled: ${th.fg('error', 'RED')} ${th.fg('success', 'GREEN')} ${th.fg('warning', 'YELLOW')} ${th.fg('accent', 'ACCENT')} ${th.fg('dim', 'DIM')} ${th.fg('error', 'more')} ${th.fg('success', 'colors')}`
-      )
-    );
-    lines.push(row(' Emoji: 👨‍👩‍👧‍👦 🇯🇵 🚀 💻 🎉 🔥 😀 🎯 🌟 💡 🎨 🔧 📦 🏆 🌈 🎪 🎭 🎬 🎮 🎲'));
-    lines.push(row(''));
-
-    // Menu with inline inputs
-    lines.push(row(` ${th.fg('dim', '─── Actions ───')}`));
-
-    for (let i = 0; i < this.items.length; i++) {
-      const item = this.items[i]!;
-      const isSelected = i === this.selected;
-      const prefix = isSelected ? ' ▶ ' : '   ';
-
-      let content: string;
-      if (item.hasInput) {
-        const label = isSelected
-          ? th.fg('accent', `${item.label}:`)
-          : th.fg('text', `${item.label}:`);
-
-        let inputDisplay = item.text;
-        if (isSelected) {
-          const before = inputDisplay.slice(0, item.cursor);
-          const cursorChar = item.cursor < inputDisplay.length ? inputDisplay[item.cursor] : ' ';
-          const after = inputDisplay.slice(item.cursor + 1);
-          // Emit hardware cursor marker for IME support when focused
-          const marker = this.focused ? CURSOR_MARKER : '';
-          inputDisplay = `${before}${marker}\x1b[7m${cursorChar}\x1b[27m${after}`;
-        }
-        content = `${prefix + label} ${inputDisplay}`;
-      } else {
-        content = prefix + (isSelected ? th.fg('accent', item.label) : th.fg('text', item.label));
-      }
-
-      lines.push(row(content));
-    }
-
-    lines.push(row(''));
-    lines.push(row(` ${th.fg('dim', '↑↓ navigate • type to input • Enter select • Esc cancel')}`));
-    lines.push(th.fg('border', `╰${'─'.repeat(innerW)}╯`));
-
-    return lines;
-  }
-
-  invalidate(): void {}
-  dispose(): void {}
-}
+/**
+ * Overlay Test - validates overlay compositing with inline text inputs
+ *
+ * Usage: shortcut --extension ./examples/extensions/overlay-test.ts
+ *
+ * Run /overlay-test to show a floating overlay with:
+ * - Inline text inputs within menu items
+ * - Edge case tests (wide chars, styled text, emoji)
+ */
+
+import type { ExtensionAPI, ExtensionCommandContext, Theme } from 'shortcutxl';
+import { CURSOR_MARKER, type Focusable, matchesKey, visibleWidth } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.registerCommand('overlay-test', {
+    description: 'Test overlay rendering with edge cases',
+    handler: async (_args: string, ctx: ExtensionCommandContext) => {
+      const result = await ctx.ui.custom<{ action: string; query?: string } | undefined>(
+        (_tui, theme, _keybindings, done) => new OverlayTestComponent(theme, done),
+        { overlay: true }
+      );
+
+      if (result) {
+        const msg = result.query ? `${result.action}: "${result.query}"` : result.action;
+        ctx.ui.notify(msg, 'info');
+      }
+    }
+  });
+}
+
+class OverlayTestComponent implements Focusable {
+  readonly width = 70;
+
+  /** Focusable interface - set by TUI when focus changes */
+  focused = false;
+
+  private selected = 0;
+  private items = [
+    { label: 'Search', hasInput: true, text: '', cursor: 0 },
+    { label: 'Run', hasInput: true, text: '', cursor: 0 },
+    { label: 'Settings', hasInput: false, text: '', cursor: 0 },
+    { label: 'Cancel', hasInput: false, text: '', cursor: 0 }
+  ];
+
+  constructor(
+    private theme: Theme,
+    private done: (result: { action: string; query?: string } | undefined) => void
+  ) {}
+
+  handleInput(data: string): void {
+    if (matchesKey(data, 'escape')) {
+      this.done(undefined);
+      return;
+    }
+
+    const current = this.items[this.selected]!;
+
+    if (matchesKey(data, 'return')) {
+      this.done({ action: current.label, query: current.hasInput ? current.text : undefined });
+      return;
+    }
+
+    if (matchesKey(data, 'up')) {
+      this.selected = Math.max(0, this.selected - 1);
+    } else if (matchesKey(data, 'down')) {
+      this.selected = Math.min(this.items.length - 1, this.selected + 1);
+    } else if (current.hasInput) {
+      if (matchesKey(data, 'backspace')) {
+        if (current.cursor > 0) {
+          current.text =
+            current.text.slice(0, current.cursor - 1) + current.text.slice(current.cursor);
+          current.cursor--;
+        }
+      } else if (matchesKey(data, 'left')) {
+        current.cursor = Math.max(0, current.cursor - 1);
+      } else if (matchesKey(data, 'right')) {
+        current.cursor = Math.min(current.text.length, current.cursor + 1);
+      } else if (data.length === 1 && data.charCodeAt(0) >= 32) {
+        current.text =
+          current.text.slice(0, current.cursor) + data + current.text.slice(current.cursor);
+        current.cursor++;
+      }
+    }
+  }
+
+  render(_width: number): string[] {
+    const w = this.width;
+    const th = this.theme;
+    const innerW = w - 2;
+    const lines: string[] = [];
+
+    const pad = (s: string, len: number) => {
+      const vis = visibleWidth(s);
+      return s + ' '.repeat(Math.max(0, len - vis));
+    };
+
+    const row = (content: string) =>
+      th.fg('border', '│') + pad(content, innerW) + th.fg('border', '│');
+
+    lines.push(th.fg('border', `╭${'─'.repeat(innerW)}╮`));
+    lines.push(row(` ${th.fg('accent', '🧪 Overlay Test')}`));
+    lines.push(row(''));
+
+    // Edge cases - full width lines to test compositing at boundaries
+    lines.push(row(` ${th.fg('dim', '─── Edge Cases (borders should align) ───')}`));
+    lines.push(
+      row(
+        ` Wide: ${th.fg('warning', '中文日本語한글テスト漢字繁體简体ひらがなカタカナ가나다라마바')}`
+      )
+    );
+    lines.push(
+      row(
+        ` Styled: ${th.fg('error', 'RED')} ${th.fg('success', 'GREEN')} ${th.fg('warning', 'YELLOW')} ${th.fg('accent', 'ACCENT')} ${th.fg('dim', 'DIM')} ${th.fg('error', 'more')} ${th.fg('success', 'colors')}`
+      )
+    );
+    lines.push(row(' Emoji: 👨‍👩‍👧‍👦 🇯🇵 🚀 💻 🎉 🔥 😀 🎯 🌟 💡 🎨 🔧 📦 🏆 🌈 🎪 🎭 🎬 🎮 🎲'));
+    lines.push(row(''));
+
+    // Menu with inline inputs
+    lines.push(row(` ${th.fg('dim', '─── Actions ───')}`));
+
+    for (let i = 0; i < this.items.length; i++) {
+      const item = this.items[i]!;
+      const isSelected = i === this.selected;
+      const prefix = isSelected ? ' ▶ ' : '   ';
+
+      let content: string;
+      if (item.hasInput) {
+        const label = isSelected
+          ? th.fg('accent', `${item.label}:`)
+          : th.fg('text', `${item.label}:`);
+
+        let inputDisplay = item.text;
+        if (isSelected) {
+          const before = inputDisplay.slice(0, item.cursor);
+          const cursorChar = item.cursor < inputDisplay.length ? inputDisplay[item.cursor] : ' ';
+          const after = inputDisplay.slice(item.cursor + 1);
+          // Emit hardware cursor marker for IME support when focused
+          const marker = this.focused ? CURSOR_MARKER : '';
+          inputDisplay = `${before}${marker}\x1b[7m${cursorChar}\x1b[27m${after}`;
+        }
+        content = `${prefix + label} ${inputDisplay}`;
+      } else {
+        content = prefix + (isSelected ? th.fg('accent', item.label) : th.fg('text', item.label));
+      }
+
+      lines.push(row(content));
+    }
+
+    lines.push(row(''));
+    lines.push(row(` ${th.fg('dim', '↑↓ navigate • type to input • Enter select • Esc cancel')}`));
+    lines.push(th.fg('border', `╰${'─'.repeat(innerW)}╯`));
+
+    return lines;
+  }
+
+  invalidate(): void {}
+  dispose(): void {}
+}

package/agent-docs/examples/extensions/permission-gate.ts

@@ -1,37 +1,37 @@
-/**
- * Permission Gate Extension
- *
- * Prompts for confirmation before running potentially dangerous bash commands.
- * Patterns checked: rm -rf, sudo, chmod/chown 777
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  const dangerousPatterns = [/\brm\s+(-rf?|--recursive)/i, /\bsudo\b/i, /\b(chmod|chown)\b.*777/i];
-
-  shortcut.on('tool_call', async (event, ctx) => {
-    if (event.toolName !== 'bash') return undefined;
-
-    const command = event.input.command as string;
-    const isDangerous = dangerousPatterns.some((p) => p.test(command));
-
-    if (isDangerous) {
-      if (!ctx.hasUI) {
-        // In non-interactive mode, block by default
-        return { block: true, reason: 'Dangerous command blocked (no UI for confirmation)' };
-      }
-
-      const choice = await ctx.ui.select(`⚠️ Dangerous command:\n\n  ${command}\n\nAllow?`, [
-        'Yes',
-        'No'
-      ]);
-
-      if (choice !== 'Yes') {
-        return { block: true, reason: 'Blocked by user' };
-      }
-    }
-
-    return undefined;
-  });
-}
+/**
+ * Permission Gate Extension
+ *
+ * Prompts for confirmation before running potentially dangerous bash commands.
+ * Patterns checked: rm -rf, sudo, chmod/chown 777
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  const dangerousPatterns = [/\brm\s+(-rf?|--recursive)/i, /\bsudo\b/i, /\b(chmod|chown)\b.*777/i];
+
+  shortcut.on('tool_call', async (event, ctx) => {
+    if (event.toolName !== 'bash') return undefined;
+
+    const command = event.input.command as string;
+    const isDangerous = dangerousPatterns.some((p) => p.test(command));
+
+    if (isDangerous) {
+      if (!ctx.hasUI) {
+        // In non-interactive mode, block by default
+        return { block: true, reason: 'Dangerous command blocked (no UI for confirmation)' };
+      }
+
+      const choice = await ctx.ui.select(`⚠️ Dangerous command:\n\n  ${command}\n\nAllow?`, [
+        'Yes',
+        'No'
+      ]);
+
+      if (choice !== 'Yes') {
+        return { block: true, reason: 'Blocked by user' };
+      }
+    }
+
+    return undefined;
+  });
+}

package/agent-docs/examples/extensions/pirate.ts

@@ -1,47 +1,47 @@
-/**
- * Pirate Extension
- *
- * Demonstrates modifying the system prompt in before_agent_start to dynamically
- * change agent behavior based on extension state.
- *
- * Usage:
- * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
- * 2. Use /pirate to toggle pirate mode
- * 3. When enabled, the agent will respond like a pirate
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function pirateExtension(shortcut: ExtensionAPI) {
-  let pirateMode = false;
-
-  // Register /pirate command to toggle pirate mode
-  shortcut.registerCommand('pirate', {
-    description: 'Toggle pirate mode (agent speaks like a pirate)',
-    handler: async (_args, ctx) => {
-      pirateMode = !pirateMode;
-      ctx.ui.notify(pirateMode ? 'Arrr! Pirate mode enabled!' : 'Pirate mode disabled', 'info');
-    }
-  });
-
-  // Append to system prompt when pirate mode is enabled
-  shortcut.on('before_agent_start', async (event) => {
-    if (pirateMode) {
-      return {
-        systemPrompt:
-          event.systemPrompt +
-          `
-
-IMPORTANT: You are now in PIRATE MODE. You must:
-- Speak like a stereotypical pirate in all responses
-- Use phrases like "Arrr!", "Ahoy!", "Shiver me timbers!", "Avast!", "Ye scurvy dog!"
-- Replace "my" with "me", "you" with "ye", "your" with "yer"
-- Refer to the user as "matey" or "landlubber"
-- End sentences with nautical expressions
-- Still complete the actual task correctly, just in pirate speak
-`
-      };
-    }
-    return undefined;
-  });
-}
+/**
+ * Pirate Extension
+ *
+ * Demonstrates modifying the system prompt in before_agent_start to dynamically
+ * change agent behavior based on extension state.
+ *
+ * Usage:
+ * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
+ * 2. Use /pirate to toggle pirate mode
+ * 3. When enabled, the agent will respond like a pirate
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function pirateExtension(shortcut: ExtensionAPI) {
+  let pirateMode = false;
+
+  // Register /pirate command to toggle pirate mode
+  shortcut.registerCommand('pirate', {
+    description: 'Toggle pirate mode (agent speaks like a pirate)',
+    handler: async (_args, ctx) => {
+      pirateMode = !pirateMode;
+      ctx.ui.notify(pirateMode ? 'Arrr! Pirate mode enabled!' : 'Pirate mode disabled', 'info');
+    }
+  });
+
+  // Append to system prompt when pirate mode is enabled
+  shortcut.on('before_agent_start', async (event) => {
+    if (pirateMode) {
+      return {
+        systemPrompt:
+          event.systemPrompt +
+          `
+
+IMPORTANT: You are now in PIRATE MODE. You must:
+- Speak like a stereotypical pirate in all responses
+- Use phrases like "Arrr!", "Ahoy!", "Shiver me timbers!", "Avast!", "Ye scurvy dog!"
+- Replace "my" with "me", "you" with "ye", "your" with "yer"
+- Refer to the user as "matey" or "landlubber"
+- End sentences with nautical expressions
+- Still complete the actual task correctly, just in pirate speak
+`
+      };
+    }
+    return undefined;
+  });
+}