Improve plan mode to support file changes with diffs

Author: ericdallo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Improve plan-mode to do file changes with diffs.
+
 ## 0.24.3
 
 - Fix initializationOptions config merge.

docs/configuration.md

@@ -200,8 +200,8 @@ interface Config {
     systemPromptTemplateFile?: string;
     nativeTools: {
         filesystem: {enabled: boolean};
-         shell: {enabled: boolean;
-                 excludeCommands: string[]};
+        shell: {enabled: boolean,
+                excludeCommands: string[]};
     };
     disabledTools: string[],
     toolCall?: {

resources/prompts/plan_behavior.txt

@@ -1 +1 @@
-Plan mode is active. The user indicated that they do not want you to execute yet -- you MUST NOT make any edits, run any non-readonly tools (including changing configs or making commits), or otherwise make any changes to the system. This supersedes any other instructions you have received (for example, to make edits).
+Plan mode is active. The user indicated that they do not want you to execute yet -- you MUST NOT make any edits, run any non-readonly tools (including changing configs or making commits), or otherwise make any changes to the system. This supersedes any other instructions you have received (for example, to make edits). The only allowed tool related to code changes is the `eca_plan_edit_file` since system will take care to present to user the changes, only run if user ask to apply changes.

src/eca/features/chat.clj

@@ -115,7 +115,7 @@
         repo-map* (delay (f.index/repo-map db {:as-string? true}))
         instructions (f.prompt/build-instructions refined-contexts rules repo-map* (or behavior (:chat-default-behavior db)) config)
         past-messages (get-in db [:chats chat-id :messages] [])
-        all-tools (f.tools/all-tools @db* config)
+        all-tools (f.tools/all-tools behavior @db* config)
         received-msgs* (atom "")
         received-thinking* (atom "")
         tool-call-by-id* (atom {:args {}})

src/eca/features/tools.clj

@@ -2,6 +2,7 @@
   "This ns centralizes all available tools for LLMs including
    eca native tools and MCP servers."
   (:require
+   [babashka.fs :as fs]
    [clojure.string :as string]
    [eca.diff :as diff]
    [eca.features.tools.filesystem :as f.tools.filesystem]
@@ -10,8 +11,7 @@
    [eca.features.tools.util :as tools.util]
    [eca.logger :as logger]
    [eca.messenger :as messenger]
-   [eca.shared :refer [assoc-some]]
-   [babashka.fs :as fs])
+   [eca.shared :refer [assoc-some]])
   (:import
    [java.util Map]))
 
@@ -39,11 +39,16 @@
 (defn all-tools
   "Returns all available tools, including both native ECA tools
    (like filesystem and shell tools) and tools provided by MCP servers."
-  [db config]
+  [behavior db config]
   (let [disabled-tools (set (get-in config [:disabledTools] []))]
     (filterv
      (fn [tool]
-       (not (contains? disabled-tools (:name tool))))
+       (and (not (contains? disabled-tools (:name tool)))
+            ;; check for enabled-fn if present
+            ((or (:enabled-fn tool) (constantly true))
+             {:behavior behavior
+              :db db
+              :config config})))
      (concat
       (mapv #(assoc % :origin :native) (native-tools db config))
       (mapv #(assoc % :origin :mcp) (f.mcp/all-tools db))))))
@@ -127,17 +132,18 @@
                             :linesAdded added
                             :linesRemoved removed
                             :diff diff})))
-    "eca_edit_file" (let [path (get arguments "path")
-                          original-content (get arguments "original_content")
-                          new-content (get arguments "new_content")
-                          all? (get arguments "all_occurrences")]
-                      (when-let [{:keys [original-full-content
-                                         new-full-content]} (and path (fs/exists? path) original-content new-content
-                                                                 (f.tools.filesystem/file-change-full-content path original-content new-content all?))]
-                        (let [{:keys [added removed diff]} (diff/diff original-full-content new-full-content path)]
-                          {:type :fileChange
-                           :path path
-                           :linesAdded added
-                           :linesRemoved removed
-                           :diff diff})))
+    ("eca_plan_edit_file"
+     "eca_edit_file") (let [path (get arguments "path")
+                            original-content (get arguments "original_content")
+                            new-content (get arguments "new_content")
+                            all? (get arguments "all_occurrences")]
+                        (when-let [{:keys [original-full-content
+                                           new-full-content]} (and path (fs/exists? path) original-content new-content
+                                                                   (f.tools.filesystem/file-change-full-content path original-content new-content all?))]
+                          (let [{:keys [added removed diff]} (diff/diff original-full-content new-full-content path)]
+                            {:type :fileChange
+                             :path path
+                             :linesAdded added
+                             :linesRemoved removed
+                             :diff diff})))
     nil))

