shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/claude-rules.ts

@@ -1,86 +1,86 @@
-/**
- * Claude Rules Extension
- *
- * Scans the project's .claude/rules/ folder for rule files and lists them
- * in the system prompt. The agent can then use the read tool to load
- * specific rules when needed.
- *
- * Best practices for .claude/rules/:
- * - Keep rules focused: Each file should cover one topic (e.g., testing.md, api-design.md)
- * - Use descriptive filenames: The filename should indicate what the rules cover
- * - Use conditional rules sparingly: Only add paths frontmatter when rules truly apply to specific file types
- * - Organize with subdirectories: Group related rules (e.g., frontend/, backend/)
- *
- * Usage:
- * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
- * 2. Create .claude/rules/ folder in your project root
- * 3. Add .md files with your rules
- */
-
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import type { ExtensionAPI } from 'shortcutxl';
-
-/**
- * Recursively find all .md files in a directory
- */
-function findMarkdownFiles(dir: string, basePath: string = ''): string[] {
-  const results: string[] = [];
-
-  if (!fs.existsSync(dir)) {
-    return results;
-  }
-
-  const entries = fs.readdirSync(dir, { withFileTypes: true });
-
-  for (const entry of entries) {
-    const relativePath = basePath ? `${basePath}/${entry.name}` : entry.name;
-
-    if (entry.isDirectory()) {
-      results.push(...findMarkdownFiles(path.join(dir, entry.name), relativePath));
-    } else if (entry.isFile() && entry.name.endsWith('.md')) {
-      results.push(relativePath);
-    }
-  }
-
-  return results;
-}
-
-export default function claudeRulesExtension(shortcut: ExtensionAPI) {
-  let ruleFiles: string[] = [];
-  let rulesDir: string = '';
-
-  // Scan for rules on session start
-  shortcut.on('session_start', async (_event, ctx) => {
-    rulesDir = path.join(ctx.cwd, '.claude', 'rules');
-    ruleFiles = findMarkdownFiles(rulesDir);
-
-    if (ruleFiles.length > 0) {
-      ctx.ui.notify(`Found ${ruleFiles.length} rule(s) in .claude/rules/`, 'info');
-    }
-  });
-
-  // Append available rules to system prompt
-  shortcut.on('before_agent_start', async (event) => {
-    if (ruleFiles.length === 0) {
-      return;
-    }
-
-    const rulesList = ruleFiles.map((f) => `- .claude/rules/${f}`).join('\n');
-
-    return {
-      systemPrompt:
-        event.systemPrompt +
-        `
-
-## Project Rules
-
-The following project rules are available in .claude/rules/:
-
-${rulesList}
-
-When working on tasks related to these rules, use the read tool to load the relevant rule files for guidance.
-`
-    };
-  });
-}
+/**
+ * Claude Rules Extension
+ *
+ * Scans the project's .claude/rules/ folder for rule files and lists them
+ * in the system prompt. The agent can then use the read tool to load
+ * specific rules when needed.
+ *
+ * Best practices for .claude/rules/:
+ * - Keep rules focused: Each file should cover one topic (e.g., testing.md, api-design.md)
+ * - Use descriptive filenames: The filename should indicate what the rules cover
+ * - Use conditional rules sparingly: Only add paths frontmatter when rules truly apply to specific file types
+ * - Organize with subdirectories: Group related rules (e.g., frontend/, backend/)
+ *
+ * Usage:
+ * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
+ * 2. Create .claude/rules/ folder in your project root
+ * 3. Add .md files with your rules
+ */
+
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import type { ExtensionAPI } from 'shortcutxl';
+
+/**
+ * Recursively find all .md files in a directory
+ */
+function findMarkdownFiles(dir: string, basePath: string = ''): string[] {
+  const results: string[] = [];
+
+  if (!fs.existsSync(dir)) {
+    return results;
+  }
+
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const relativePath = basePath ? `${basePath}/${entry.name}` : entry.name;
+
+    if (entry.isDirectory()) {
+      results.push(...findMarkdownFiles(path.join(dir, entry.name), relativePath));
+    } else if (entry.isFile() && entry.name.endsWith('.md')) {
+      results.push(relativePath);
+    }
+  }
+
+  return results;
+}
+
+export default function claudeRulesExtension(shortcut: ExtensionAPI) {
+  let ruleFiles: string[] = [];
+  let rulesDir: string = '';
+
+  // Scan for rules on session start
+  shortcut.on('session_start', async (_event, ctx) => {
+    rulesDir = path.join(ctx.cwd, '.claude', 'rules');
+    ruleFiles = findMarkdownFiles(rulesDir);
+
+    if (ruleFiles.length > 0) {
+      ctx.ui.notify(`Found ${ruleFiles.length} rule(s) in .claude/rules/`, 'info');
+    }
+  });
+
+  // Append available rules to system prompt
+  shortcut.on('before_agent_start', async (event) => {
+    if (ruleFiles.length === 0) {
+      return;
+    }
+
+    const rulesList = ruleFiles.map((f) => `- .claude/rules/${f}`).join('\n');
+
+    return {
+      systemPrompt:
+        event.systemPrompt +
+        `
+
+## Project Rules
+
+The following project rules are available in .claude/rules/:
+
+${rulesList}
+
+When working on tasks related to these rules, use the read tool to load the relevant rule files for guidance.
+`
+    };
+  });
+}

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

