feat: extract text editor tools (#1726)

lua/avante/llm_tools/insert.lua

@@ -0,0 +1,89 @@
+local Path = require("plenary.path")
+local Base = require("avante.llm_tools.base")
+local Helpers = require("avante.llm_tools.helpers")
+local Highlights = require("avante.highlights")
+
+---@class AvanteLLMTool
+local M = setmetatable({}, Base)
+
+M.name = "insert"
+
+M.description = "The insert tool allows you to insert text at a specific location in a file."
+
+---@type AvanteLLMToolParam
+M.param = {
+  type = "table",
+  fields = {
+    {
+      name = "path",
+      description = "The path to the file to modify",
+      type = "string",
+    },
+    {
+      name = "insert_line",
+      description = "The line number after which to insert the text (0 for beginning of file)",
+      type = "integer",
+    },
+    {
+      name = "new_str",
+      description = "The text to insert",
+      type = "string",
+    },
+  },
+}
+
+---@type AvanteLLMToolReturn[]
+M.returns = {
+  {
+    name = "success",
+    description = "True if the text was inserted successfully, false otherwise",
+    type = "boolean",
+  },
+  {
+    name = "error",
+    description = "Error message if the text was not inserted successfully",
+    type = "string",
+    optional = true,
+  },
+}
+
+---@type AvanteLLMToolFunc<{ path: string, insert_line: integer, new_str: string }>
+function M.func(opts, on_log, on_complete)
+  if on_log then on_log("path: " .. opts.path) end
+  local abs_path = Helpers.get_abs_path(opts.path)
+  if not Helpers.has_permission_to_access(abs_path) then return false, "No permission to access path: " .. abs_path end
+  if not Path:new(abs_path):exists() then return false, "File not found: " .. abs_path end
+  if not Path:new(abs_path):is_file() then return false, "Path is not a file: " .. abs_path end
+  if opts.insert_line == nil then return false, "insert_line not provided" end
+  if opts.new_str == nil then return false, "new_str not provided" end
+  local ns_id = vim.api.nvim_create_namespace("avante_insert_diff")
+  local bufnr, err = Helpers.get_bufnr(abs_path)
+  if err then return false, err end
+  local function clear_highlights() vim.api.nvim_buf_clear_namespace(bufnr, ns_id, 0, -1) end
+  local new_lines = vim.split(opts.new_str, "\n")
+  local max_col = vim.o.columns
+  local virt_lines = vim
+    .iter(new_lines)
+    :map(function(line)
+      --- append spaces to the end of the line
+      local line_ = line .. string.rep(" ", max_col - #line)
+      return { { line_, Highlights.INCOMING } }
+    end)
+    :totable()
+  vim.api.nvim_buf_set_extmark(bufnr, ns_id, opts.insert_line, 0, {
+    virt_lines = virt_lines,
+    hl_eol = true,
+    hl_mode = "combine",
+  })
+  Helpers.confirm("Are you sure you want to insert these lines?", function(ok)
+    clear_highlights()
+    if not ok then
+      on_complete(false, "User canceled")
+      return
+    end
+    vim.api.nvim_buf_set_lines(bufnr, opts.insert_line, opts.insert_line, false, new_lines)
+    on_complete(true, nil)
+  end)
+end
+
+return M