feat(output): add fold support for tool output (#367)

sudo-tee · web-flow · commit 5e45018a3439 · 2026-04-29T09:26:06.000-04:00
* feat(output): add fold support for tool output This should resolves #351
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,11 +14,10 @@ jobs:
     name: lint
     steps:
       - uses: actions/checkout@v4
-
       - uses: JohnnyMorganz/stylua-action@v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
+          token: ${{ secrets.GITHUB_TOKEN }}
           args: --check . -g '*.lua' -g '!deps/'
 
   test:
diff --git a/README.md b/README.md
@@ -240,6 +240,8 @@ require('opencode').setup({
       tools = {
         show_output = true, -- Show tools output [diffs, cmd output, etc.] (default: true)
         show_reasoning_output = true, -- Show reasoning/thinking steps output (default: true)
+        use_folds = true, -- Use folds for tool output (default: true)
+        folding_threshold = 5, -- Number of lines to show before folding when show_output is true (default: 5)
       },
       rendering = {
         markdown_debounce_ms = 250, -- Debounce time for markdown rendering on new data (default: 250ms)
diff --git a/lua/opencode/config.lua b/lua/opencode/config.lua
@@ -163,7 +163,10 @@ M.defaults = {
       tools = {
         show_output = true,
         show_reasoning_output = true,
+        use_folds = true,
+        folding_threshold = 20,
       },
+
       max_messages = nil,
       always_scroll_to_bottom = false,
     },
diff --git a/lua/opencode/types.lua b/lua/opencode/types.lua
@@ -242,7 +242,7 @@
 ---@field event_collapsing boolean
 
 ---@class OpencodeUIOutputConfig
----@field tools { show_output: boolean, show_reasoning_output: boolean }
+---@field tools { show_output: boolean, show_reasoning_output: boolean, use_folds: boolean, folding_threshold: number }
 ---@field rendering OpencodeUIOutputRenderingConfig
 ---@field max_messages integer|nil
 ---@field always_scroll_to_bottom boolean
diff --git a/lua/opencode/ui/formatter.lua b/lua/opencode/ui/formatter.lua
@@ -35,10 +35,13 @@ function M._format_reasoning(output, part)
 
   format_utils.format_action(output, icons.get('reasoning'), title, '')
 
-  if config.ui.output.tools.show_reasoning_output and text ~= '' then
+  local show = config.ui.output.tools.show_reasoning_output
+  local use_folds = config.ui.output.tools.use_folds
+  if (show or use_folds) and text ~= '' then
     output:add_empty_line()
     output:add_lines(vim.split(text, '\n'))
     output:add_empty_line()
+    output:add_fold_with_threshold(start_line, show, use_folds)
   end
 
   local end_line = output:get_line_count()
diff --git a/lua/opencode/ui/formatter/tools/apply_patch.lua b/lua/opencode/ui/formatter/tools/apply_patch.lua
@@ -38,9 +38,11 @@ function M.format(output, part)
     )
 
     local patch = file.diff or file.patch
-    if config.ui.output.tools.show_output and patch then
+    if (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) and patch then
+      local start_line = output:get_line_count() + 1
       local file_type = file and util.get_markdown_filetype(file.filePath) or ''
       formatter_utils.format_diff(output, patch, file_type)
+      output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
     end
   end
 end
diff --git a/lua/opencode/ui/formatter/tools/bash.lua b/lua/opencode/ui/formatter/tools/bash.lua
@@ -20,7 +20,8 @@ function M.format(output, part)
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get('run'), 'run', input.description, utils.get_duration_text(part))
 
-  if not config.ui.output.tools.show_output then
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
@@ -29,6 +30,8 @@ function M.format(output, part)
     local command_output = metadata.output and metadata.output ~= '' and ('\n' .. metadata.output) or ''
     utils.format_code(output, vim.split('> ' .. command .. '\n' .. command_output, '\n'), 'bash')
   end
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param _ OpencodeMessagePart
diff --git a/lua/opencode/ui/formatter/tools/file.lua b/lua/opencode/ui/formatter/tools/file.lua
@@ -65,7 +65,8 @@ function M.format(output, part)
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get(tool_type), tool_type, file_name, utils.get_duration_text(part))
 
-  if not config.ui.output.tools.show_output then
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
@@ -74,6 +75,8 @@ function M.format(output, part)
   elseif tool_type == 'write' and input.content then
     utils.format_code(output, vim.split(input.content, '\n'), file_type)
   end
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param part OpencodeMessagePart
diff --git a/lua/opencode/ui/formatter/tools/glob.lua b/lua/opencode/ui/formatter/tools/glob.lua
@@ -16,12 +16,16 @@ function M.format(output, part)
 
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get('search'), 'glob', input.pattern, utils.get_duration_text(part))
-  if not config.ui.output.tools.show_output then
+
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
   local prefix = metadata.truncated and ' more than' or ''
   output:add_line(string.format('Found%s `%d` file(s):', prefix, metadata.count or 0))
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param _ OpencodeMessagePart
diff --git a/lua/opencode/ui/formatter/tools/grep.lua b/lua/opencode/ui/formatter/tools/grep.lua
@@ -53,14 +53,18 @@ function M.format(output, part)
 
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get('search'), 'grep', resolve_grep_string(input), utils.get_duration_text(part))
-  if not config.ui.output.tools.show_output then
+
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
   local prefix = metadata.truncated and ' more than' or ''
   output:add_line(
     string.format('Found%s `%d` match' .. (metadata.matches ~= 1 and 'es' or ''), prefix, metadata.matches or 0)
   )
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param _ OpencodeMessagePart
diff --git a/lua/opencode/ui/formatter/tools/list.lua b/lua/opencode/ui/formatter/tools/list.lua
@@ -15,13 +15,16 @@ function M.format(output, part)
 
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get('list'), 'list', input.path or '', utils.get_duration_text(part))
-  if not config.ui.output.tools.show_output then
+
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
   local lines = vim.split(vim.trim(tool_output), '\n')
   if #lines < 1 or metadata.count == 0 then
     output:add_line('No files found.')
