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
64 lines
1.8 KiB
Lua
64 lines
1.8 KiB
Lua
--- *gopher.nvim*
|
|
---
|
|
--- ==============================================================================
|
|
---
|
|
--- gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua.
|
|
--- It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
|
|
|
|
--- Table of Contents
|
|
---@tag gopher.nvim-table-of-contents
|
|
---@toc
|
|
|
|
local tags = require "gopher.struct_tags"
|
|
local tests = require "gopher.gotests"
|
|
local gocmd = require("gopher._utils.runner.gocmd").run
|
|
local gopher = {}
|
|
|
|
---@toc_entry Setup
|
|
---@tag gopher.nvim-setup
|
|
---@text Setup function. This method simply merges default configs with opts table.
|
|
--- You can read more about configuration at |gopher.nvim-config|
|
|
--- Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults|
|
|
---
|
|
---@usage `require("gopher").setup {}` (replace `{}` with your `config` table)
|
|
gopher.setup = require("gopher.config").setup
|
|
|
|
---@toc_entry Install dependencies
|
|
---@tag gopher.nvim-install-deps
|
|
---@text Gopher.nvim implements most of its features using third-party tools.
|
|
--- To install these tools, you can run `:GoInstallDeps` command
|
|
--- or call `require("gopher").install_deps()` if you want ues lua api.
|
|
gopher.install_deps = require("gopher.installer").install_deps
|
|
|
|
gopher.impl = require("gopher.impl").impl
|
|
gopher.iferr = require("gopher.iferr").iferr
|
|
gopher.comment = require "gopher.comment"
|
|
|
|
gopher.tags = {
|
|
add = tags.add,
|
|
rm = tags.remove,
|
|
}
|
|
|
|
gopher.test = {
|
|
add = tests.func_test,
|
|
exported = tests.all_exported_tests,
|
|
all = tests.all_tests,
|
|
}
|
|
|
|
gopher.get = function(...)
|
|
gocmd("get", { ... })
|
|
end
|
|
|
|
gopher.mod = function(...)
|
|
gocmd("mod", { ... })
|
|
end
|
|
|
|
gopher.generate = function(...)
|
|
gocmd("generate", { ... })
|
|
end
|
|
|
|
gopher.work = function(...)
|
|
gocmd("work", { ... })
|
|
end
|
|
|
|
return gopher
|