import { createInterface } from "node:readline"; import type { AgentTool } from "@mariozechner/pi-ai"; import { Type } from "@sinclair/typebox"; import { spawn } from "child_process"; import { readFileSync, type Stats, statSync } from "fs"; import { homedir } from "os"; import path from "path"; import { ensureTool } from "../tools-manager.js"; import { DEFAULT_MAX_BYTES, type TruncationResult, truncateHead } from "./truncate.js"; /** * Expand ~ to home directory */ function expandPath(filePath: string): string { if (filePath === "~") { return homedir(); } if (filePath.startsWith("~/")) { return homedir() + filePath.slice(1); } return filePath; } const grepSchema = Type.Object({ pattern: Type.String({ description: "Search pattern (regex or literal string)" }), path: Type.Optional(Type.String({ description: "Directory or file to search (default: current directory)" })), glob: Type.Optional(Type.String({ description: "Filter files by glob pattern, e.g. '*.ts' or '**/*.spec.ts'" })), ignoreCase: Type.Optional(Type.Boolean({ description: "Case-insensitive search (default: false)" })), literal: Type.Optional( Type.Boolean({ description: "Treat pattern as literal string instead of regex (default: false)" }), ), context: Type.Optional( Type.Number({ description: "Number of lines to show before and after each match (default: 0)" }), ), limit: Type.Optional(Type.Number({ description: "Maximum number of matches to return (default: 100)" })), }); const DEFAULT_LIMIT = 100; interface GrepToolDetails { truncation?: TruncationResult; matchLimitReached?: number; } export const grepTool: AgentTool = { name: "grep", label: "grep", description: `Search file contents for a pattern. Returns matching lines with file paths and line numbers. Respects .gitignore. Output is truncated to ${DEFAULT_LIMIT} matches or ${DEFAULT_MAX_BYTES / 1024}KB (whichever is hit first).`, parameters: grepSchema, execute: async ( _toolCallId: string, { pattern, path: searchDir, glob, ignoreCase, literal, context, limit, }: { pattern: string; path?: string; glob?: string; ignoreCase?: boolean; literal?: boolean; context?: number; limit?: number; }, signal?: AbortSignal, ) => { return new Promise((resolve, reject) => { if (signal?.aborted) { reject(new Error("Operation aborted")); return; } let settled = false; const settle = (fn: () => void) => { if (!settled) { settled = true; fn(); } }; (async () => { try { const rgPath = await ensureTool("rg", true); if (!rgPath) { settle(() => reject(new Error("ripgrep (rg) is not available and could not be downloaded"))); return; } const searchPath = path.resolve(expandPath(searchDir || ".")); let searchStat: Stats; try { searchStat = statSync(searchPath); } catch (err) { settle(() => reject(new Error(`Path not found: ${searchPath}`))); return; } const isDirectory = searchStat.isDirectory(); const contextValue = context && context > 0 ? context : 0; const effectiveLimit = Math.max(1, limit ?? DEFAULT_LIMIT); const formatPath = (filePath: string): string => { if (isDirectory) { const relative = path.relative(searchPath, filePath); if (relative && !relative.startsWith("..")) { return relative.replace(/\\/g, "/"); } } return path.basename(filePath); }; const fileCache = new Map(); const getFileLines = (filePath: string): string[] => { let lines = fileCache.get(filePath); if (!lines) { try { const content = readFileSync(filePath, "utf-8"); lines = content.replace(/\r\n/g, "\n").replace(/\r/g, "\n").split("\n"); } catch { lines = []; } fileCache.set(filePath, lines); } return lines; }; const args: string[] = ["--json", "--line-number", "--color=never", "--hidden"]; if (ignoreCase) { args.push("--ignore-case"); } if (literal) { args.push("--fixed-strings"); } if (glob) { args.push("--glob", glob); } args.push(pattern, searchPath); const child = spawn(rgPath, args, { stdio: ["ignore", "pipe", "pipe"] }); const rl = createInterface({ input: child.stdout }); let stderr = ""; let matchCount = 0; let truncated = false; let aborted = false; let killedDueToLimit = false; const outputLines: string[] = []; const cleanup = () => { rl.close(); signal?.removeEventListener("abort", onAbort); }; const stopChild = (dueToLimit: boolean = false) => { if (!child.killed) { killedDueToLimit = dueToLimit; child.kill(); } }; const onAbort = () => { aborted = true; stopChild(); }; signal?.addEventListener("abort", onAbort, { once: true }); child.stderr?.on("data", (chunk) => { stderr += chunk.toString(); }); const formatBlock = (filePath: string, lineNumber: number) => { const relativePath = formatPath(filePath); const lines = getFileLines(filePath); if (!lines.length) { return [`${relativePath}:${lineNumber}: (unable to read file)`]; } const block: string[] = []; const start = contextValue > 0 ? Math.max(1, lineNumber - contextValue) : lineNumber; const end = contextValue > 0 ? Math.min(lines.length, lineNumber + contextValue) : lineNumber; for (let current = start; current <= end; current++) { const lineText = lines[current - 1] ?? ""; const sanitized = lineText.replace(/\r/g, ""); const isMatchLine = current === lineNumber; if (isMatchLine) { block.push(`${relativePath}:${current}: ${sanitized}`); } else { block.push(`${relativePath}-${current}- ${sanitized}`); } } return block; }; rl.on("line", (line) => { if (!line.trim() || matchCount >= effectiveLimit) { return; } let event: any; try { event = JSON.parse(line); } catch { return; } if (event.type === "match") { matchCount++; const filePath = event.data?.path?.text; const lineNumber = event.data?.line_number; if (filePath && typeof lineNumber === "number") { outputLines.push(...formatBlock(filePath, lineNumber)); } if (matchCount >= effectiveLimit) { truncated = true; stopChild(true); } } }); child.on("error", (error) => { cleanup(); settle(() => reject(new Error(`Failed to run ripgrep: ${error.message}`))); }); child.on("close", (code) => { cleanup(); if (aborted) { settle(() => reject(new Error("Operation aborted"))); return; } if (!killedDueToLimit && code !== 0 && code !== 1) { const errorMsg = stderr.trim() || `ripgrep exited with code ${code}`; settle(() => reject(new Error(errorMsg))); return; } if (matchCount === 0) { settle(() => resolve({ content: [{ type: "text", text: "No matches found" }], details: undefined }), ); return; } // Apply byte truncation const rawOutput = outputLines.join("\n"); const truncation = truncateHead(rawOutput, { maxLines: Number.MAX_SAFE_INTEGER }); const output = truncation.content; let details: GrepToolDetails | undefined; // Include truncation info in details (match limit or byte limit) if (truncated || truncation.truncated) { details = { truncation: truncation.truncated ? truncation : undefined, matchLimitReached: truncated ? effectiveLimit : undefined, }; } settle(() => resolve({ content: [{ type: "text", text: output }], details })); }); } catch (err) { settle(() => reject(err as Error)); } })(); }); }, };