chore: lint + annotations

Signed-off-by: blob42 <[email protected]>

Author: blob42

lua/codegpt.lua

@@ -16,6 +16,7 @@ function M.get_status(...)
 	return Commands.get_status(...)
 end
 
+---@param opts vim.api.keyset.create_user_command.command_args
 function M.run_cmd(opts)
 	if opts.name and opts.name:match("^V") then
 		Config.popup_override = "vertical"
@@ -30,7 +31,7 @@ function M.run_cmd(opts)
 		Config.persistent_override = false
 	end
 
-	local text_selection, bounds = Utils.get_selected_lines(opts)
+	local text_selection, range = Utils.get_selected_lines(opts)
 	local command_args = table.concat(opts.fargs, " ")
 
 	local command = opts.fargs[1]
@@ -61,7 +62,7 @@ function M.run_cmd(opts)
 		return
 	end
 
-	Commands.run_cmd(command, command_args, text_selection, bounds)
+	Commands.run_cmd(command, command_args, text_selection, range)
 end
 
 M.setup = Config.setup

lua/codegpt/api.lua

@@ -19,6 +19,7 @@ local function start_spinner_timer()
 	)
 end
 
+---@return string
 function M.get_status(...)
 	local spinners = Config.opts.ui.spinners or { "", "", "", "", "", "" }
 	local spinner_speed = Config.opts.ui.spinner_speed or 80

lua/codegpt/commands.lua

@@ -1,3 +1,5 @@
+---@module 'plenary.curl'
+
 local Utils = require("codegpt.utils")
 local Ui = require("codegpt.ui")
 local Providers = require("codegpt.providers")
@@ -7,45 +9,55 @@ local models = require("codegpt.models")
 
 local M = {}
 
-local text_popup_stream = function(job, stream, bufnr, start_row, start_col, end_row, end_col)
+---@param job Job
+---@param stream string
+---@param bufnr integer
+---@param range Range4
+local text_popup_stream = function(job, stream, bufnr, range)
 	local popup_filetype = Config.opts.ui.text_popup_filetype
-	Ui.popup_stream(job, stream, popup_filetype, bufnr, start_row, start_col, end_row, end_col)
+	Ui.popup_stream(job, stream, popup_filetype, bufnr, range)
 end
 
-local function replacement(lines, bufnr, start_row, start_col, end_row, end_col)
+---@param job Job
+---@param lines string[]
+---@param bufnr integer
+---@param range Range4
+local function replacement(job, lines, bufnr, range)
+	local start_row, _, end_row, _ = unpack(range)
 	lines = Utils.strip_reasoning(lines, "<think>", "</think>")
 	lines = Utils.trim_to_code_block(lines)
 	lines = Utils.remove_trailing_whitespace(lines)
 	Utils.fix_indentation(bufnr, start_row, end_row, lines)
 	-- if the buffer is not valid, open a popup. This can happen when the user closes the previous popup window before the request is finished.
 	if vim.api.nvim_buf_is_valid(bufnr) ~= true then
