refactor(ui): diff resets winbar and doc updates (#2432)

Co-authored-by: Oli Morris <olimorris@users.noreply.github.com>

Author: olimorris

doc/.vitepress/config.mjs

@@ -1,5 +1,6 @@
 import { joinURL, withoutTrailingSlash } from "ufo";
 import { defineConfig } from "vitepress";
+import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
 import { execSync } from "node:child_process";
 import { withMermaid } from "vitepress-plugin-mermaid";
 
@@ -74,6 +75,11 @@ const headers = inProd ? [...baseHeaders, umamiScript] : baseHeaders;
 // https://vitepress.dev/reference/site-config
 export default withMermaid(
   defineConfig({
+    markdown: {
+      config(md) {
+        md.use(tabsMarkdownPlugin);
+      },
+    },
     mermaid: {
       securityLevel: "loose", // Allows more flexibility
       theme: "base", // Use base theme to allow CSS variables to take effect

doc/.vitepress/theme/index.js

@@ -1,4 +1,10 @@
 import DefaultTheme from "vitepress/theme";
 import "./vaporwave.css";
+import { enhanceAppWithTabs } from "vitepress-plugin-tabs/client";
 
-export default DefaultTheme;
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    enhanceAppWithTabs(app);
+  },
+};

doc/codecompanion.txt

@@ -1,4 +1,4 @@
-*codecompanion.txt*        For NVIM v0.11        Last change: 2025 November 23
+*codecompanion.txt*        For NVIM v0.11        Last change: 2025 November 24
 
 ==============================================================================
 Table of Contents                            *codecompanion-table-of-contents*
@@ -1866,69 +1866,9 @@ utilize the `insert_edit_into_file` tool, then the plugin can update files and
 buffers and a diff will be created so you can see the changes made by the LLM.
 The `inline` is the default diff.
 
-There are a number of diff settings available to you:
+Depending on which provider you choose, there are different configuration
+options available to you:
 
->lua
-    require("codecompanion").setup({
-      display = {
-        diff = {
-          enabled = true,
-          provider = providers.diff, -- mini_diff|split|inline
-    
-          provider_opts = {
-            -- Options for inline diff provider
-            inline = {
-              layout = "float", -- float|buffer - Where to display the diff
-    
-              diff_signs = {
-                signs = {
-                  text = "▌", -- Sign text for normal changes
-                  reject = "✗", -- Sign text for rejected changes in super_diff
-                  highlight_groups = {
-                    addition = "DiagnosticOk",
-                    deletion = "DiagnosticError",
-                    modification = "DiagnosticWarn",
-                  },
-                },
-                -- Super Diff options
-                icons = {
-                  accepted = " ",
-                  rejected = " ",
-                },
-                colors = {
-                  accepted = "DiagnosticOk",
-                  rejected = "DiagnosticError",
-                },
-              },
-    
-              opts = {
-                context_lines = 3, -- Number of context lines in hunks
-                dim = 25, -- Background dim level for floating diff (0-100, [100 full transparent], only applies when layout = "float")
-                full_width_removed = true, -- Make removed lines span full width
-                show_keymap_hints = true, -- Show "gda: accept | gdr: reject" hints above diff
-                show_removed = true, -- Show removed lines as virtual text
-              },
-            },
-    
-            -- Options for the split provider
-            split = {
-              close_chat_at = 240, -- Close an open chat buffer if the total columns of your display are less than...
-              layout = "vertical", -- vertical|horizontal split
-              opts = {
-                "internal",
-                "filler",
-                "closeoff",
-                "algorithm:histogram", -- https://adamj.eu/tech/2024/01/18/git-improve-diff-histogram/
-                "indent-heuristic", -- https://blog.k-nut.eu/better-git-diffs
-                "followwrap",
-                "linematch:120",
-              },
-            },
-          },
-        },
-      },
-    })
-<
 
 You can also customize the window that the diff appears in (taking precedence
 over `child_window`):

doc/configuration/chat-buffer.md

@@ -429,41 +429,32 @@ require("codecompanion").setup({
 
 CodeCompanion has built-in inline and split diffs available to you. If you utilize the `insert_edit_into_file` tool, then the plugin can update files and buffers and a diff will be created so you can see the changes made by the LLM. The `inline` is the default diff.
 
-There are a number of diff settings available to you:
+Depending on which provider you choose, there are different configuration options available to you:
+
+:::tabs
+
+== Select Provider
 
 ```lua
 require("codecompanion").setup({
   display = {
     diff = {
       enabled = true,
-      provider = providers.diff, -- mini_diff|split|inline
+      provider = providers.diff, -- inline|split|mini.diff
+    },
+  },
+})
+```
 
+== Inline Provider
+
+```lua
+require("codecompanion").setup({
+  display = {
+    diff = {
       provider_opts = {
-        -- Options for inline diff provider
         inline = {
           layout = "float", -- float|buffer - Where to display the diff
-
-          diff_signs = {
-            signs = {
-              text = "▌", -- Sign text for normal changes
-              reject = "✗", -- Sign text for rejected changes in super_diff
-              highlight_groups = {
-                addition = "DiagnosticOk",
-                deletion = "DiagnosticError",
-                modification = "DiagnosticWarn",
-              },
-            },
-            -- Super Diff options
-            icons = {
-              accepted = " ",
-              rejected = " ",
-            },
-            colors = {
-              accepted = "DiagnosticOk",
-              rejected = "DiagnosticError",
-            },
-          },
-
           opts = {
             context_lines = 3, -- Number of context lines in hunks
             dim = 25, -- Background dim level for floating diff (0-100, [100 full transparent], only applies when layout = "float")
@@ -472,8 +463,19 @@ require("codecompanion").setup({
             show_removed = true, -- Show removed lines as virtual text
           },
         },
+      },
+    },
+  },
+})
+```
+
+== Split Provider
 
-        -- Options for the split provider
+```lua
+require("codecompanion").setup({
+  display = {
+    diff = {
+      provider_opts = {
         split = {
           close_chat_at = 240, -- Close an open chat buffer if the total columns of your display are less than...
           layout = "vertical", -- vertical|horizontal split
@@ -493,6 +495,9 @@ require("codecompanion").setup({
 })
 ```
 
+
+:::
+
 You can also customize the window that the diff appears in (taking precedence over `child_window`):
 
 ```lua

doc/package-lock.json

@@ -4,7 +4,8 @@
     "mermaid": "^11.10.0",
     "ufo": "^1.6.1",
     "vitepress": "^1.5.0",
-    "vitepress-plugin-mermaid": "^2.0.17"
+    "vitepress-plugin-mermaid": "^2.0.17",
+    "vitepress-plugin-tabs": "^0.7.3"
   },
   "scripts": {
     "dev": "vitepress dev",

doc/package.json

@@ -7,13 +7,14 @@ local api = vim.api
 ---@class CodeCompanion.Diff.Inline
 ---@field bufnr number
 ---@field contents string[]
----@field id number
----@field ns_id number
 ---@field extmark_ids number[]
 ---@field has_changes boolean
----@field winnr number|nil
+---@field id number
 ---@field is_floating boolean
+---@field ns_id number
 ---@field show_hints boolean
+---@field winnr number|nil
+---@field winbar {content: string, winhighlight: string}|nil Original winbar state
 
 ---@class CodeCompanion.Diff.Inline
 local InlineDiff = {}
@@ -22,9 +23,9 @@ local InlineDiff = {}
 ---@field bufnr number Buffer number to apply diff to
 ---@field contents string[] Original content lines
 ---@field id number|string Unique identifier for this diff
----@field winnr? number Window number (optional)
 ---@field is_floating boolean|nil Whether this diff is in a floating window
 ---@field show_hints? boolean Whether to show keymap hints (default: true)
+---@field winnr? number Window number (optional)
 
 ---Creates a new InlineDiff instance and applies diff highlights
 ---@param args CodeCompanion.Diff.InlineArgs
@@ -33,15 +34,19 @@ function InlineDiff.new(args)
   local self = setmetatable({
     bufnr = args.bufnr,
     contents = args.contents,
+    extmark_ids = {},
+    has_changes = false,
     id = args.id,
-    winnr = args.winnr,
     is_floating = args.is_floating or false,
-    show_hints = args.show_hints == nil and true or args.show_hints,
     ns_id = api.nvim_create_namespace(
       "codecompanion_inline_diff_" .. (args.id ~= nil and args.id or math.random(1, 100000))
     ),
-    extmark_ids = {},
-    has_changes = false,
+    show_hints = args.show_hints == nil and true or args.show_hints,
+    winnr = args.winnr,
+    winbar = {
+      content = vim.wo[args.winnr or 0].winbar or "",
+      winhighlight = vim.wo[args.winnr or 0].winhighlight or "",
+    },
   }, { __index = InlineDiff })
   ---@cast self CodeCompanion.Diff.Inline
 
@@ -231,11 +236,11 @@ end
 
 ---Clear winbar and winhighlight from the diff window
 ---@return nil
-function InlineDiff:clear_winbar()
+function InlineDiff:restore_winbar()
   if self.winnr and api.nvim_win_is_valid(self.winnr) then
     pcall(function()
-      vim.wo[self.winnr].winbar = ""
-      vim.wo[self.winnr].winhighlight = ""
+      vim.wo[self.winnr].winbar = self.winbar.content
+      vim.wo[self.winnr].winhighlight = self.winbar.winhighlight
     end)
   end
 end
@@ -261,7 +266,7 @@ function InlineDiff:teardown()
     end)
   end)
   self:clear_highlights()
-  self:clear_winbar()
+  self:restore_winbar()
   self:close_floating_window()
   utils.fire("DiffDetached", { diff = "inline", bufnr = self.bufnr, id = self.id })
 end