feat: GpChatHelp to toggle help comments

Author: Robitx

after/ftplugin/gpchat.lua

@@ -37,6 +37,12 @@ local commands = {
 		shortcut = M.config.chat_shortcut_new.shortcut,
 		comment = "GPT prompt Chat New",
 	},
+	{
+		command = "ChatHelp",
+		modes = M.config.chat_shortcut_help.modes,
+		shortcut = M.config.chat_shortcut_help.shortcut,
+		comment = "GPT prompt Chat Help",
+	},
 }
 for _, rc in ipairs(commands) do
 	local cmd = M.config.cmd_prefix .. rc.command .. "<cr>"
@@ -124,6 +130,8 @@ vim.api.nvim_create_autocmd({ "User" }, {
 
 		M.logger.debug("gpchat: refreshing buffer " .. buf .. " " .. vim.json.encode(event))
 
+		M.chat_help(buf)
+
 		vim.api.nvim_buf_clear_namespace(buf, ns_id, 0, -1)
 
 		vim.api.nvim_buf_set_extmark(buf, ns_id, 0, 0, {

lua/gp/config.lua

@@ -310,6 +310,7 @@ local config = {
 	chat_shortcut_delete = { modes = { "n", "i", "v", "x" }, shortcut = "<C-g>d" },
 	chat_shortcut_stop = { modes = { "n", "i", "v", "x" }, shortcut = "<C-g>s" },
 	chat_shortcut_new = { modes = { "n", "i", "v", "x" }, shortcut = "<C-g>c" },
+	chat_shortcut_help = { modes = { "n", "i", "v", "x" }, shortcut = "<C-g>h" },
 	-- default search term when using :GpChatFinder
 	chat_finder_pattern = "topic ",
 	-- if true, finished ChatResponder won't move the cursor to the end of the buffer

lua/gp/defaults.lua

@@ -13,14 +13,19 @@ M.code_system_prompt = "You are an AI working as a code editor.\n\n"
 	.. "Please AVOID COMMENTARY OUTSIDE OF THE SNIPPET RESPONSE.\n"
 	.. "START AND END YOUR ANSWER WITH:\n\n```"
 
-M.chat_template = [[
----
-topic: ?
-{{optional_headers}}
+M.chat_help = [[
 # Write your queries after {{user_prefix}}. Use `{{respond_shortcut}}` or :{{cmd_prefix}}ChatRespond to generate a response.
 # Response generation can be terminated by using `{{stop_shortcut}}` or :{{cmd_prefix}}ChatStop command.
 # Chats are saved automatically. To delete this chat, use `{{delete_shortcut}}` or :{{cmd_prefix}}ChatDelete.
 # Be cautious of very long chats. Start a fresh chat by using `{{new_shortcut}}` or :{{cmd_prefix}}ChatNew.
+# See available macros by typing @ in the chat. Toggle this	help by using `{{help_shortcut}}` or :{{cmd_prefix}}ChatHelp.]]
+
+M.chat_template = [[
+---
+topic: ?
+{{optional_headers}}
+]] .. M.chat_help .. [[
+
 ---
 
 {{user_prefix}}

lua/gp/helper.lua

@@ -63,6 +63,18 @@ _H.autocmd = function(events, buffers, callback, gid)
 	end
 end
 
+---@param callback function # callback to schedule
+---@param depth number # depth of nested scheduling
+_H.schedule = function(callback, depth)
+	logger.debug("scheduling callback with depth: " .. depth)
+	if depth <= 0 then
+		return callback()
+	end
+	return vim.schedule(function()
+		_H.schedule(callback, depth - 1)
+	end)
+end
+
 ---@param file_name string # name of the file for which to delete buffers
 _H.delete_buffer = function(file_name)
 	-- iterate over buffer list and close all buffers with the same name
@@ -294,24 +306,27 @@ _H.create_user_command = function(cmd_name, cmd_func, completion, desc)
 end
 
 ---@param lines string[] # array of lines
----@return table<string, any>, table<string, number>, number | nil # headers, indices, last header line
+---@return table<string, any>, table<string, number>, number | nil, table<string, number> # headers, indices, last header line, comments
 _H.parse_headers = function(lines)
 	local headers = {}
 	local indices = {}
+	local comments = {}
 
 	for i, line in ipairs(lines) do
 		if i > 1 and line:sub(1, 3) == "---" then
-			return headers, indices, i - 1
+			return headers, indices, i - 1, comments
 		end
 
 		local key, value = line:match("^[-#%s]*(%w+):%s*(.*)%s*")
 		if key ~= nil then
 			headers[key] = value
 			indices[key] = i - 1
+		elseif line:match("^# ") then
+			comments[line] = i - 1
 		end
 	end
 
-	return headers, indices, nil
+	return headers, indices, nil, comments
 end
 
 ---@param buf number # buffer number

lua/gp/init.lua

@@ -242,17 +242,34 @@ M.setup = function(opts)
 		if M.hooks[cmd] == nil then
 			M.helpers.create_user_command(M.config.cmd_prefix .. cmd, function(params)
 				M.logger.debug("running command: " .. cmd)
-				M.refresh_state()
+				if cmd ~= "ChatHelp" then
+					M.refresh_state()
+				end
 				M.cmd[cmd](params)
 			end, completions[cmd])
 		end
 	end
 
+	vim.filetype.add({
+		extension = {
+			md = function(path, buf)
+				M.logger.debug("filetype markdown: " .. path .. " buf: " .. buf)
+				if not M.not_chat(buf, path) then
+					return "markdown.gpchat"
+				end
+
+				if M.helpers.ends_with(path, ".gp.md") then
+					return "markdown.gpmd"
+				end
+				return "markdown"
+			end,
+		},
+	})
+
 	vim.api.nvim_create_autocmd("BufEnter", {
 		pattern = "*.md",
 		callback = function(ev)
-			vim.defer_fn(function()
-				M.logger.debug("Markdown BufEnter: " .. ev.file)
+			M.helpers.schedule(function()
 				local path = ev.file
 				local buf = ev.buf
 				local current_ft = vim.bo[buf].filetype
@@ -262,7 +279,7 @@ M.setup = function(opts)
 					vim.bo[buf].filetype = "markdown.gpmd"
 				end
 				vim.cmd("doautocmd User GpRefresh")
-			end, 100)
+			end, 3)
 		end,
 	})
 
@@ -313,6 +330,10 @@ M.refresh_state = function(update)
 		M._state.last_chat = nil
 	end
 
+	if M._state.show_chat_help == nil then
+		M._state.show_chat_help = true
+	end
+
 	for k, _ in pairs(M._state) do
 		if M._state[k] ~= old_state[k] or M._state[k] ~= disk_state[k] then
 			M.logger.debug(
@@ -699,6 +720,7 @@ M.new_chat = function(params, toggle, system_prompt, agent)
 		["{{stop_shortcut}}"] = M.config.chat_shortcut_stop.shortcut,
 		["{{delete_shortcut}}"] = M.config.chat_shortcut_delete.shortcut,
 		["{{new_shortcut}}"] = M.config.chat_shortcut_new.shortcut,
+		["{{help_shortcut}}"] = M.config.chat_shortcut_help.shortcut,
 	})
 
 	-- escape underscores (for markdown)
@@ -1041,6 +1063,64 @@ M.chat_respond = function(params)
 	)
 end
 
+---@param buf number
+M.chat_help = function(buf)
+	local file_name = vim.api.nvim_buf_get_name(buf)
+	M.logger.debug("ChatHelp: buffer: " .. buf .. " file: " .. file_name)
+	local reason = M.not_chat(buf, file_name)
+	if reason then
+		M.logger.debug("File " .. vim.inspect(file_name) .. " does not look like a chat file: " .. vim.inspect(reason))
+		return
+	end
+
+	local lines = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
+	local _, _, header_end, comments = M.helpers.parse_headers(lines)
+	if header_end == nil then
+		M.logger.error("Error while parsing headers: --- not found. Check your chat template.")
+		return
+	end
+
+	local help_template = M.render.template(M.defaults.chat_help, {
+		["{{user_prefix}}"] = M.config.chat_user_prefix,
+		["{{respond_shortcut}}"] = M.config.chat_shortcut_respond.shortcut,
+		["{{cmd_prefix}}"] = M.config.cmd_prefix,
+		["{{stop_shortcut}}"] = M.config.chat_shortcut_stop.shortcut,
+		["{{delete_shortcut}}"] = M.config.chat_shortcut_delete.shortcut,
+		["{{new_shortcut}}"] = M.config.chat_shortcut_new.shortcut,
+		["{{help_shortcut}}"] = M.config.chat_shortcut_help.shortcut,
+	})
+
+	local help_lines = vim.split(help_template, "\n")
+	local help_map = {}
+	for _, line in ipairs(help_lines) do
+		help_map[line] = true
+	end
+
+	local insert_help = true
+	local drop_lines = {}
+	for comment, index in pairs(comments) do
+		if help_map[comment] then
+			insert_help = false
+			table.insert(drop_lines, index)
+		end
+	end
+
+	if M._state.show_chat_help and insert_help then
+		vim.api.nvim_buf_set_lines(buf, header_end, header_end, false, help_lines)
+	elseif not M._state.show_chat_help and not insert_help then
+		table.sort(drop_lines, function(a, b)
+			return a > b
+		end)
+		for _, index in ipairs(drop_lines) do
+			vim.api.nvim_buf_set_lines(buf, index, index + 1, false, {})
+		end
+	end
+end
+
+M.cmd.ChatHelp = function()
+	M.refresh_state({ show_chat_help = not M._state.show_chat_help })
+end
+
 M.cmd.ChatRespond = function(params)
 	if params.args == "" and vim.v.count == 0 then
 		M.chat_respond(params)