-		Ui.popup(job, lines, Utils.get_filetype(), bufnr, start_row, start_col, end_row, end_col)
+		Ui.popup(job, lines, Utils.get_filetype(), bufnr, range)
 	else
 		return lines
 	end
 end
 
 M.CallbackTypes = {
 	["text_popup_stream"] = text_popup_stream,
-	["text_popup"] = function(job, lines, bufnr, start_row, start_col, end_row, end_col)
+	["text_popup"] = function(job, lines, bufnr, range)
 		local popup_filetype = Config.opts.ui.text_popup_filetype
-		Ui.popup(job, lines, popup_filetype, bufnr, start_row, start_col, end_row, end_col)
+		Ui.popup(job, lines, popup_filetype, bufnr, range)
 	end,
-	["code_popup"] = function(job, lines, bufnr, start_row, start_col, end_row, end_col)
+	["code_popup"] = function(job, lines, bufnr, range)
+		local start_row, _, end_row, _ = unpack(range)
 		lines = Utils.trim_to_code_block(lines)
 		Utils.fix_indentation(bufnr, start_row, end_row, lines)
-		Ui.popup(job, lines, Utils.get_filetype(), bufnr, start_row, start_col, end_row, end_col)
+		Ui.popup(job, lines, Utils.get_filetype(), bufnr, range)
 	end,
-	["replace_lines"] = function(job, lines, bufnr, start_row, start_col, end_row, end_col)
-		lines = replacement(lines, bufnr, start_row, start_col, end_row, end_col)
-		Utils.replace_lines(lines, bufnr, start_row, start_col, end_row, end_col)
+	["replace_lines"] = function(job, lines, bufnr, range)
+		lines = replacement(job, lines, bufnr, range)
+		Utils.replace_lines(lines, bufnr, range)
 	end,
-	["insert_lines"] = function(job, lines, bufnr, start_row, start_col, end_row, end_col)
-		lines = replacement(lines, bufnr, start_row, start_col, end_row, end_col)
+	["insert_lines"] = function(job, lines, bufnr, range)
+		lines = replacement(job, lines, bufnr, range)
 		Utils.insert_lines(lines)
 	end,
-	["prepend_lines"] = function(job, lines, bufnr, start_row, start_col, end_row, end_col)
-		lines = replacement(lines, bufnr, start_row, start_col, end_row, end_col)
+	["prepend_lines"] = function(job, lines, bufnr, range)
+		lines = replacement(job, lines, bufnr, range)
 		Utils.prepend_lines(lines)
 	end,
 	["custom"] = nil,
@@ -94,8 +106,8 @@ end
 ---@param command string
 ---@param command_args string
 ---@param text_selection string
----@param bounds bounding_box
-function M.run_cmd(command, command_args, text_selection, bounds)
+---@param range Range4
+function M.run_cmd(command, command_args, text_selection, range)
 	local provider = Providers.get_provider()
 	local cmd_opts, is_stream = get_cmd_opts(command)
 	if cmd_opts == nil then
@@ -110,11 +122,11 @@ function M.run_cmd(command, command_args, text_selection, bounds)
 
 	if is_stream then
 		new_callback = function(stream, job)
-			cmd_opts.callback(job, stream, bufnr, unpack(bounds))
+			cmd_opts.callback(job, stream, bufnr, range)
 		end
 	else
 		new_callback = function(lines, job) -- called from Provider.handle_response
-			cmd_opts.callback(job, lines, bufnr, unpack(bounds))
+			cmd_opts.callback(job, lines, bufnr, range)
 		end
 	end
 
@@ -126,6 +138,7 @@ function M.run_cmd(command, command_args, text_selection, bounds)
 	end
 end
 
+---@return string
 function M.get_status(...)
 	return Api.get_status(...)
 end

lua/codegpt/config.lua

@@ -10,6 +10,7 @@ local M = {}
 ---@field max_tokens? number Custom max_tokens for this command
 ---@field append_string? string String to append to prompt -- ex: /no_think
 ---@field model? string Model to always use with this command
+---@field [string] any -- merged command parameters
 
 ---@type { [string]: codegpt.CommandOpts }
 local default_commands = {
@@ -133,7 +134,7 @@ M.persistent_override = nil
 ---@field popup_options? table nui.nvim popup options
 ---@field persistent? boolean Do not close popup window on mouse leave. Useful with vertical and horizontal layouts.
 ---@field actions? table | {custom?: table} -- ui key mappings
----@field text_popup_filetype? string Set the filetype of the text popup
+---@field text_popup_filetype string Set the filetype of the text popup
 ---@field popup_type? "popup" | "vertical" | "horizontal" Set the type of ui to use for the popup
 ---@field horizontal_popup_size? string Set the height of the horizontal popup
 ---@field vertical_popup_size? string Set the width of the vertical popup

lua/codegpt/models.lua

@@ -3,8 +3,6 @@ local Providers = require("codegpt.providers")
 local M = {}
 
 function M.get_model_by_name(name)
-	---@type codegpt.Model
-
 	local provider_name = vim.fn.tolower(Config.opts.connection.api_provider)
 	local provider_config = Config.opts.models[provider_name]
 

lua/codegpt/providers/ollama.lua

@@ -8,7 +8,9 @@ local errors = require("codegpt.errors")
 
 local M = {}
 
+---@param command string
 ---@param cmd_opts codegpt.CommandOpts
+---@param command_args string[]
 local function generate_messages(command, cmd_opts, command_args, text_selection)
 	local system_message =
 		Render.render(command, cmd_opts.system_message_template, command_args, text_selection, cmd_opts)

lua/codegpt/template_render.lua

@@ -2,45 +2,50 @@ local Utils = require("codegpt.utils")
 
 local Render = {}
 
+---TODO!: add lang->vim_filety pemappings for other common languages
 local function get_language()
-    local filetype = Utils.get_filetype()
-    if filetype == "cpp" then
-        return "C++"
-    else
-        return filetype
-    end
+	local filetype = Utils.get_filetype()
+	if filetype == "cpp" then
+		return "C++"
+	else
+		return filetype
+	end
 end
 
 local function safe_replace(template, key, value)
-    if value == nil then
-        return template:gsub(key, "")
-    end
+	if value == nil then
+		return template:gsub(key, "")
+	end
 
-    if type(value) == "table" then
-        value = table.concat(value, "\n")
-    end
+	if type(value) == "table" then
+		value = table.concat(value, "\n")
+	end
 
-    if value then
-        -- Replace '%' with '%%' to escape it in the template
-        value = value:gsub("%%", "%%%%")
-    end
+	if value then
+		-- Replace '%' with '%%' to escape it in the template
+		value = value:gsub("%%", "%%%%")
+	end
 
-    return template:gsub(key, value)
+	return template:gsub(key, value)
 end
 
+---@param cmd string
+---@param template string
+---@param command_args string[]
+---@param cmd_opts table
 function Render.render(cmd, template, command_args, text_selection, cmd_opts)
-    local language = get_language()
-    local language_instructions = ""
-    if cmd_opts.language_instructions ~= nil then
-        language_instructions = cmd_opts.language_instructions[language]
-    end
-
-    template = safe_replace(template, "{{filetype}}", Utils.get_filetype())
-    template = safe_replace(template, "{{text_selection}}", text_selection)
-    template = safe_replace(template, "{{language}}", language)
-    template = safe_replace(template, "{{command_args}}", command_args)
-    template = safe_replace(template, "{{language_instructions}}", language_instructions)
-    return template
+	local language = get_language()
+	local language_instructions = ""
+	if cmd_opts.language_instructions ~= nil then
+		language_instructions = cmd_opts.language_instructions[language]
+	end
+
+	template = safe_replace(template, "{{filetype}}", Utils.get_filetype())
+	template = safe_replace(template, "{{text_selection}}", text_selection)
+	template = safe_replace(template, "{{language}}", language)
+	template = safe_replace(template, "{{command_args}}", command_args)
+	template = safe_replace(template, "{{language_instructions}}", language_instructions)
+	return template
 end
 
 return Render

lua/codegpt/ui.lua

@@ -1,3 +1,5 @@
+---@module 'plenary.job'
+
 local Popup = require("nui.popup")
 local Split = require("nui.split")
 local Config = require("codegpt.config")
@@ -77,7 +79,12 @@ local function create_window()
 	return ui_elem
 end
 
-function M.popup(job, lines, filetype, bufnr, start_row, start_col, end_row, end_col)
+---@param job Job
+---@param lines string[]
+---@param filetype string
+---@param range Range4
+function M.popup(job, lines, filetype, bufnr, range)
+	local start_row, start_col, end_row, end_col = unpack(range)
 	if job ~= nil and job.is_shutdown then
 		return
 	end