+    output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
     return
   end
   if #lines > 1 then
@@ -36,6 +39,8 @@ function M.format(output, part)
   if metadata.truncated then
     output:add_line(string.format('Results truncated, showing first %d files', metadata.count or '?'))
   end
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param _ OpencodeMessagePart
diff --git a/lua/opencode/ui/formatter/tools/question.lua b/lua/opencode/ui/formatter/tools/question.lua
@@ -17,7 +17,9 @@ function M.format(output, part)
   local icons = require('opencode.ui.icons')
   utils.format_action(output, icons.get('question'), 'question', '', nil)
   output:add_empty_line()
-  if not config.ui.output.tools.show_output or (part.state and part.state.status) ~= 'completed' then
+
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) or (part.state and part.state.status) ~= 'completed' then
     return
   end
 
@@ -46,6 +48,8 @@ function M.format(output, part)
       output:add_line('')
     end
   end
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 return M
diff --git a/lua/opencode/ui/formatter/tools/task.lua b/lua/opencode/ui/formatter/tools/task.lua
@@ -46,7 +46,8 @@ function M.format(output, part, get_child_parts)
 
   utils.format_action(output, icons.get('task'), 'task', description, utils.get_duration_text(part))
 
-  if config.ui.output.tools.show_output then
+  local output_start_line = output:get_line_count() + 1
+  if config.ui.output.tools.show_output or config.ui.output.tools.use_folds then
     local child_session_id = metadata.sessionId
     local child_parts = child_session_id and get_child_parts and get_child_parts(child_session_id)
 
@@ -71,6 +72,8 @@ function M.format(output, part, get_child_parts)
         output:add_empty_line()
       end
     end
+
+    output:add_fold_with_threshold(output_start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
   end
 
   local end_line = output:get_line_count()
diff --git a/lua/opencode/ui/formatter/tools/todowrite.lua b/lua/opencode/ui/formatter/tools/todowrite.lua
@@ -18,15 +18,21 @@ function M.format(output, part)
     (part.state and part.state.title or ''),
     utils.get_duration_text(part)
   )
-  if not config.ui.output.tools.show_output then
+
+  local start_line = output:get_line_count() + 1
+  if not (config.ui.output.tools.show_output or config.ui.output.tools.use_folds) then
     return
   end
 
   local statuses = { in_progress = '-', completed = 'x', pending = ' ' }
-  local todos = part.state and part.state.input and part.state.input.todos or {}
+  local todos = part.state and part.state.input and type(part.state.input.todos) == 'table' and part.state.input.todos
+    or {}
+
   for _, item in ipairs(todos) do
     output:add_line(string.format('- [%s] %s ', statuses[item.status], item.content))
   end
+
+  output:add_fold_with_threshold(start_line, config.ui.output.tools.show_output, config.ui.output.tools.use_folds)
 end
 
 ---@param part OpencodeMessagePart
diff --git a/lua/opencode/ui/output.lua b/lua/opencode/ui/output.lua
@@ -1,3 +1,5 @@
+local config = require('opencode.config')
+
 local Output = {}
 Output.__index = Output
 
@@ -24,6 +26,7 @@ function Output.new()
   self.lines = {}
   self.extmarks = {}
   self.actions = {}
+  self.fold_ranges = {}
   return self
 end
 
@@ -83,6 +86,34 @@ function Output:clear()
   self.actions = {}
 end
 
+---Add a fold range
+---@param start_line number
+---@param end_line number
+function Output:add_fold(start_line, end_line)
+  table.insert(self.fold_ranges, { from = start_line, to = end_line })
+end
+
+---Add fold with threshold awareness
+---@param start_line number Line where content starts
+---@param show boolean Whether content is visible
+---@param use_folds boolean Whether folds are enabled
+function Output:add_fold_with_threshold(start_line, show, use_folds)
+  if not use_folds then
+    return
+  end
+
+  local threshold = config.ui.output.tools.folding_threshold or 5
+  local end_line = self:get_line_count()
+
+  if not show then
+    if end_line > start_line then
+      self:add_fold(start_line, end_line)
+    end
+  elseif end_line > start_line + threshold then
+    self:add_fold(start_line + threshold, end_line)
+  end
+end
+
 ---Get the number of lines
 ---@return number
 function Output:get_line_count()
diff --git a/lua/opencode/ui/output_window.lua b/lua/opencode/ui/output_window.lua
diff --git a/lua/opencode/ui/renderer.lua b/lua/opencode/ui/renderer.lua
diff --git a/lua/opencode/ui/renderer/buffer.lua b/lua/opencode/ui/renderer/buffer.lua
diff --git a/lua/opencode/ui/renderer/ctx.lua b/lua/opencode/ui/renderer/ctx.lua
diff --git a/lua/opencode/ui/renderer/flush.lua b/lua/opencode/ui/renderer/flush.lua
diff --git a/lua/opencode/ui/topbar.lua b/lua/opencode/ui/topbar.lua
diff --git a/tests/unit/output_window_spec.lua b/tests/unit/output_window_spec.lua
