config

Author: ericdallo

docs/configuration.md

@@ -405,6 +405,21 @@ You can configure which model and system prompt ECA will use during its inline c
     }
     ```
 
+## Rewrite
+
+You can configure which model and system prompt ECA will use during its rewrite feature:
+
+=== "Example"
+
+    ```javascript title="~/.config/eca/config.json"
+    {
+      "rewrite": {
+        "model": "github-copilot/gpt-4.1",
+        "systemPromptFile": "/path/to/my-prompt.md"
+      }
+    }
+    ```
+
 ## Opentelemetry integration
 
 To configure, add your OTLP collector config via `:otlp` map following [otlp auto-configure settings](https://opentelemetry.io/docs/languages/java/configuration/#properties-general). Example:
@@ -516,6 +531,10 @@ To configure, add your OTLP collector config via `:otlp` map following [otlp aut
             model?: string;
             systemPromptFile?: string;
         };
+        rewrite?: {
+            model?: string;
+            systemPromptFile?: string;
+        };
         otlp?: {[key: string]: string};
         netrcFile?: string;
     }
@@ -589,6 +608,9 @@ To configure, add your OTLP collector config via `:otlp` map following [otlp aut
       "completion": {
         "model": "openai/gpt-4.1",
         "systemPromptFile": "prompts/inline_completion.md"
+      },
+      "rewrite": {
+        "systemPromptFile": "prompts/rewrite.md"
       }
     }
     ```

docs/features.md