@@ -1,75 +1,75 @@
-/**
- * Commands Extension
- *
- * Demonstrates the shortcut.getCommands() API by providing a /commands command
- * that lists all available slash commands in the current session.
- *
- * Usage:
- * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
- * 2. Use /commands to see available commands
- * 3. Use /commands extensions to filter by source
- */
-
-import type { ExtensionAPI, SlashCommandInfo } from 'shortcutxl';
-
-export default function commandsExtension(shortcut: ExtensionAPI) {
-  shortcut.registerCommand('commands', {
-    description: 'List available slash commands',
-    getArgumentCompletions: (prefix) => {
-      const sources = ['extension', 'prompt', 'skill'];
-      const filtered = sources.filter((s) => s.startsWith(prefix));
-      return filtered.length > 0 ? filtered.map((s) => ({ value: s, label: s })) : null;
-    },
-    handler: async (args, ctx) => {
-      const commands = shortcut.getCommands();
-      const sourceFilter = args.trim() as 'extension' | 'prompt' | 'skill' | '';
-
-      // Filter by source if specified
-      const filtered = sourceFilter ? commands.filter((c) => c.source === sourceFilter) : commands;
-
-      if (filtered.length === 0) {
-        ctx.ui.notify(
-          sourceFilter ? `No ${sourceFilter} commands found` : 'No commands found',
-          'info'
-        );
-        return;
-      }
-
-      // Build selection items grouped by source
-      const formatCommand = (cmd: SlashCommandInfo): string => {
-        const desc = cmd.description ? ` - ${cmd.description}` : '';
-        return `/${cmd.name}${desc}`;
-      };
-
-      const items: string[] = [];
-      const sources: Array<{ key: 'extension' | 'prompt' | 'skill'; label: string }> = [
-        { key: 'extension', label: 'Extensions' },
-        { key: 'prompt', label: 'Prompts' },
-        { key: 'skill', label: 'Skills' }
-      ];
-
-      for (const { key, label } of sources) {
-        const cmds = filtered.filter((c) => c.source === key);
-        if (cmds.length > 0) {
-          items.push(`--- ${label} ---`);
-          items.push(...cmds.map(formatCommand));
-        }
-      }
-
-      // Show in a selector (user can scroll and see all commands)
-      const selected = await ctx.ui.select('Available Commands', items);
-
-      // If user selected a command (not a header), offer to show its path
-      if (selected && !selected.startsWith('---')) {
-        const cmdName = selected.split(' - ')[0].slice(1); // Remove leading /
-        const cmd = commands.find((c) => c.name === cmdName);
-        if (cmd?.path) {
-          const showPath = await ctx.ui.confirm(cmd.name, `View source path?\n${cmd.path}`);
-          if (showPath) {
-            ctx.ui.notify(cmd.path, 'info');
-          }
-        }
-      }
-    }
-  });
-}
+/**
+ * Commands Extension
+ *
+ * Demonstrates the shortcut.getCommands() API by providing a /commands command
+ * that lists all available slash commands in the current session.
+ *
+ * Usage:
+ * 1. Copy this file to ~/.shortcut/agent/extensions/ or your project's .shortcut/extensions/
+ * 2. Use /commands to see available commands
+ * 3. Use /commands extensions to filter by source
+ */
+
+import type { ExtensionAPI, SlashCommandInfo } from 'shortcutxl';
+
+export default function commandsExtension(shortcut: ExtensionAPI) {
+  shortcut.registerCommand('commands', {
+    description: 'List available slash commands',
+    getArgumentCompletions: (prefix) => {
+      const sources = ['extension', 'prompt', 'skill'];
+      const filtered = sources.filter((s) => s.startsWith(prefix));
+      return filtered.length > 0 ? filtered.map((s) => ({ value: s, label: s })) : null;
+    },
+    handler: async (args, ctx) => {
+      const commands = shortcut.getCommands();
+      const sourceFilter = args.trim() as 'extension' | 'prompt' | 'skill' | '';
+
+      // Filter by source if specified
+      const filtered = sourceFilter ? commands.filter((c) => c.source === sourceFilter) : commands;
+
+      if (filtered.length === 0) {
+        ctx.ui.notify(
+          sourceFilter ? `No ${sourceFilter} commands found` : 'No commands found',
+          'info'
+        );
+        return;
+      }
+
+      // Build selection items grouped by source
+      const formatCommand = (cmd: SlashCommandInfo): string => {
+        const desc = cmd.description ? ` - ${cmd.description}` : '';
+        return `/${cmd.name}${desc}`;
+      };
+
+      const items: string[] = [];
+      const sources: Array<{ key: 'extension' | 'prompt' | 'skill'; label: string }> = [
+        { key: 'extension', label: 'Extensions' },
+        { key: 'prompt', label: 'Prompts' },
+        { key: 'skill', label: 'Skills' }
+      ];
+
+      for (const { key, label } of sources) {
+        const cmds = filtered.filter((c) => c.source === key);
+        if (cmds.length > 0) {
+          items.push(`--- ${label} ---`);
+          items.push(...cmds.map(formatCommand));
+        }
+      }
+
+      // Show in a selector (user can scroll and see all commands)
+      const selected = await ctx.ui.select('Available Commands', items);
+
+      // If user selected a command (not a header), offer to show its path
+      if (selected && !selected.startsWith('---')) {
+        const cmdName = selected.split(' - ')[0].slice(1); // Remove leading /
+        const cmd = commands.find((c) => c.name === cmdName);
+        if (cmd?.path) {
+          const showPath = await ctx.ui.confirm(cmd.name, `View source path?\n${cmd.path}`);
+          if (showPath) {
+            ctx.ui.notify(cmd.path, 'info');
+          }
+        }
+      }
+    }
+  });
+}

