olexsmir/gopher.nvim
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat(comment): add support for: interface methods, struct fields, variables (#123)

Browse source 
* refactor(comment): dont use unnecessary function

* chore: quick way to open vim in dev mode

* feat(comment): add comment on on interface method

* feat(comment): add comment on a struct field

* feat(comment): add comment on a variable

* docs: add note about the generate function

* docs: gopher.TsResult

* fix(utils): handle case when indentation is wrong
This commit is contained in:
Oleksandr Smirnov 2025-09-04 16:52:18 +03:00 • committed by GitHub
parent 295e21e637
commit 1e7af1b212
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
20 changed files with 250 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

44
lua/gopher/comment.lua
View file

@ -7,32 +7,40 @@
local ts = require "gopher._utils.ts"
local log = require "gopher._utils.log"
local u = require "gopher._utils"
local comment = {}
---@param name string
---@return string
---@dochide
local function template(name)
return "// " .. name .. " "
end
--- NOTE: The order of functions executed inside this function is IMPORTANT.
--- This function is extremely fragile; run tests after making any changes.
---
---@param bufnr integer
---@param line string
---@return string
---@dochide
local function generate(bufnr)
local function generate(bufnr, line)
local sf_ok, sf_res = pcall(ts.get_struct_field_under_cursor, bufnr)
if sf_ok then
return u.indent(line, sf_res.indent) .. "// " .. sf_res.name .. " "
end
local s_ok, s_res = pcall(ts.get_struct_under_cursor, bufnr)
if s_ok then
return template(s_res.name)
return u.indent(line, s_res.indent) .. "// " .. s_res.name .. " "
end
local v_ok, v_res = pcall(ts.get_variable_under_cursor, bufnr)
if v_ok then
return u.indent(line, v_res.indent) .. "// " .. v_res.name .. " "
end
local f_ok, f_res = pcall(ts.get_func_under_cursor, bufnr)
if f_ok then
return template(f_res.name)
return u.indent(line, f_res.indent) .. "// " .. f_res.name .. " "
end
local i_ok, i_res = pcall(ts.get_interface_under_cursor, bufnr)
if i_ok then
return template(i_res.name)
return u.indent(line, i_res.indent) .. "// " .. i_res.name .. " "
end
local p_ok, p_res = pcall(ts.get_package_under_cursor, bufnr)
@ -45,12 +53,16 @@ end
function comment.comment()
local bufnr = vim.api.nvim_get_current_buf()
local cmt = generate(bufnr)
log.debug("generated comment: " .. cmt)
local lnum = vim.fn.getcurpos()[2]
local line = vim.fn.getline(lnum)
local cmt = generate(bufnr, line)
log.debug("generated comment:", {
comment = cmt,
line = line,
})
local pos = vim.fn.getcurpos()[2]
vim.fn.append(pos - 1, cmt)
vim.fn.setpos(".", { 0, pos, #cmt })
vim.fn.append(lnum - 1, cmt)
vim.fn.setpos(".", { bufnr, lnum, #cmt })
vim.cmd "startinsert!"
end