mirrors/opencode
1
0
Fork 0
mirror of https://github.com/sst/opencode.git synced 2025-09-02 19:27:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Standardize parameter description references in Edit and MultiEdit tools (#984)

Browse source
This commit is contained in:
Mike Wallio 2025-07-14 20:03:59 -04:00 • committed by GitHub
parent 2cdb37c32b
commit f593792fb5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/opencode/src/tool/edit.ts
View file

@ -20,8 +20,8 @@ export const EditTool = Tool.define({
parameters: z.object({ parameters: z.object({
filePath: z.string().describe("The absolute path to the file to modify"), filePath: z.string().describe("The absolute path to the file to modify"),
oldString: z.string().describe("The text to replace"), oldString: z.string().describe("The text to replace"),
newString: z.string().describe("The text to replace it with (must be different from old_string)"), newString: z.string().describe("The text to replace it with (must be different from oldString)"),
replaceAll: z.boolean().optional().describe("Replace all occurrences of old_string (default false)"), replaceAll: z.boolean().optional().describe("Replace all occurrences of oldString (default false)"),
}), }),
async execute(params, ctx) { async execute(params, ctx) {
if (!params.filePath) { if (!params.filePath) {

6
packages/opencode/src/tool/edit.txt
View file

@ -2,8 +2,8 @@ Performs exact string replacements in files.
Usage: Usage:
- You must use your `Read` tool at least once in the conversation before editing. This tool will error if you attempt an edit without reading the file. - You must use your `Read` tool at least once in the conversation before editing. This tool will error if you attempt an edit without reading the file.
- When editing text from Read tool output, ensure you preserve the exact indentation (tabs/spaces) as it appears AFTER the line number prefix. The line number prefix format is: spaces + line number + tab. Everything after that tab is the actual file content to match. Never include any part of the line number prefix in the old_string or new_string. - When editing text from Read tool output, ensure you preserve the exact indentation (tabs/spaces) as it appears AFTER the line number prefix. The line number prefix format is: spaces + line number + tab. Everything after that tab is the actual file content to match. Never include any part of the line number prefix in the oldString or newString.
- ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required. - ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required.
- Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked. - Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked.
- The edit will FAIL if `old_string` is not unique in the file. Either provide a larger string with more surrounding context to make it unique or use `replace_all` to change every instance of `old_string`. - The edit will FAIL if `oldString` is not unique in the file. Either provide a larger string with more surrounding context to make it unique or use `replaceAll` to change every instance of `oldString`.
- Use `replace_all` for replacing and renaming strings across the file. This parameter is useful if you want to rename a variable for instance. - Use `replaceAll` for replacing and renaming strings across the file. This parameter is useful if you want to rename a variable for instance.

14
packages/opencode/src/tool/multiedit.txt
View file

@ -8,9 +8,9 @@ Before using this tool:
To make multiple file edits, provide the following: To make multiple file edits, provide the following:
1. file_path: The absolute path to the file to modify (must be absolute, not relative) 1. file_path: The absolute path to the file to modify (must be absolute, not relative)
2. edits: An array of edit operations to perform, where each edit contains: 2. edits: An array of edit operations to perform, where each edit contains:
- old_string: The text to replace (must match the file contents exactly, including all whitespace and indentation) - oldString: The text to replace (must match the file contents exactly, including all whitespace and indentation)
- new_string: The edited text to replace the old_string - newString: The edited text to replace the oldString
- replace_all: Replace all occurrences of old_string. This parameter is optional and defaults to false. - replaceAll: Replace all occurrences of oldString. This parameter is optional and defaults to false.
IMPORTANT: IMPORTANT:
- All edits are applied in sequence, in the order they are provided - All edits are applied in sequence, in the order they are provided
@ -24,8 +24,8 @@ CRITICAL REQUIREMENTS:
3. Plan your edits carefully to avoid conflicts between sequential operations 3. Plan your edits carefully to avoid conflicts between sequential operations
WARNING: WARNING:
- The tool will fail if edits.old_string doesn't match the file contents exactly (including whitespace) - The tool will fail if edits.oldString doesn't match the file contents exactly (including whitespace)
- The tool will fail if edits.old_string and edits.new_string are the same - The tool will fail if edits.oldString and edits.newString are the same
- Since edits are applied in sequence, ensure that earlier edits don't affect the text that later edits are trying to find - Since edits are applied in sequence, ensure that earlier edits don't affect the text that later edits are trying to find
When making edits: When making edits:
@ -33,9 +33,9 @@ When making edits:
- Do not leave the code in a broken state - Do not leave the code in a broken state
- Always use absolute file paths (starting with /) - Always use absolute file paths (starting with /)
- Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked. - Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked.
- Use replace_all for replacing and renaming strings across the file. This parameter is useful if you want to rename a variable for instance. - Use replaceAll for replacing and renaming strings across the file. This parameter is useful if you want to rename a variable for instance.
If you want to create a new file, use: If you want to create a new file, use:
- A new file path, including dir name if needed - A new file path, including dir name if needed
- First edit: empty old_string and the new file's contents as new_string - First edit: empty oldString and the new file's contents as newString
- Subsequent edits: normal edit operations on the created content - Subsequent edits: normal edit operations on the created content