Unverified 提交 70a02101 authored 作者: Will Chen's avatar Will Chen 提交者: GitHub

feat: add optional line range params to read_file tool (#2516)

## Summary - Add `start_line_one_indexed` and `end_line_one_indexed_inclusive` optional parameters to the `read_file` agent tool, allowing the agent to read specific line ranges from files - Update consent preview to display line range (e.g., "Read src/App.tsx (lines 10-50)") and XML builder to include `start_line`/`end_line` attributes - Add comprehensive unit tests (36 tests) with minimal mocking, using real temp files on disk ## Test plan - [x] All 36 new unit tests pass covering: schema validation, full file reads, start-only, end-only, both params, edge cases (out-of-bounds clamping, start > end, empty files, single-line files), consent preview, and XML builder - [x] All 747 existing tests pass (no regressions) - [x] Lint, formatting, and type checks pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/dyad-sh/dyad/pull/2516" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open with Devin"> </picture> </a> <!-- devin-review-badge-end --> <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Adds optional line range parameters to the read_file tool so the agent can read specific lines and reflect the range in consent preview and XML. Improves safety with clamping, schema validation, and clear errors, backed by comprehensive tests. - **New Features** - Support start_line_one_indexed and end_line_one_indexed_inclusive to read a specific line range. - Consent preview shows ranges; XML builder adds start_line/end_line attributes. - **Bug Fixes** - Escape start_line/end_line in XML and update parser to accept dyad-read tags with attributes. - Validate start <= end and fix trailing newline handling to match full-file reads. <sup>Written for commit 4c96f70ff20ba37bee46955b739a693acd0afc0c. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Expands an agent file-access primitive and changes how `<dyad-read>` tags are parsed, which could affect context gathering and partial reads; behavior is well-covered by new unit tests but still touches security-adjacent tooling. > > **Overview** > Adds optional `start_line_one_indexed` / `end_line_one_indexed_inclusive` parameters to the local agent `read_file` tool so it can return a specific line range (with bounds clamping and trailing-newline preservation). > > Updates consent previews and `<dyad-read>` XML generation to surface/encode the requested range, and loosens `parseFilesFromMessage`’s `<dyad-read>` regex to tolerate extra attributes. Includes a comprehensive new `read_file` unit test suite covering schema validation, range behavior, and XML/preview formatting. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 4c96f70ff20ba37bee46955b739a693acd0afc0c. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: 's avatarClaude Opus 4.6 <noreply@anthropic.com>
上级 c12e8f76
......@@ -283,6 +283,10 @@ When rebasing a branch that has drizzle migrations conflicting with upstream (e.
4. Create/update the snapshot file (`drizzle/meta/00XX_snapshot.json`) with the new index, updating `prevId` to reference the previous snapshot's `id`
5. If the PR had subsequent commits that deleted/modified its migration files, those changes become no-ops after renaming — just accept the deletion conflicts by staging the renamed files
### tsgo is stricter than tsc for type checking
The pre-commit hook runs `tsgo` (via `npm run ts`), which is stricter than `tsc --noEmit`. For example, passing a `number` to a function typed `(str: string | null | undefined)` may pass `tsc` but fail `tsgo` with `TS2345: Argument of type 'number' is not assignable to parameter of type 'string'`. Always wrap with `String()` when converting numbers to string parameters.
### OpenAI reasoning model errors with conversation history
When using OpenAI reasoning models (o1, o3, o4-mini) via LiteLLM/Azure, you may see:
......
......@@ -61,6 +61,18 @@
"path": {
"type": "string",
"description": "The file path to read"
},
"start_line_one_indexed": {
"description": "The one-indexed line number to start reading from (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"end_line_one_indexed_inclusive": {
"description": "The one-indexed line number to end reading at (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
......
......@@ -201,6 +201,18 @@
"path": {
"type": "string",
"description": "The file path to read"
},
"start_line_one_indexed": {
"description": "The one-indexed line number to start reading from (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"end_line_one_indexed_inclusive": {
"description": "The one-indexed line number to end reading at (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
......@@ -482,6 +494,7 @@
"include": [
"reasoning.encrypted_content"
],
"store": false,
"dyad_options": {
"enable_lazy_edits": true,
"enable_smart_files_context": true
......
......@@ -196,6 +196,18 @@
"path": {
"type": "string",
"description": "The file path to read"
},
"start_line_one_indexed": {
"description": "The one-indexed line number to start reading from (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"end_line_one_indexed_inclusive": {
"description": "The one-indexed line number to end reading at (inclusive).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
......
......@@ -40,7 +40,7 @@ export function parseFilesFromMessage(content: string): string[] {
const matches: TagMatch[] = [];
// Parse <dyad-read path="$filePath"></dyad-read>
const dyadReadRegex = /<dyad-read\s+path="([^"]+)"\s*><\/dyad-read>/gs;
const dyadReadRegex = /<dyad-read\s+path="([^"]+)"[^>]*><\/dyad-read>/gs;
let match: RegExpExecArray | null;
while ((match = dyadReadRegex.exec(content)) !== null) {
const filePath = normalizePath(match[1].trim());
......
......@@ -5,9 +5,41 @@ import { safeJoin } from "@/ipc/utils/path_utils";
const readFile = fs.promises.readFile;
const readFileSchema = z.object({
path: z.string().describe("The file path to read"),
});
const readFileSchema = z
.object({
path: z.string().describe("The file path to read"),
start_line_one_indexed: z
.number()
.int()
.min(1)
.optional()
.describe(
"The one-indexed line number to start reading from (inclusive).",
),
end_line_one_indexed_inclusive: z
.number()
.int()
.min(1)
.optional()
.describe("The one-indexed line number to end reading at (inclusive)."),
})
.refine(
(data) => {
if (
data.start_line_one_indexed != null &&
data.end_line_one_indexed_inclusive != null
) {
return (
data.start_line_one_indexed <= data.end_line_one_indexed_inclusive
);
}
return true;
},
{
message:
"start_line_one_indexed must be <= end_line_one_indexed_inclusive",
},
);
export const readFileTool: ToolDefinition<z.infer<typeof readFileSchema>> = {
name: "read_file",
......@@ -17,11 +49,33 @@ export const readFileTool: ToolDefinition<z.infer<typeof readFileSchema>> = {
inputSchema: readFileSchema,
defaultConsent: "always",
getConsentPreview: (args) => `Read ${args.path}`,
getConsentPreview: (args) => {
const start = args.start_line_one_indexed;
const end = args.end_line_one_indexed_inclusive;
if (start != null && end != null) {
return `Read ${args.path} (lines ${start}-${end})`;
} else if (start != null) {
return `Read ${args.path} (from line ${start})`;
} else if (end != null) {
return `Read ${args.path} (to line ${end})`;
}
return `Read ${args.path}`;
},
buildXml: (args, _isComplete) => {
if (!args.path) return undefined;
return `<dyad-read path="${escapeXmlAttr(args.path)}"></dyad-read>`;
const attrs = [`path="${escapeXmlAttr(args.path)}"`];
if (args.start_line_one_indexed != null) {
attrs.push(
`start_line="${escapeXmlAttr(String(args.start_line_one_indexed))}"`,
);
}
if (args.end_line_one_indexed_inclusive != null) {
attrs.push(
`end_line="${escapeXmlAttr(String(args.end_line_one_indexed_inclusive))}"`,
);
}
return `<dyad-read ${attrs.join(" ")}></dyad-read>`;
},
execute: async (args, ctx: AgentContext) => {
......@@ -32,6 +86,24 @@ export const readFileTool: ToolDefinition<z.infer<typeof readFileSchema>> = {
}
const content = await readFile(fullFilePath, "utf8");
return content || "";
if (!content) return "";
const start = args.start_line_one_indexed;
const end = args.end_line_one_indexed_inclusive;
if (start == null && end == null) {
return content;
}
const hasTrailingNewline = content.endsWith("\n");
const lines = (hasTrailingNewline ? content.slice(0, -1) : content).split(
"\n",
);
const startIdx = Math.max(0, (start ?? 1) - 1);
const endIdx = Math.min(lines.length, end ?? lines.length);
const result = lines.slice(startIdx, endIdx).join("\n");
return endIdx >= lines.length && hasTrailingNewline
? result + "\n"
: result;
},
};
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论