feat(history): allow title modification via a format_title function (ravitemer#35)

Author: Davidyz

README.md

@@ -113,6 +113,11 @@ require("codecompanion").setup({
                     refresh_every_n_prompts = 0, -- e.g., 3 to refresh after every 3rd user prompt
                     ---Maximum number of times to refresh the title (default: 3)
                     max_refreshes = 3,
+                    format_title = function(original_title)
+                        -- this can be a custom function that applies some custom
+                        -- formatting to the title.
+                        return original_title
+                    end
                 },
                 ---On exiting and entering neovim, loads the last chat on opening chat
                 continue_last_chat = false,

doc/codecompanion-history.txt

@@ -1,4 +1,4 @@
-*codecompanion-history.txt*      For NVIM v0.8.0     Last change: 2025 June 24
+*codecompanion-history.txt*      For NVIM v0.8.0     Last change: 2025 July 05
 
 ==============================================================================
 Table of Contents                    *codecompanion-history-table-of-contents*
@@ -159,6 +159,11 @@ ADD HISTORY EXTENSION TO CODECOMPANION CONFIG ~
                         refresh_every_n_prompts = 0, -- e.g., 3 to refresh after every 3rd user prompt
                         ---Maximum number of times to refresh the title (default: 3)
                         max_refreshes = 3,
+                        format_title = function(original_title)
+                            -- this can be a custom function that applies some custom
+                            -- formatting to the title.
+                            return original_title
+                        end
                     },
                     ---On exiting and entering neovim, loads the last chat on opening chat
                     continue_last_chat = false,

lua/codecompanion/_extensions/history/init.lua

@@ -55,6 +55,7 @@ local default_opts = {
         refresh_every_n_prompts = 0,
         ---Maximum number of times to refresh the title (default: 3)
         max_refreshes = 3,
+        format_title = nil,
     },
     ---On exiting and entering neovim, loads the last chat on opening chat
     continue_last_chat = false,
@@ -189,6 +190,9 @@ function History:_setup_autocommands()
             local should_generate, is_refresh = self.title_generator:should_generate(chat)
             if should_generate then
                 self.title_generator:generate(chat, function(generated_title)
+                    if type(self.opts.title_generation_opts.format_title) == "function" then
+                        generated_title = self.opts.title_generation_opts.format_title(generated_title)
+                    end
                     if generated_title and generated_title ~= "" then
                         -- Always update buffer title for feedback
                         self.ui:_set_buf_title(chat.bufnr, generated_title)

lua/codecompanion/_extensions/history/types.lua

@@ -11,6 +11,7 @@
 ---@field model? string? The model of the adapter to use for generation
 ---@field refresh_every_n_prompts? number Number of user prompts after which to refresh the title (0 to disable)
 ---@field max_refreshes? number Maximum number of times to refresh the title (default: 3)
+---@field format_title? fun(original_title: string):string a function that applies a custom transformation to the title.
 
 ---@class HistoryOpts
 ---@field default_buf_title? string A name for the chat buffer that tells that this is an auto saving chat