mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-16 06:02:42 +00:00
Strip BOM before matching (LLM won't include invisible BOM in oldText), restore on write. Based on #394 by @prathamdby
186 lines
5.6 KiB
TypeScript
186 lines
5.6 KiB
TypeScript
import type { AgentTool } from "@mariozechner/pi-agent-core";
|
|
import { Type } from "@sinclair/typebox";
|
|
import { constants } from "fs";
|
|
import { access, readFile, writeFile } from "fs/promises";
|
|
import { detectLineEnding, generateDiffString, normalizeToLF, restoreLineEndings, stripBom } from "./edit-diff.js";
|
|
import { resolveToCwd } from "./path-utils.js";
|
|
|
|
const editSchema = Type.Object({
|
|
path: Type.String({ description: "Path to the file to edit (relative or absolute)" }),
|
|
oldText: Type.String({ description: "Exact text to find and replace (must match exactly)" }),
|
|
newText: Type.String({ description: "New text to replace the old text with" }),
|
|
});
|
|
|
|
export interface EditToolDetails {
|
|
/** Unified diff of the changes made */
|
|
diff: string;
|
|
/** Line number of the first change in the new file (for editor navigation) */
|
|
firstChangedLine?: number;
|
|
}
|
|
|
|
export function createEditTool(cwd: string): AgentTool<typeof editSchema> {
|
|
return {
|
|
name: "edit",
|
|
label: "edit",
|
|
description:
|
|
"Edit a file by replacing exact text. The oldText must match exactly (including whitespace). Use this for precise, surgical edits.",
|
|
parameters: editSchema,
|
|
execute: async (
|
|
_toolCallId: string,
|
|
{ path, oldText, newText }: { path: string; oldText: string; newText: string },
|
|
signal?: AbortSignal,
|
|
) => {
|
|
const absolutePath = resolveToCwd(path, cwd);
|
|
|
|
return new Promise<{
|
|
content: Array<{ type: "text"; text: string }>;
|
|
details: EditToolDetails | undefined;
|
|
}>((resolve, reject) => {
|
|
// Check if already aborted
|
|
if (signal?.aborted) {
|
|
reject(new Error("Operation aborted"));
|
|
return;
|
|
}
|
|
|
|
let aborted = false;
|
|
|
|
// Set up abort handler
|
|
const onAbort = () => {
|
|
aborted = true;
|
|
reject(new Error("Operation aborted"));
|
|
};
|
|
|
|
if (signal) {
|
|
signal.addEventListener("abort", onAbort, { once: true });
|
|
}
|
|
|
|
// Perform the edit operation
|
|
(async () => {
|
|
try {
|
|
// Check if file exists
|
|
try {
|
|
await access(absolutePath, constants.R_OK | constants.W_OK);
|
|
} catch {
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
reject(new Error(`File not found: ${path}`));
|
|
return;
|
|
}
|
|
|
|
// Check if aborted before reading
|
|
if (aborted) {
|
|
return;
|
|
}
|
|
|
|
// Read the file
|
|
const rawContent = await readFile(absolutePath, "utf-8");
|
|
|
|
// Check if aborted after reading
|
|
if (aborted) {
|
|
return;
|
|
}
|
|
|
|
// Strip BOM before matching (LLM won't include invisible BOM in oldText)
|
|
const { bom, text: content } = stripBom(rawContent);
|
|
|
|
const originalEnding = detectLineEnding(content);
|
|
const normalizedContent = normalizeToLF(content);
|
|
const normalizedOldText = normalizeToLF(oldText);
|
|
const normalizedNewText = normalizeToLF(newText);
|
|
|
|
// Check if old text exists
|
|
if (!normalizedContent.includes(normalizedOldText)) {
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
reject(
|
|
new Error(
|
|
`Could not find the exact text in ${path}. The old text must match exactly including all whitespace and newlines.`,
|
|
),
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Count occurrences
|
|
const occurrences = normalizedContent.split(normalizedOldText).length - 1;
|
|
|
|
if (occurrences > 1) {
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
reject(
|
|
new Error(
|
|
`Found ${occurrences} occurrences of the text in ${path}. The text must be unique. Please provide more context to make it unique.`,
|
|
),
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Check if aborted before writing
|
|
if (aborted) {
|
|
return;
|
|
}
|
|
|
|
// Perform replacement using indexOf + substring (raw string replace, no special character interpretation)
|
|
// String.replace() interprets $ in the replacement string, so we do manual replacement
|
|
const index = normalizedContent.indexOf(normalizedOldText);
|
|
const normalizedNewContent =
|
|
normalizedContent.substring(0, index) +
|
|
normalizedNewText +
|
|
normalizedContent.substring(index + normalizedOldText.length);
|
|
|
|
// Verify the replacement actually changed something
|
|
if (normalizedContent === normalizedNewContent) {
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
reject(
|
|
new Error(
|
|
`No changes made to ${path}. The replacement produced identical content. This might indicate an issue with special characters or the text not existing as expected.`,
|
|
),
|
|
);
|
|
return;
|
|
}
|
|
|
|
const finalContent = bom + restoreLineEndings(normalizedNewContent, originalEnding);
|
|
await writeFile(absolutePath, finalContent, "utf-8");
|
|
|
|
// Check if aborted after writing
|
|
if (aborted) {
|
|
return;
|
|
}
|
|
|
|
// Clean up abort handler
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
|
|
const diffResult = generateDiffString(normalizedContent, normalizedNewContent);
|
|
resolve({
|
|
content: [
|
|
{
|
|
type: "text",
|
|
text: `Successfully replaced text in ${path}.`,
|
|
},
|
|
],
|
|
details: { diff: diffResult.diff, firstChangedLine: diffResult.firstChangedLine },
|
|
});
|
|
} catch (error: any) {
|
|
// Clean up abort handler
|
|
if (signal) {
|
|
signal.removeEventListener("abort", onAbort);
|
|
}
|
|
|
|
if (!aborted) {
|
|
reject(error);
|
|
}
|
|
}
|
|
})();
|
|
});
|
|
},
|
|
};
|
|
}
|
|
|
|
/** Default edit tool using process.cwd() - for backwards compatibility */
|
|
export const editTool = createEditTool(process.cwd());
|