src/eca/features/tools/filesystem.clj

@@ -171,19 +171,32 @@
       {:original-full-content original-full-content
        :new-full-content new-full-content})))
 
-(defn ^:private edit-file [arguments {:keys [db]}]
+(defn ^:private change-file [arguments {:keys [db]} diff?]
   (or (tools.util/invalid-arguments arguments (concat (path-validations db)
                                                       [["path" fs/readable? "File $path is not readable"]]))
       (let [path (get arguments "path")
             original-content (get arguments "original_content")
             new-content (get arguments "new_content")
+            new-content (if diff?
+                          (str "<<<<<<< HEAD\n"
+                               original-content
+                               "\n=======\n"
+                               new-content
+                               "\n>>>>>>> eca\n")
+                          new-content)
             all? (boolean (get arguments "all_occurrences"))]
         (if-let [{:keys [new-full-content]} (file-change-full-content path original-content new-content all?)]
           (do
             (spit path new-full-content)
             (tools.util/single-text-content (format "Successfully replaced content in %s." path)))
           (tools.util/single-text-content (format "Original content not found in %s" path) :error)))))
 
+(defn ^:private edit-file [arguments components]
+  (change-file arguments components false))
+
+(defn ^:private plan-edit-file [arguments components]
+  (change-file arguments components true))
+
 (defn ^:private move-file [arguments {:keys [db]}]
   (let [workspace-dirs (tools.util/workspace-roots-strs db)]
     (or (tools.util/invalid-arguments arguments [["source" fs/exists? "$source is not a valid path"]
@@ -246,8 +259,9 @@
    {:description  (str "Replace a specific string or content block in a file with new content. "
                        "Finds the exact original content and replaces it with new content. "
                        "Be extra careful to format the original-content exactly correctly, "
-                       "taking extra care with whitespace and newlines. In addition to replacing strings, "
-                       "this can also be used to prepend, append, or delete contents from a file.")
+                       "taking extra care with whitespace and newlines. "
+                       "Avoid replacing whole functions, methods, or classes, change only the needed code. "
+                       "In addition to replacing strings, this can also be used to prepend, append, or delete contents from a file.")
     :parameters  {:type "object"
                   :properties {"path" {:type "string"
                                        :description "The absolute file path to do the replace."}
@@ -259,7 +273,29 @@
                                                   :description "Whether to replace all occurences of the file or just the first one (default)"}}
                   :required ["path" "original_content" "new_content"]}
     :handler #'edit-file
+    :enabled-fn (fn [{:keys [behavior]}] (not= "plan" behavior))
     :summary-fn (constantly "Editting file")}
+   "eca_plan_edit_file"
+   {:description  (str "Plan a file change where user needs to apply or reject the change. "
+                       "Replace a specific string or content block in a file with new content. "
+                       "Finds the exact original content and replaces it with new content. "
+                       "Be extra careful to format the original-content exactly correctly, "
+                       "taking extra care with whitespace and newlines. "
+                       "Avoid replacing whole functions, methods, or classes, change only the needed code. "
+                       "In addition to replacing strings, this can also be used to prepend, append, or delete contents from a file.")
+    :parameters  {:type "object"
+                  :properties {"path" {:type "string"
+                                       :description "The absolute file path to do the replace."}
+                               "original_content" {:type "string"
+                                                   :description "The exact content to find and replace"}
+                               "new_content" {:type "string"
+                                              :description "The new content to replace the original content with"}
+                               "all_occurrences" {:type "boolean"
+                                                  :description "Whether to replace all occurences of the file or just the first one (default)"}}
+                  :required ["path" "original_content" "new_content"]}
+    :handler #'plan-edit-file
+    :enabled-fn (fn [{:keys [behavior]}] (= "plan" behavior))
+    :summary-fn (constantly "Planning edit")}
    "eca_move_file"
    {:description (str "Move or rename files and directories. Can move files between directories "
                       "and rename them in a single operation. If the destination exists, the "

src/eca/main.clj

@@ -17,10 +17,10 @@
   (System/exit (or status 1)))
 
 (defn ^:private version []
-  (->> [(str "eca " (config/eca-version))]
-       (string/join \newline)))
+  (str "eca " (config/eca-version)))
 
-(defn ^:private help [options-summary]
+(defn ^:private help
+  [options-summary]
   (->> ["ECA - Editor Code Assistant"
         ""
         "Usage: eca <command> [<options>]"