@@ -135,6 +135,12 @@ Hooks are actions that can run before or after an specific event, useful to noti
 
 For more details, check [hooks configuration](./configuration.md#hooks).
 
+## Rewrite
+
+Rewrite allow user to select part of the text and ask ECA to rewrite it using a configured model.
+
+![](./images/features/rewrite.gif)
+
 ##  Completion (alpha)
 
 Inline code completion
@@ -148,9 +154,3 @@ For mode details check [configuration](./configuration.md#completion).
 ECA has support for [OpenTelemetry](https://opentelemetry.io/)(otlp), if configured, server tasks, tool calls, and more will be metrified via otlp API.
 
 For more details check [its configuration](./configuration.md#opentelemetry-integration).
-
-
-## Edit 
-
-Soon
-

docs/protocol.md

@@ -353,7 +353,7 @@ interface ChatPromptParams {
      * Different models may have different capabilities, response styles,
      * and performance characteristics.
      */
-    model?: ChatModel;
+    model?: Model;
 
     /**
      * The chat behavior used by server to handle chat communication and actions.
@@ -370,7 +370,7 @@ interface ChatPromptParams {
 /**
  * The LLM model name.
  */
-type ChatModel = string;
+type Model = string;
 
 type ChatContext = FileContext | DirectoryContext | WebContext | RepoMapContext | CursorContext |McpResourceContext;
 
@@ -500,7 +500,7 @@ interface ChatPromptResponse {
     /*
      * The model used for this chat request.
      */
-    model: ChatModel;
+    model: Model;
 
     /**
      * What the server is doing after receing this prompt
@@ -540,7 +540,7 @@ interface ChatContentReceivedParams {
  * Different types of content that can be received from the LLM
  */
 type ChatContent = 
-    | ChatTextContent 
+    ChatTextContent 
     | ChatURLContent 
     | ChatProgressContent 
     | ChatUsageContent
@@ -1420,12 +1420,6 @@ interface RewritePromptParams {
      */
     prompt: string;
 
-    /**
-     * The model used for this rewrite.
-     * If null, server will use default model.
-     */
-    model?: ChatModel;
-
     /**
      * Optional path of the file.
      * Useful for give context to LLM about the file path.
@@ -1448,7 +1442,55 @@ interface RewritePromptResponse {
      * The status of this rewrite.
      */
     status: 'prompting';
+    
+    /**
+     * The model used by this rewrite request.
+     */
+    model: Model;
+}
+```
+
+### Rewrite Content Received (⬅️)
+
+A server notification with a new content from the rewrite LLM request.
+
+_Notification:_ 
+
+* method: `rewrite/contentReceived`
+* params: `RewriteContentReceivedParams` defined as follows:
+
+```typescript
+interface RewriteContentReceivedParams {
+    /**
+     * The rewrite identifier this content belongs to
+     */
+    rewriteId: string;
+
+    /**
+     * The content received
+     */
+    content: RewriteContent;
+}
+
+interface RewriteStartedContent {
+    type: 'started';
 }
+
+interface RewriteTextContent {
+    type: 'text';
+    
+    text: string;
+}
+
+interface RewriteFinishedContent {
+    type: 'finished';
+}
+
+type RewriteContent = 
+    RewriteStartedContent
+    | RewriteTextContent
+    | RewriteFinishedContent;
+             
 ```
 
 ## Configuration
@@ -1473,7 +1515,7 @@ interface ConfigUpdatedParams {
        /**
         * The models the user can use in chat.
         */
-        models?: ChatModel[];
+        models?: Model[];
 
         /**
         * The chat behaviors the user can select.
@@ -1487,7 +1529,7 @@ interface ConfigUpdatedParams {
          * Server returns this when starting and only when makes sense to 
          * force update a model, like a config change.
          */
-        selectModel?: ChatModel;
+        selectModel?: Model;
 
         /**
          * The behavior for client select in chat, if that is present

images/features/rewrite.gif

@@ -136,6 +136,7 @@
                      :maxEntriesPerDir 50}}
    :completion {:model "openai/gpt-4.1"
                 :systemPromptFile "prompts/inline_completion.md"}
+   :rewrite {:systemPromptFile "prompts/rewrite.md"}
    :netrcFile nil
    :env "prod"})
 

src/eca/config.clj

@@ -25,9 +25,6 @@
 (defn ^:private title-prompt-template* [] (slurp (io/resource "prompts/title.md")))
 (def ^:private title-prompt-template (memoize title-prompt-template*))
 
-(defn ^:private rewrite-prompt-template* [] (slurp (io/resource "prompts/rewrite.md")))
-(def ^:private rewrite-prompt-template (memoize rewrite-prompt-template*))
-
 (defn ^:private compact-prompt-template* [file-path]
   (if (fs/relative? file-path)
     (slurp (io/resource file-path))
@@ -106,22 +103,31 @@
      [(contexts-str refined-contexts repo-map*)])))
 
 (defn build-rewrite-instructions [text path full-text range config]
-  (replace-vars
-   (rewrite-prompt-template)
-   {:text text
-    :path (when path
-            (str "- File path: " path))
-    :rangeText (multi-str
-                 (str "- Start line: " (-> range :start :line))
-                 (str "- Start character: " (-> range :start :character))
-                 (str "- End line: " (-> range :end :line))
-                 (str "- End character: " (-> range :end :character)))
-    :fullText (when full-text
-                (multi-str
-                 "- Full file content"
-                 "```"
-                 full-text
-                 "```"))}))
+  (let [prompt-file (-> config :rewrite :systemPromptFile)
+        prompt-str (cond
+                     ;; Absolute path
+                     (and prompt-file (string/starts-with? prompt-file "/"))
+                     (slurp prompt-file)
+
+                     ;; Resource path
+                     :else
+                     (load-builtin-prompt (some-> prompt-file (string/replace-first #"prompts/" ""))))]
+    (replace-vars
+     prompt-str
+     {:text text
+      :path (when path
+              (str "- File path: " path))
+      :rangeText (multi-str
+                  (str "- Start line: " (-> range :start :line))
+                  (str "- Start character: " (-> range :start :character))
+                  (str "- End line: " (-> range :end :line))
+                  (str "- End character: " (-> range :end :character)))
+      :fullText (when full-text
+                  (multi-str
+                   "- Full file content"
+                   "```"
+                   full-text
+                   "```"))})))
 
 (defn init-prompt [db]
   (replace-vars

src/eca/features/prompt.clj

@@ -18,9 +18,9 @@
     :content content}))
 
 (defn prompt
-  [{:keys [id prompt text path range model]} db* config messenger metrics]
+  [{:keys [id prompt text path range]} db* config messenger metrics]
   (let [db @db*
-        full-model (or model
+        full-model (or (get-in config [:rewrite :model])
                        (llm-api/default-model db config))
         [provider model] (string/split full-model #"/" 2)
         model-capabilities (get-in db [:models full-model])

src/eca/features/rewrite.clj

@@ -240,7 +240,7 @@
     (smart-edit/apply-smart-edit file-content original-content new-content path)))
 
 
-(defn ^:private edit-file [arguments {:keys [db]}]
+(defn ^:private edit-file [arguments {:keys [_db]}]
   (or (tools.util/invalid-arguments arguments (concat (path-validations)
                                                       [["path" fs/readable? "File $path is not readable"]]))
       (let [path (get arguments "path")