10cec9c6b0
* idk how good this idea is * this could be working but i still cant figure out how to run it * ignore tags that mini.doc gens, but why? * chore(taskfile): force exiting after tests because i got infinit ci * chore(ci): add more nvim versions to run on * chore: update taskfile * feat: add docs generator * docs: its only begining * refactor: update docgen script * docs: write some more * docs(config): update * docs: update readme * language * hope it would work * what about that? * maybe this would work? * update md * upd * WHY DOESNT IT WORKING * idk by but 0.9.3 just fails the ci, so i deleted it from suite * again update, why does markdown not work in embeded html * maybe it can help? * upd * again update * kinda fix * fix: formatting * again some updating * some readme updating * fix, this shouldnt be in repo * i finnaly undertood how to fix this fking skill issue * fix(struct_tags): typo * refactor(docs): change the order in generated file * docs: install deps * refactor(scripts): rename doc-gen script * docs(impl): write docs * docs(dap): add doc * stylua . * docs(struct_tags): add doc * docs(gotests): add docs * docs(iferr): add docs * docs(comment): add doc * update CONTRIBUTING.md * docs(README): talk about `develop` branch * docs: update README.md
76 lines
2.1 KiB
Lua
76 lines
2.1 KiB
Lua
---@toc_entry Configuration
|
|
---@tag gopher.nvim-config
|
|
---@text config it is the place where you can configure the plugin.
|
|
--- also this is optional is you're ok with default settings.
|
|
--- You can look at default options |gopher.nvim-config-defaults|
|
|
|
|
---@type gopher.Config
|
|
---@private
|
|
local config = {}
|
|
|
|
---@tag gopher.nvim-config.ConfigGoTagTransform
|
|
---@text Possible values for |gopher.Config|.gotag.transform:
|
|
---
|
|
---@private
|
|
---@alias gopher.ConfigGoTagTransform
|
|
---| "snakecase" "GopherUser" -> "gopher_user"
|
|
---| "camelcase" "GopherUser" -> "gopherUser"
|
|
---| "lispcase" "GopherUser" -> "gopher-user"
|
|
---| "pascalcase" "GopherUser" -> "GopherUser"
|
|
---| "titlecase" "GopherUser" -> "Gopher User"
|
|
---| "keep" keeps the original field name
|
|
|
|
--minidoc_replace_start {
|
|
|
|
---@tag gopher.nvim-config-defaults
|
|
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section):gsub(">", ">lua")
|
|
---
|
|
---@class gopher.Config
|
|
local default_config = {
|
|
--minidoc_replace_end
|
|
|
|
-- user specified paths to binaries
|
|
---@class gopher.ConfigCommand
|
|
commands = {
|
|
go = "go",
|
|
gomodifytags = "gomodifytags",
|
|
gotests = "gotests",
|
|
impl = "impl",
|
|
iferr = "iferr",
|
|
dlv = "dlv",
|
|
},
|
|
---@class gopher.ConfigGotests
|
|
gotests = {
|
|
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
|
|
template = "default",
|
|
-- path to a directory containing custom test code templates
|
|
---@type string|nil
|
|
template_dir = nil,
|
|
-- switch table tests from using slice to map (with test name for the key)
|
|
-- works only with gotests installed from develop branch
|
|
named = false,
|
|
},
|
|
---@class gopher.ConfigGoTag
|
|
gotag = {
|
|
---@type gopher.ConfigGoTagTransform
|
|
transform = "snakecase",
|
|
},
|
|
}
|
|
--minidoc_afterlines_end
|
|
|
|
---@type gopher.Config
|
|
---@private
|
|
local _config = default_config
|
|
|
|
---@param user_config? gopher.Config
|
|
function config.setup(user_config)
|
|
_config = vim.tbl_deep_extend("force", default_config, user_config or {})
|
|
end
|
|
|
|
setmetatable(config, {
|
|
__index = function(_, key)
|
|
return _config[key]
|
|
end,
|
|
})
|
|
|
|
return config
|