some config updates

Author: joaopluigi

docs/configuration.md

@@ -6,122 +6,162 @@ ECA is highly configurable. This page lists all available options and provides c
 
 ```lua
 require("eca").setup({
-  -- === BASIC SETTINGS ===
+  -- === SERVER ===
 
-  -- Enable debug mode (shows detailed logs)
-  debug = false,
-
-  -- Path to ECA binary (empty = automatic download)
+  -- Path to the ECA binary
+  --   - Empty string: automatically download & manage the binary
+  --   - Custom path: use your own binary
   server_path = "",
 
-  -- Extra arguments for ECA server
-  server_args = "--log-level info",
+  -- Extra arguments passed to the ECA server (eca start ...)
+  server_args = "",
+
+  -- === LOGGING ===
+  log = {
+    -- Where to display logs inside Neovim
+    --   "split"  - use a split window
+    --   "float"  - use a floating window
+    --   "none"   - disable the log window
+    display = "split",
 
-  -- Usage string format (tokens/cost)
-  usage_string_format = "{messageCost} / {sessionCost}",
+    -- Minimum log level to record
+    --   vim.log.levels.TRACE | DEBUG | INFO | WARN | ERROR
+    level = vim.log.levels.INFO,
+
+    -- Optional file path for persistent logs (empty = disabled)
+    file = "",
+
+    -- Maximum log file size before ECA warns you (in MB)
+    max_file_size_mb = 10,
+  },
 
   -- === BEHAVIOR ===
   behavior = {
-    -- Set keymaps automatically
+    -- Set default keymaps automatically
     auto_set_keymaps = true,
 
-    -- Focus sidebar automatically when opening
+    -- Focus the ECA sidebar when opening it
     auto_focus_sidebar = true,
 
-    -- Start server automatically
+    -- Automatically start the server on plugin setup
     auto_start_server = false,
 
-    -- Download server automatically if not found
+    -- Automatically download the server if not found
     auto_download = true,
 
-    -- Show status updates in notifications
+    -- Show status updates (startup, downloads, errors) as notifications
     show_status_updates = true,
   },
 
-  -- === KEY MAPPINGS ===
-  mappings = {
-    chat = "<leader>ec",      -- Open chat
-    focus = "<leader>ef",     -- Focus sidebar
-    toggle = "<leader>et",    -- Toggle sidebar
+  -- === CONTEXT ===
+  context = {
+    -- Automatically attach repo context (repoMap) when starting new chats
+    auto_repo_map = true,
   },
 
-  -- === CHAT ===
-  chat = {
-    headers = {
-      user = "> ",
-      assistant = "",
-    },
-    welcome = {
-      -- If non-empty, overrides server-provided welcome message
-      message = "",
-      -- Tips appended under the welcome (set {} to disable)
-      tips = {
-        "Type your message and use CTRL+s to send",
-      },
-    },
-    tool_call = {
-      icons = {
-        success = "✅",   -- Shown when a tool call succeeds
-        error = "❌",     -- Shown when a tool call fails
-        running = "⏳",   -- Shown while a tool call is running / has no final status yet
-        expanded = "▲",   -- Arrow when the tool call details are expanded
-        collapsed = "▶",  -- Arrow when the tool call details are collapsed
-      },
-      diff_label = {
-        collapsed = "+ view diff", -- Label when the diff is collapsed
-        expanded = "- view diff",  -- Label when the diff is expanded
-      },
-    },
-    reasoning = {
-      -- When true, "Thinking" blocks are expanded by default
-      expanded = false,
-      -- Customize the labels used for the reasoning block
-      running_label = "Thinking...",
-      finished_label = "Thought",
-    },
+  -- === TODOS PANEL ===
+  todos = {
+    enabled = true,  -- Enable or disable todos integration
+    max_height = 5,  -- Maximum height for the todos container
+  },
+
+  -- === SELECTED CODE PANEL ===
+  selected_code = {
+    enabled = true,  -- Show currently selected code in the UI
+    max_height = 8,  -- Maximum height for the selected code container
+  },
+
+  -- === KEY MAPPINGS ===
+  mappings = {
+    chat = "<leader>ec",  -- Open chat
+    focus = "<leader>ef", -- Focus sidebar
+    toggle = "<leader>et",-- Toggle sidebar
   },
 
-  -- === WINDOW SETTINGS ===
+  -- === WINDOWS & UI ===
   windows = {
-    -- Automatic line wrapping
+    -- Automatic line wrapping in ECA buffers
     wrap = true,
 
-    -- Width as percentage of screen (1-100)
+    -- Width as percentage of Neovim columns (1–100)
     width = 40,
 
     -- Sidebar header configuration
     sidebar_header = {
       enabled = true,
-      align = "center",     -- "left", "center", "right"
+      align = "center",   -- "left", "center", "right"
       rounded = true,
     },
 
     -- Input area configuration
     input = {
-      prefix = "> ",        -- Input line prefix
-      height = 8,           -- Input window height
+      prefix = "> ",     -- Input line prefix
+      height = 8,          -- Input window height (lines)
+
+      -- Maximum length for web context names in the input area
+      web_context_max_len = 20,
     },
 
     -- Edit window configuration
     edit = {
-      border = "rounded",   -- "none", "single", "double", "rounded"
-      start_insert = true,  -- Start in insert mode
+      border = "rounded", -- "none", "single", "double", "rounded"
+      start_insert = true, -- Start in insert mode
     },
 
-    -- Ask window configuration
-    ask = {
-      floating = false,     -- Use floating window
-      start_insert = true,  -- Start in insert mode
-      border = "rounded",
-      focus_on_apply = "ours", -- "ours" or "theirs"
+    -- Usage line configuration (token / cost display)
+    usage = {
+      -- Supported placeholders:
+      --   {session_tokens}        - raw session token count (e.g. "30376")
+      --   {limit_tokens}          - raw token limit (e.g. "400000")
+      --   {session_tokens_short}  - shortened session tokens (e.g. "30k")
+      --   {limit_tokens_short}    - shortened token limit (e.g. "400k")
+      --   {session_cost}          - session cost (e.g. "0.09")
+      -- Default: "30k / 400k ($0.09)" ->
+      --   "{session_tokens_short} / {limit_tokens_short} (${session_cost})"
+      format = "{session_tokens_short} / {limit_tokens_short} (${session_cost})",
     },
-  },
 
-  -- === HIGHLIGHTS AND COLORS ===
-  highlights = {
-    diff = {
-      current = "DiffText",   -- Highlight for current diff
-      incoming = "DiffAdd",   -- Highlight for incoming diff
+    -- Chat window & behavior
+    chat = {
+      -- Prefixes for each speaker
+      headers = {
+        user = "> ",
+        assistant = "",
+      },
+
+      -- Welcome message configuration
+      welcome = {
+        -- If non-empty, overrides the server-provided welcome message
+        message = "",
+
+        -- Tips appended under the welcome (set {} to disable)
+        tips = {
+          "Type your message and use CTRL+s to send",
+        },
+      },
+
+      -- Tool call display settings
+      tool_call = {
+        icons = {
+          success = "✅",  -- Shown when a tool call succeeds
+          error = "❌",    -- Shown when a tool call fails
+          running = "⏳",  -- Shown while a tool call is running
+          expanded = "▼",  -- Arrow when the tool call details are expanded
+          collapsed = "▶", -- Arrow when the tool call details are collapsed
+        },
+        diff = {
+          collapsed_label = "+ view diff", -- Label when the diff is collapsed
+          expanded_label = "- view diff",  -- Label when the diff is expanded
+          expanded = false,                -- When true, tool diffs start expanded
+        },
+      },
+
+      -- Reasoning ("Thinking") block behavior
+      reasoning = {
+        expanded = false,              -- When true, "Thinking" blocks start expanded
+        running_label = "Thinking...", -- Label while reasoning is running
+        finished_label = "Thought",    -- Base label when reasoning is finished
+      },
     },
   },
 })
@@ -131,21 +171,27 @@ require("eca").setup({
 
 ## Presets
 
+These examples show how to override just a subset of the configuration.
+
 ### Minimalist
 ```lua
 require("eca").setup({
-  behavior = { show_status_updates = false },
-  windows = { width = 30 },
-  chat = {
-    headers = {
-      user = "> ",
-      assistant = "",
+  behavior = {
+    show_status_updates = false,
+  },
+  windows = {
+    width = 30,
+    chat = {
+      headers = {
+        user = "> ",
+        assistant = "",
+      },
     },
   },
 })
 ```
 
-### Visual/UX focused
+### Visual / UX focused
 ```lua
 require("eca").setup({
   behavior = { auto_focus_sidebar = true },
@@ -154,11 +200,14 @@ require("eca").setup({
     wrap = true,
     sidebar_header = { enabled = true, rounded = true },
     input = { prefix = "💬 ", height = 10 },
-  },
-  chat = {
-    headers = {
-      user = "## 👤 You\n\n",
-      assistant = "## 🤖 ECA\n\n",
+    chat = {
+      headers = {
+        user = "## 👤 You\n\n",
+        assistant = "## 🤖 ECA\n\n",
+      },
+      reasoning = {
+        expanded = true,
+      },
     },
   },
 })
@@ -167,35 +216,21 @@ require("eca").setup({
 ### Development
 ```lua
 require("eca").setup({
-  debug = true,
   server_args = "--log-level debug",
-  behavior = {
-    auto_start_server = true,
-    show_status_updates = true,
-  },
-  mappings = {
-    chat = "<F12>",
-    toggle = "<F11>",
-    focus = "<F10>",
-  },
-})
-```
-
-### Performance-oriented
-```lua
-require("eca").setup({
-  behavior = {
-    auto_focus_sidebar = false,
-    show_status_updates = false,
+  log = {
+    level = vim.log.levels.DEBUG,
+    display = "split",
   },
-  windows = { width = 25 },
 })
 ```
 
 ---
 
 ## Notes
 - Set `server_path` if you prefer using a local ECA binary.
-- For noisy environments, disable `show_status_updates`.
+- Use the `log` block to control verbosity and where logs are written.
+- `context.auto_repo_map` controls whether repo context is attached automatically.
+- `todos` and `selected_code` can be disabled entirely if you prefer a simpler UI.
 - Adjust `windows.width` to fit your layout.
-- Keymaps can be set manually by turning off `auto_set_keymaps`.
+- Keymaps can be set manually by turning off `behavior.auto_set_keymaps` and defining your own mappings.
+- The `windows.usage.format` string controls how token and cost usage are displayed.