diff --git a/README.md b/README.md index b5e0272..0796331 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,14 @@ Generate tests only for exported functions/methods in current file :GoGenerate % ``` +8. Generate doc comment + +First set a cursor on **public** package/function/interface/struct and execure: + +```vim +:GoCmt +``` + ## Thanks - [go.nvim](https://github.com/ray-x/go.nvim) diff --git a/lua/gopher/_utils/ts/init.lua b/lua/gopher/_utils/ts/init.lua index 3c253cc..6bcf8fc 100644 --- a/lua/gopher/_utils/ts/init.lua +++ b/lua/gopher/_utils/ts/init.lua @@ -4,6 +4,8 @@ local M = { querys = { struct_block = [[((type_declaration (type_spec name:(type_identifier) @struct.name type: (struct_type)))@struct.declaration)]], em_struct_block = [[(field_declaration name:(field_identifier)@struct.name type: (struct_type)) @struct.declaration]], + package = [[(package_clause (package_identifier)@package.name)@package.clause]], + interface = [[((type_declaration (type_spec name:(type_identifier) @interface.name type:(interface_type)))@interface.declaration)]], method_name = [[((method_declaration receiver: (parameter_list)@method.receiver name: (field_identifier)@method.name body:(block))@method.declaration)]], func = [[((function_declaration name: (identifier)@function.name) @function.declaration)]], }, @@ -21,7 +23,7 @@ end ---@param row string ---@param col string ----@param bufnr string +---@param bufnr string|nil ---@return table|nil function M.get_struct_node_at_pos(row, col, bufnr) local query = M.querys.struct_block .. " " .. M.querys.em_struct_block @@ -36,7 +38,7 @@ end ---@param row string ---@param col string ----@param bufnr string +---@param bufnr string|nil ---@return table|nil function M.get_func_method_node_at_pos(row, col, bufnr) local query = M.querys.func .. " " .. M.querys.method_name @@ -49,4 +51,37 @@ function M.get_func_method_node_at_pos(row, col, bufnr) end end +---@param row string +---@param col string +---@param bufnr string|nil +---@return table|nil +function M.get_package_node_at_pos(row, col, bufnr) + -- stylua: ignore + if row > 10 then return end + local query = M.querys.package + local bufn = bufnr or vim.api.nvim_get_current_buf() + local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col) + if ns == nil then + u.notify("package not found", "warn") + return nil + else + return ns[#ns] + end +end + +---@param row string +---@param col string +---@param bufnr string|nil +---@return table|nil +function M.get_interface_node_at_pos(row, col, bufnr) + local query = M.querys.interface + local bufn = bufnr or vim.api.nvim_get_current_buf() + local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col) + if ns == nil then + u.notify("interface not found", "warn") + else + return ns[#ns] + end +end + return M diff --git a/lua/gopher/comment.lua b/lua/gopher/comment.lua new file mode 100644 index 0000000..3991651 --- /dev/null +++ b/lua/gopher/comment.lua @@ -0,0 +1,50 @@ +local ts_utils = require "gopher._utils.ts" + +local function generate(row, col) + local comment, ns = nil, nil + + ns = ts_utils.get_package_node_at_pos(row, col) + if ns ~= nil and ns ~= {} then + comment = "// Package " .. ns.name .. " provides " .. ns.name + return comment, ns + end + + ns = ts_utils.get_struct_node_at_pos(row, col) + if ns ~= nil and ns ~= {} then + comment = "// " .. ns.name .. " " .. ns.type .. " " + return comment, ns + end + + ns = ts_utils.get_func_method_node_at_pos(row, col) + if ns ~= nil and ns ~= {} then + comment = "// " .. ns.name .. " " .. ns.type .. " " + return comment, ns + end + + ns = ts_utils.get_interface_node_at_pos(row, col) + if ns ~= nil and ns ~= {} then + comment = "// " .. ns.name .. " " .. ns.type .. " " + return comment, ns + end + + return "// ", {} +end + +return function() + local row, col = unpack(vim.api.nvim_win_get_cursor(0)) + local comment, ns = generate(row + 1, col + 1) + + vim.api.nvim_win_set_cursor(0, { + ns.dim.s.r, + ns.dim.s.c, + }) + + vim.fn.append(row - 1, comment) + + vim.api.nvim_win_set_cursor(0, { + ns.dim.s.r, + #comment + 1, + }) + + vim.cmd [[startinsert!]] +end diff --git a/lua/gopher/init.lua b/lua/gopher/init.lua index d62a04a..54ae79e 100644 --- a/lua/gopher/init.lua +++ b/lua/gopher/init.lua @@ -9,6 +9,7 @@ gopher.mod = require "gopher.gomod" gopher.get = require "gopher.goget" gopher.impl = require "gopher.impl" gopher.generate = require "gopher.gogenerate" +gopher.comment = require "gopher.comment" gopher.test_add = gotests.func_test gopher.test_exported = gotests.all_exported_tests gopher.tests_all = gotests.all_tests diff --git a/plugin/gopher.vim b/plugin/gopher.vim index 234d99e..942cc04 100644 --- a/plugin/gopher.vim +++ b/plugin/gopher.vim @@ -7,4 +7,5 @@ command! -nargs=* GoMod :lua require"gopher".mod() command! -nargs=* GoGet :lua require"gopher".get() command! -nargs=* GoImpl :lua require"gopher".impl() command! -nargs=* GoGenerate :lua require"gopher".generate() +command! GoCmt :lua require"gopher".comment() command! GoInstallDeps :lua require"gopher".install_deps()