@ridit/lens 0.2.0 → 0.2.2

package/src/utils/tools/registry.ts

@@ -0,0 +1,119 @@
+// ── Tool Plugin System ────────────────────────────────────────────────────────
+//
+// To create a new tool:
+//
+//   1. Implement the Tool interface
+//   2. Call registry.register(myTool) before the app starts
+//
+// External addon example:
+//
+//   import { registry } from "lens/tools/registry";
+//   registry.register({ name: "my-tool", ... });
+
+export interface ToolContext {
+  repoPath: string;
+  /** All messages in the current conversation so far */
+  messages: unknown[];
+}
+
+export type ToolResult =
+  | { kind: "text"; value: string }
+  | { kind: "error"; value: string };
+
+export interface Tool<TInput = string> {
+  /**
+   * Tag name used in XML: <name>...</name>
+   * Must be lowercase, hyphens allowed. Must be unique.
+   */
+  name: string;
+
+  /**
+   * Short description shown in system prompt and /help.
+   */
+  description: string;
+
+  /**
+   * System prompt snippet explaining how to invoke this tool.
+   * Return the full ### N. name — description block.
+   */
+  systemPromptEntry(index: number): string;
+
+  /**
+   * Parse the raw inner text of the XML tag into a typed input.
+   * Throw or return null to signal a parse failure (tool will be skipped).
+   */
+  parseInput(body: string): TInput | null;
+
+  /**
+   * Execute the tool. May be async.
+   * Return a ToolResult — the value is fed back to the model as the tool result.
+   */
+  execute(input: TInput, ctx: ToolContext): Promise<ToolResult> | ToolResult;
+
+  /**
+   * Whether this tool is safe to auto-approve (read-only, no side effects).
+   * Defaults to false.
+   */
+  safe?: boolean;
+
+  /**
+   * Optional: permission prompt label shown to the user before execution.
+   * e.g. "run", "read", "write", "delete"
+   * Defaults to the tool name.
+   */
+  permissionLabel?: string;
+
+  /**
+   * Optional: summarise the input for display in the chat history.
+   * Defaults to showing the raw input string.
+   */
+  summariseInput?(input: TInput): string;
+}
+
+// ── Registry ──────────────────────────────────────────────────────────────────
+
+class ToolRegistry {
+  private tools = new Map<string, Tool<unknown>>();
+
+  register<T>(tool: Tool<T>): void {
+    if (this.tools.has(tool.name)) {
+      console.warn(`[ToolRegistry] Overwriting existing tool: "${tool.name}"`);
+    }
+    this.tools.set(tool.name, tool as Tool<unknown>);
+  }
+
+  unregister(name: string): void {
+    this.tools.delete(name);
+  }
+
+  get(name: string): Tool<unknown> | undefined {
+    return this.tools.get(name);
+  }
+
+  all(): Tool<unknown>[] {
+    return Array.from(this.tools.values());
+  }
+
+  names(): string[] {
+    return Array.from(this.tools.keys());
+  }
+
+  /**
+   * Build the TOOLS section of the system prompt from all registered tools.
+   */
+  buildSystemPromptSection(): string {
+    const lines: string[] = ["## TOOLS\n"];
+    lines.push(
+      "You have exactly " +
+        this.tools.size +
+        " tools. To use a tool you MUST wrap it in the exact XML tags shown below — no other format will work.\n",
+    );
+    let i = 1;
+    for (const tool of this.tools.values()) {
+      lines.push(tool.systemPromptEntry(i++));
+    }
+    return lines.join("\n");
+  }
+}
+
+export const registry = new ToolRegistry();

package/src/utils/history.ts

@@ -1,86 +0,0 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
-import path from "path";
-import os from "os";
-
-export type HistoryEntryKind =
-  | "file-written"
-  | "file-read"
-  | "url-fetched"
-  | "shell-run"
-  | "code-applied"
-  | "code-skipped";
-
-export type HistoryEntry = {
-  kind: HistoryEntryKind;
-  detail: string;
-  summary: string;
-  timestamp: string;
-  repoPath: string;
-};
-
-export type HistoryFile = {
-  entries: HistoryEntry[];
-};
-
-const LENS_DIR = path.join(os.homedir(), ".lens");
-const HISTORY_PATH = path.join(LENS_DIR, "history.json");
-
-function loadHistory(): HistoryFile {
-  if (!existsSync(HISTORY_PATH)) return { entries: [] };
-  try {
-    return JSON.parse(readFileSync(HISTORY_PATH, "utf-8")) as HistoryFile;
-  } catch {
-    return { entries: [] };
-  }
-}
-
-function saveHistory(h: HistoryFile): void {
-  if (!existsSync(LENS_DIR)) mkdirSync(LENS_DIR, { recursive: true });
-  writeFileSync(HISTORY_PATH, JSON.stringify(h, null, 2), "utf-8");
-}
-
-export function appendHistory(entry: Omit<HistoryEntry, "timestamp">): void {
-  const h = loadHistory();
-  h.entries.push({ ...entry, timestamp: new Date().toISOString() });
-
-  if (h.entries.length > 500) h.entries = h.entries.slice(-500);
-  saveHistory(h);
-}
-
-/**
- * Returns a compact summary string to inject into the system prompt.
- * Only includes entries for the current repo, most recent 50.
- */
-export function buildHistorySummary(repoPath: string): string {
-  const h = loadHistory();
-  const relevant = h.entries.filter((e) => e.repoPath === repoPath).slice(-50);
-
-  if (relevant.length === 0) return "";
-
-  const lines = relevant.map((e) => {
-    const ts = new Date(e.timestamp).toLocaleString();
-    return `[${ts}] ${e.kind}: ${e.detail} — ${e.summary}`;
-  });
-
-  return `## WHAT YOU HAVE ALREADY DONE IN THIS REPO
-
-The following actions have already been completed. Do NOT repeat them unless the user explicitly asks you to redo something:
-
-${lines.join("\n")}`;
-}
-
-/**
- * Returns all entries for a repo, for display purposes.
- */
-export function getRepoHistory(repoPath: string): HistoryEntry[] {
-  return loadHistory().entries.filter((e) => e.repoPath === repoPath);
-}
-
-/**
- * Clears all history for a repo.
- */
-export function clearRepoHistory(repoPath: string): void {
-  const h = loadHistory();
-  h.entries = h.entries.filter((e) => e.repoPath !== repoPath);
-  saveHistory(h);
-}