package/agent-docs/examples/extensions/confirm-destructive.ts

@@ -1,59 +1,59 @@
-/**
- * Confirm Destructive Actions Extension
- *
- * Prompts for confirmation before destructive session actions (clear, switch, branch).
- * Demonstrates how to cancel session events using the before_* events.
- */
-
-import type { ExtensionAPI, SessionBeforeSwitchEvent, SessionMessageEntry } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.on('session_before_switch', async (event: SessionBeforeSwitchEvent, ctx) => {
-    if (!ctx.hasUI) return;
-
-    if (event.reason === 'new') {
-      const confirmed = await ctx.ui.confirm(
-        'Clear session?',
-        'This will delete all messages in the current session.'
-      );
-
-      if (!confirmed) {
-        ctx.ui.notify('Clear cancelled', 'info');
-        return { cancel: true };
-      }
-      return;
-    }
-
-    // reason === "resume" - check if there are unsaved changes (messages since last assistant response)
-    const entries = ctx.sessionManager.getEntries();
-    const hasUnsavedWork = entries.some(
-      (e): e is SessionMessageEntry => e.type === 'message' && e.message.role === 'user'
-    );
-
-    if (hasUnsavedWork) {
-      const confirmed = await ctx.ui.confirm(
-        'Switch session?',
-        'You have messages in the current session. Switch anyway?'
-      );
-
-      if (!confirmed) {
-        ctx.ui.notify('Switch cancelled', 'info');
-        return { cancel: true };
-      }
-    }
-  });
-
-  shortcut.on('session_before_fork', async (event, ctx) => {
-    if (!ctx.hasUI) return;
-
-    const choice = await ctx.ui.select(`Fork from entry ${event.entryId.slice(0, 8)}?`, [
-      'Yes, create fork',
-      'No, stay in current session'
-    ]);
-
-    if (choice !== 'Yes, create fork') {
-      ctx.ui.notify('Fork cancelled', 'info');
-      return { cancel: true };
-    }
-  });
-}
+/**
+ * Confirm Destructive Actions Extension
+ *
+ * Prompts for confirmation before destructive session actions (clear, switch, branch).
+ * Demonstrates how to cancel session events using the before_* events.
+ */
+
+import type { ExtensionAPI, SessionBeforeSwitchEvent, SessionMessageEntry } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.on('session_before_switch', async (event: SessionBeforeSwitchEvent, ctx) => {
+    if (!ctx.hasUI) return;
+
+    if (event.reason === 'new') {
+      const confirmed = await ctx.ui.confirm(
+        'Clear session?',
+        'This will delete all messages in the current session.'
+      );
+
+      if (!confirmed) {
+        ctx.ui.notify('Clear cancelled', 'info');
+        return { cancel: true };
+      }
+      return;
+    }
+
+    // reason === "resume" - check if there are unsaved changes (messages since last assistant response)
+    const entries = ctx.sessionManager.getEntries();
+    const hasUnsavedWork = entries.some(
+      (e): e is SessionMessageEntry => e.type === 'message' && e.message.role === 'user'
+    );
+
+    if (hasUnsavedWork) {
+      const confirmed = await ctx.ui.confirm(
+        'Switch session?',
+        'You have messages in the current session. Switch anyway?'
+      );
+
+      if (!confirmed) {
+        ctx.ui.notify('Switch cancelled', 'info');
+        return { cancel: true };
+      }
+    }
+  });
+
+  shortcut.on('session_before_fork', async (event, ctx) => {
+    if (!ctx.hasUI) return;
+
+    const choice = await ctx.ui.select(`Fork from entry ${event.entryId.slice(0, 8)}?`, [
+      'Yes, create fork',
+      'No, stay in current session'
+    ]);
+
+    if (choice !== 'Yes, create fork') {
+      ctx.ui.notify('Fork cancelled', 'info');
+      return { cancel: true };
+    }
+  });
+}