Packages
fnord
0.8.57
0.9.40
0.9.39
0.9.38
0.9.37
0.9.36
0.9.35
0.9.34
0.9.33
0.9.32
0.9.31
0.9.30
0.9.29
0.9.28
0.9.27
0.9.26
0.9.25
0.9.24
0.9.23
0.9.22
0.9.21
0.9.20
0.9.19
0.9.18
0.9.17
0.9.16
0.9.15
0.9.14
0.9.13
0.9.12
0.9.11
0.9.10
0.9.9
0.9.8
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.99
0.8.98
0.8.97
0.8.96
0.8.95
0.8.94
0.8.93
0.8.92
0.8.91
0.8.90
0.8.89
0.8.88
0.8.87
0.8.86
0.8.85
0.8.84
0.8.83
0.8.82
0.8.81
0.8.80
0.8.79
0.8.78
0.8.77
0.8.76
0.8.75
0.8.74
0.8.73
0.8.72
0.8.71
0.8.70
0.8.69
0.8.68
0.8.67
0.8.66
0.8.65
0.8.64
0.8.63
0.8.62
0.8.61
0.8.60
0.8.59
0.8.58
0.8.57
0.8.56
0.8.55
0.8.54
0.8.53
0.8.52
0.8.51
0.8.50
0.8.49
0.8.48
0.8.47
0.8.46
0.8.45
0.8.44
0.8.43
0.8.42
0.8.41
0.8.40
0.8.39
0.8.38
0.8.37
0.8.36
0.8.35
0.8.34
0.8.33
0.8.32
0.8.31
0.8.30
0.8.29
0.8.27
0.8.26
0.8.25
0.8.24
0.8.23
0.8.22
0.8.21
0.8.20
0.8.19
0.8.18
0.8.17
0.8.16
0.8.15
0.8.14
0.8.13
0.8.12
0.8.11
0.8.1
0.8.0
0.7.24
0.7.23
0.7.22
0.7.21
0.7.20
0.7.19
0.7.18
0.7.17
0.7.16
0.7.15
0.7.14
0.7.13
0.7.12
0.7.11
0.7.10
0.7.9
0.7.8
0.7.7
0.7.6
0.7.5
0.7.3
0.7.2
0.7.1
0.7.0
0.6.9
0.6.8
0.6.7
0.6.6
0.6.5
0.6.4
0.6.3
0.6.1
0.6.0
0.5.9
0.5.8
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.44
0.4.43
0.4.42
0.4.41
0.4.40
0.4.39
0.4.38
0.4.37
0.4.36
0.4.35
0.4.34
0.4.33
0.4.32
0.4.30
0.4.29
0.4.28
0.4.27
0.4.26
0.4.25
0.4.24
0.4.23
0.4.22
0.4.21
0.4.20
0.4.19
0.4.18
0.4.17
0.4.16
0.4.15
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.0
0.2.0
0.1.0
AI code archaeology
Current section
Files
Jump to
Current section
Files
lib/ai/tools/file/edit.ex
defmodule AI.Tools.File.Edit do
# ----------------------------------------------------------------------------
# Types
# ----------------------------------------------------------------------------
@type edit_result :: %{
file: binary,
backup_file: binary,
diff: binary
}
# ----------------------------------------------------------------------------
# Behaviour Implementation
# ----------------------------------------------------------------------------
@behaviour AI.Tools
@impl AI.Tools
def async?, do: false
@impl AI.Tools
def is_available?, do: true
@impl AI.Tools
def read_args(args) when is_map(args) do
with {:ok, args} <- read_create_if_missing(args),
{:ok, args} <- AI.Tools.File.Edit.OMFG.normalize_agent_chaos(args) do
{:ok, args}
end
end
defp read_create_if_missing(args) do
# Validate and default the create_if_missing flag
case args["create_if_missing"] do
true -> {:ok, args}
false -> {:ok, args}
nil -> {:ok, Map.put(args, "create_if_missing", false)}
_ -> {:error, :invalid_argument, "`create_if_missing` must be a boolean"}
end
end
@impl AI.Tools
def ui_note_on_request(%{"file" => file}) do
{"Preparing changes", file}
end
@impl AI.Tools
def ui_note_on_result(%{"file" => file}, _result) do
{"Changes applied", file}
end
@impl AI.Tools
def spec do
%{
type: "function",
function: %{
name: "file_edit_tool",
description: """
Perform atomic, well-anchored edits to a single file using either exact
string matching or AI-interpreted natural language instructions.
This is the best tool for simple changes that do not require extensive
planning, coordination, or span many files.
**Two editing modes:**
1. **Exact String Matching**: Provide old_string/new_string for precise,
reliable replacements. Use when you know the exact text to change.
2. **Natural Language**: Provide descriptive change instructions for the
AI to interpret. Use when you need contextual understanding.
Use for:
- One-off line or block replacements
- Clear, unambiguous, file-local changes
- Fast, low-risk operations
Supports optional creation of the file when it does not exist by
setting `create_if_missing: true`.
**Examples:**
File editing with exact matching:
```json
{
"file": "src/app.js",
"changes": [{
"old_string": "const API_URL = 'localhost'",
"new_string": "const API_URL = 'api.example.com'"
}]
}
```
File creation (simplified UX):
```json
{
"file": "config/new-config.json",
"create_if_missing": true,
"changes": [{
"new_string": "{\"version\": \"1.0\", \"debug\": true}"
}]
}
```
Natural language instruction:
```json
{
"file": "components/Header.tsx",
"changes": [{
"instructions": "Add a new prop called 'showLogo' to the Header component and use it to conditionally render the logo"
}]
}
```
**Best practices:**
- Use exact string matching for maximum reliability
- Use natural language for contextual changes when exact strings are impractical
- For new files: omit old_string and use create_if_missing: true at the TOP LEVEL
- Split complex edits into multiple changes/tool calls
- Keep diffs minimal and well-anchored with clear anchors
""",
parameters: %{
type: "object",
required: ["file"],
additionalProperties: false,
properties: %{
file: %{
type: "string",
description: "Path (relative to project root) of the file to edit."
},
changes: %{
type: "array",
description: """
A list of changes to apply to the file.
Steps are ordered logically, with each building on the previous.
They will be applied in sequence.
Each change can be either:
1. Natural language instructions (for AI interpretation)
2. Exact string replacement (for precise, reliable edits)
""",
items: %{
type: "object",
oneOf: [
%{
description: "Natural language change instruction",
type: "object",
required: ["instructions"],
additionalProperties: false,
properties: %{
instructions: %{
type: "string",
description: """
Clear, specific natural language instructions for the changes to make. The
instructions must be concise and unambiguous.
Clearly define the section(s) of the file to modify. Provide
unambiguous "anchors" that identify the exact location of the
change.
Examples:
- "Immediately after the declaration of the main function, add the following code block: ..."
- "Replace the entire contents of the calculate function with: ..."
- "At the top of the file, insert the following imports: ..."
"""
}
}
},
%{
description: "Exact string replacement",
type: "object",
required: ["old_string", "new_string"],
additionalProperties: false,
properties: %{
old_string: %{
type: "string",
description: """
Exact string to replace. Must match exactly (including whitespace)
or the operation will fail. For file creation, use empty string "".
"""
},
new_string: %{
type: "string",
description: """
Exact replacement string. When used with old_string, replaces all matches.
For file creation, this becomes the entire file content.
"""
},
replace_all: %{
type: "boolean",
description: """
Whether to replace all occurrences (true) or fail if old_string appears
multiple times (false). Defaults to false for safety.
""",
default: false
}
}
},
%{
description: "File creation (simplified UX)",
type: "object",
required: ["new_string"],
additionalProperties: false,
properties: %{
new_string: %{
type: "string",
description: """
Complete file content for new file creation.
Must be used with create_if_missing: true at the top level.
"""
}
}
}
]
}
},
create_if_missing: %{
type: "boolean",
description: "If true, create the file (and parent dirs) if it doesn't exist.",
default: false
}
}
}
}
}
end
@impl AI.Tools
def call(raw_args) do
with {:ok, args} <- read_args(raw_args),
{:ok, file} <- AI.Tools.get_arg(args, "file"),
{:ok, changes} <- read_changes(args) do
create? = Map.get(args, "create_if_missing", false)
with {:ok, result} <- do_edits(file, changes, create?) do
{:ok, result}
end
end
end
# Parse and validate the list of change instructions
@spec read_changes(map) :: {:ok, [change]} | {:error, String.t()}
defp read_changes(opts) do
case Map.get(opts, "changes") do
nil ->
{:error, "Either 'changes' array or individual change parameters must be provided"}
changes when is_list(changes) ->
try do
parsed_changes =
changes
|> Enum.map(&parse_change/1)
|> Enum.map(fn
{:ok, change} -> change
{:error, error} -> throw({:parse_error, error})
end)
{:ok, parsed_changes}
rescue
_ in FunctionClauseError ->
{:error,
"""
Invalid changes format.
Expected a list of objects with change instructions.
"""}
catch
{:parse_error, error} -> {:error, error}
end
_ ->
{:error, "Changes must be an array"}
end
end
# Define change types
@type natural_language :: %{
type: :natural_language,
instruction: String.t()
}
@type exact :: %{
type: :exact,
instruction: String.t(),
old_string: String.t(),
new_string: String.t(),
replace_all: boolean()
}
@type change ::
natural_language
| exact
@spec parse_change(map) :: {:ok, change} | {:error, String.t()}
defp parse_change(change_map) when is_map(change_map) do
instruction = Map.get(change_map, "instructions", "")
old_string = Map.get(change_map, "old_string")
new_string = Map.get(change_map, "new_string")
replace_all = Map.get(change_map, "replace_all", false)
cond do
# Exact string matching mode (full parameters)
old_string != nil and new_string != nil ->
if is_binary(old_string) and is_binary(new_string) and is_boolean(replace_all) do
{:ok,
%{
type: :exact,
old_string: old_string,
new_string: new_string,
replace_all: replace_all
}}
else
{:error, "old_string and new_string must be strings, replace_all must be boolean"}
end
# File creation mode (new_string only, for create_if_missing)
old_string == nil and new_string != nil ->
# Check for common agent confusion: trying to insert content into existing file
# Look for indicators that this might be content insertion, not file creation
create_if_missing = Map.get(change_map, "create_if_missing")
cond do
# Agent explicitly said create_if_missing: false - they're confused about insertion
create_if_missing == false ->
{:error,
"""
Invalid parameters for content insertion. You provided new_string without old_string,
but also set create_if_missing: false, indicating you want to modify an existing file.
For inserting content into an existing file, you have two options:
1. Exact string matching - specify where to insert:
{"old_string": "existing code to insert after", "new_string": "existing code + new content"}
2. Natural language - describe the location:
{"instructions": "Add the new function after the existing helper functions"}
Note: create_if_missing belongs at the top level, not inside individual changes.
"""}
# Agent has create_if_missing inside the change (wrong placement)
create_if_missing != nil ->
{:error,
"""
Parameter placement error: create_if_missing should be at the top level, not inside changes.
Correct structure:
{
"file": "path/to/file.ex",
"create_if_missing": true,
"changes": [{"new_string": "file content"}]
}
For adding content to existing files, use exact matching or natural language instead.
"""}
# Standard file creation mode
is_binary(new_string) and is_boolean(replace_all) ->
{:ok,
%{
type: :exact,
old_string: "",
new_string: new_string,
replace_all: replace_all
}}
true ->
{:error, "new_string must be a string, replace_all must be boolean"}
end
# Partial exact string matching (error case)
old_string != nil and new_string == nil ->
{:error,
"""
Both old_string and new_string must be provided together for exact matching.
For file creation, you can omit old_string and just provide new_string.
Example for editing: {"old_string": "old text", "new_string": "new text"}
Example for file creation: {"new_string": "file content"} with create_if_missing: true
"""}
# Natural language mode
instruction != "" ->
{:ok,
%{
type: :natural_language,
instruction: String.trim(instruction)
}}
# No valid parameters
true ->
{:error,
"""
Invalid change parameters. You must provide either:
1. Natural language: {"instructions": "description of what to do"}
2. Exact matching: {"old_string": "text to replace", "new_string": "replacement text"}
3. File creation: {"new_string": "content"} with create_if_missing: true at the top level
"""}
end
end
defp parse_change(_), do: {:error, "Change must be an object"}
# ----------------------------------------------------------------------------
# Internals
# ----------------------------------------------------------------------------
@spec ensure_file(binary, boolean) :: :ok | {:error, String.t()}
defp ensure_file(path, true) do
# Ensure parent directories exist, but do not pre-create the file itself
unless File.exists?(path) do
File.mkdir_p!(Path.dirname(path))
end
:ok
end
defp ensure_file(path, false) do
# Only ok if file already exists
if File.exists?(path) do
:ok
else
{:error, "File does not exist: #{path}"}
end
end
# Main edit flow with optional file creation
@spec do_edits(binary, [change], boolean) :: {:ok, edit_result} | {:error, String.t()}
defp do_edits(file, changes, create_if_missing) do
try do
with {:ok, project} <- Store.get_project(),
absolute_path <- Store.Project.expand_path(file, project),
{orig_exists, orig_text} = read_file(absolute_path),
base_hash = :crypto.hash(:sha256, orig_text),
:ok <- ensure_file(absolute_path, create_if_missing),
{:ok, contents} <- apply_all_changes(absolute_path, orig_text, changes) do
if contents == orig_text do
{:error, "no changes were made to the file"}
else
with {:ok, diff, bak} <- stage_changes(absolute_path, contents, orig_exists, base_hash) do
{:ok, %{file: file, diff: diff, backup_file: bak}}
end
end
end
rescue
error ->
{:error,
"""
An error occurred while applying changes to the file, but it's not your fault.
This is an internal application error.
Please report it to the developers.
Error message:
#{Exception.message(error)}
Stack trace:
```
#{Exception.format_stacktrace(__STACKTRACE__)}
```
"""}
end
end
# Apply staged contents to disk, confirm, optionally backup, and verify no mid-flight changes
@spec stage_changes(binary, binary, boolean, binary) ::
{:ok, binary, binary} | {:error, String.t()}
defp stage_changes(file, contents, orig_exists, base_hash) do
Util.Temp.with_tmp(contents, fn temp ->
with {:ok, diff} <- build_diff(file, temp, orig_exists),
{:ok, :approved} <- confirm_edit(file, diff),
{:ok, backup_file} <- maybe_backup(file, orig_exists),
{:ok, _} <- verify_no_race(file, base_hash, orig_exists),
:ok <- commit_changes(file, temp) do
{:ok, diff, backup_file}
end
end)
end
# Apply all changes sequentially, handling both exact and natural language changes
@spec apply_all_changes(binary, binary, [change]) :: {:ok, binary} | {:error, String.t()}
defp apply_all_changes(_file, contents, []), do: {:ok, contents}
defp apply_all_changes(file, contents, [change | remaining]) do
# Pre-validate natural language changes
with :ok <- validate_change(change, contents),
{:ok, new_contents} <- apply_single_change(file, contents, change) do
apply_all_changes(file, new_contents, remaining)
else
{:error, reason} -> {:error, format_change_error(change, reason)}
end
end
# Pre-validation for changes to catch common issues early
@spec validate_change(change, binary) :: :ok | {:error, String.t()}
defp validate_change(%{type: :exact, old_string: old}, contents) when byte_size(old) == 0 do
# Allow empty old_string only when creating a new file (empty contents)
# This supports the file creation UX where agents can omit old_string
if byte_size(contents) == 0 do
:ok
else
{:error,
"old_string cannot be empty when editing existing content (use create_if_missing: true for new files)"}
end
end
defp validate_change(%{type: :natural_language, instruction: instruction}, _contents) do
cond do
String.length(String.trim(instruction)) < 10 ->
{:error,
"""
Instruction too vague. Please provide more specific details about what to change and where.
Examples: "Add error handling to the login function", "Replace the hardcoded API URL on line 42"
"""}
not (String.contains?(instruction, [
"after",
"before",
"at the",
"in the",
"replace",
"add",
"remove",
"function",
"line"
]) or
Regex.match?(~r/\d+/, instruction)) ->
{:error,
"""
Instruction lacks clear location anchors. Consider specifying:
- Line numbers: "on line 42", "after line 15"
- Function names: "in the validateUser function"
- Relative positions: "before the return statement", "after the imports"
- Specific text: "replace 'localhost' with 'api.example.com'"
"""}
true ->
:ok
end
end
defp validate_change(_change, _contents), do: :ok
# Apply a single change based on its type
@spec apply_single_change(binary, binary, change) :: {:ok, binary} | {:error, String.t()}
defp apply_single_change(_file, contents, %{type: :exact} = change) do
apply_exact_change(contents, change)
end
defp apply_single_change(file, contents, %{type: :natural_language} = change) do
apply_natural_language_change(file, contents, change.instruction)
end
# Handle exact string replacement
@spec apply_exact_change(binary, change) :: {:ok, binary} | {:error, String.t()}
defp apply_exact_change(contents, %{old_string: old, new_string: new, replace_all: replace_all}) do
cond do
# File creation case: empty old_string with empty contents
byte_size(old) == 0 and byte_size(contents) == 0 ->
{:ok, new}
# Empty old_string with non-empty contents (invalid)
byte_size(old) == 0 ->
{:error, "old_string cannot be empty when editing existing content"}
# Normal replacement cases
not String.contains?(contents, old) ->
{:error, "String not found in file: #{inspect(old)}"}
replace_all ->
# Replace all occurrences
{:ok, String.replace(contents, old, new)}
true ->
# Check for multiple occurrences when replace_all is false
parts = String.split(contents, old)
case parts do
[_before, _after] ->
# Exactly one occurrence
{:ok, String.replace(contents, old, new)}
_ ->
# Multiple occurrences
count = length(parts) - 1
{:error,
"String appears #{count} times in file. Set replace_all: true to replace all occurrences"}
end
end
end
# Handle natural language changes using the existing patcher
@spec apply_natural_language_change(binary, binary, String.t()) ::
{:ok, binary} | {:error, String.t()}
defp apply_natural_language_change(file, _contents, instruction) do
AI.Agent.Code.Patcher
|> AI.Agent.new()
|> AI.Agent.get_response(%{file: file, changes: [instruction]})
end
# Format error messages with context about which change failed
@spec format_change_error(change, String.t()) :: String.t()
defp format_change_error(%{type: :exact, old_string: old}, reason) do
"""
Exact string replacement failed:
Searching for: #{inspect(old)}
Error: #{reason}
Suggestions:
- Verify the exact string exists in the file, including all whitespace and capitalization
- If creating a new file, use create_if_missing: true at the TOP LEVEL (not inside changes array)
- For multiple occurrences, add "replace_all": true to the change object
"""
end
defp format_change_error(%{type: :natural_language, instruction: instruction}, reason) do
"""
Natural language instruction failed:
Instruction: "#{instruction}"
Error: #{reason}
Suggestions:
- Try using exact string replacement for more reliable results:
{"old_string": "exact text to find", "new_string": "replacement text"}
- Make instructions more specific with clear anchors (line numbers, function names)
- For new files, use create_if_missing: true at the TOP LEVEL, not inside changes
- Break complex changes into smaller, more specific steps
"""
end
@spec build_diff(binary, binary, boolean) :: {:ok, binary} | {:error, String.t()}
defp build_diff(file, staged, orig_exists) do
# Use /dev/null as the original when creating a new file
original = if orig_exists, do: file, else: "/dev/null"
System.cmd("diff", ["-u", "-L", "ORIGINAL", "-L", "MODIFIED", original, staged],
stderr_to_stdout: true
)
|> case do
{output, 1} -> {:ok, String.trim_trailing(output)}
{_, 0} -> {:error, "no changes were made to the file"}
{error, code} -> {:error, "diff failed (#{code}): #{error}"}
end
end
@spec confirm_edit(binary, binary) :: {:ok, :approved} | {:error, term}
defp confirm_edit(file, diff) do
Services.Approvals.confirm({file, colorize_diff(diff)}, :edit)
end
@spec colorize_diff(binary) :: Owl.Data.t()
defp colorize_diff(diff) do
diff
|> String.split("\n")
|> Enum.map(fn line ->
cond do
String.starts_with?(line, "+") -> Owl.Data.tag(line <> "\n", [:white, :green_background])
String.starts_with?(line, "-") -> Owl.Data.tag(line <> "\n", [:white, :red_background])
true -> line <> "\n"
end
end)
end
defp backup_file(file) do
Services.BackupFile.create_backup(file)
end
@spec commit_changes(binary, binary) :: :ok | {:error, term}
defp commit_changes(file, staged) do
# Perform atomic write: copy staged content to a temp file, then rename over target
dir = Path.dirname(file)
tmp = Path.join(dir, ".#{Path.basename(file)}.tmp")
case File.cp(staged, tmp) do
:ok ->
case File.rename(tmp, file) do
:ok -> :ok
{:error, reason} -> {:error, reason}
end
{:error, reason} ->
{:error, reason}
end
end
@spec verify_no_race(binary, binary, boolean) :: {:ok, :ok} | {:error, String.t()}
defp verify_no_race(_, _, false) do
{:ok, :skipped}
end
defp verify_no_race(path, base_hash, true) do
# Read current contents and compare hash to detect concurrent modifications
current = File.read!(path)
current_hash = :crypto.hash(:sha256, current)
if current_hash == base_hash do
{:ok, :ok}
else
{:error, "File changed on disk during edit; aborting"}
end
end
@spec maybe_backup(binary, boolean) :: {:ok, binary | nil} | {:error, term}
# Backup only if the original file existed prior to the edit
defp maybe_backup(_file, false), do: {:ok, ""}
defp maybe_backup(file, true), do: backup_file(file)
defp read_file(abs_path) do
abs_path
|> File.exists?()
|> case do
true -> {true, File.read!(abs_path)}
false -> {false, ""}
end
end
end