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

sync develop and main (#68)

Browse source 
* healthcheck: refactoring, remove deprecation wanings (#35)

* refactor(checkhealth): remove deprecation warnings, complete rewrite

* refactor(checkhealth): rename util file

* style(healthchecker): reformat lua in vim file

* refactor(health): move all report function into table

* add editorconfig (#36)

* refactor of public plugin's api (#37)

* refactor: move all plugin functionality to init.lua

* fix(commands): now it uses correct module paths

* refactor(config): change way how it handles options

* refactor(gotests): use correct config, change way how deps required, fix some typos

* fix(healthchecker): use correct config

* refactor(iferr): change api

* refactor(impl): change api

* refactor(installer): change api

* refactor(struct_tags): change way of importting deps

* refactor(struct_tags): rename M to struct_tags

* run stylua

* refactor(dap): make it all in one file, and make some refactoring

* refactor(_utils): change way how it organizes

* fix: use new _utils api

* refactor(_utils.health): reorganize module

* refactor(_utils.ts): some renameing, moving requires lines

* run stylua

* update tooling (#38)

* chore: delete pre-commit

* chore: switch from makefile to taskfile

* chore(ci): update and add one more linter

* chore(editorconfig): add config for Go

* chore(editorconfig): remove max_line_length

* fix: editorconfig-check on README.md

* feat: run tests independent from user's nvim config

* remove editorconfig-checker

* fix(config): now it not removes .setup() from itself after calling
.setup()

* fix(config): now it works correctly

* chore: update taskfile, and linter config

* feat(config): make it optional to call .setup()

* run tests independent of user nvim setup (#39)

* chore(lua_ls): now lua_ls knows about testing functions

* spec: change way how tests srtuctured

* test(config): refactor tests

* test: utils

* refactor(utils): remove not used function

* chore(ci): add test runner

* chore(ci): remove taskfile from deps

* fix: now it works

* fix(dap): now dlv uses cmd to run from config

* chore(ci): run tests on many versions of nvim

* refactor: commands runner (#42)

* feat(utils): first impl of own commands runner

* refactor(gotests): uses own runner instead of vendored

* refactor(utils): back to plenary.job

* refactor(gotests): use new runner, clean code

* fix(runner): now it returns output correctly

* refactor(iferr): use vim.system

i have tried to use _utils.runner, but i can't figure out how to make `< file.go` for the command

* refactor(impl): use new runner

* refactor(installer): use new runner

* refactor(struct_tags): use new runner

* refactor: commands such as :GoGet runs with new runner

* refactor: throw errors in more lua way, i think

* refactor(utils): notify now has title

* refactor: use more correct way of notifying

* refactor(runner): write error message on error

* add ability for setting custom tools options (#44)

* feat(gotests): add custom templates support

* feat(struct_tags): add support for custom `transform` option

* fix(health): check if bin is installed, and added message about treesitter parser

* fix: fix iferr config (#56)

* Add support for named tests (#50)

* fix(typo): README.md (#47)

* feat: add support for named tests

* test

* tags in table

* debug installer msg

* test

* hardcoded @develop

* get gotests tag from setup()

* update readme

* store install tag in urls table

* removed gotests tag

* update README.md

* remove urls installer index reference

* remove named arg from add_test()

* .

* update README.md

* update README.md

---------

Co-authored-by: Steve M <gearcog@users.noreply.github.com>

* reformat .editorconfig config

* refactor(api)!: mave tags and gotests api into their sub tables

* add help file, and docs (#59)

* 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

* refactor(health): keep in mind new way of health check (#63)

* feat: add logger (#64)

* refactor(health): keep in mind new way of health check (#63)

* feat(log): add logger module

* refactor(utils): remove unused code

* refactor(log, utils): get plugin name from config

* refactor(logger): add some type annotations

* refactor(utils): log notifications

* feat: LOGGER™

* feat(config): TYPES

* refactor(log): dont give a thing about var that is not even declared

* feat(log): add easy way to open log

* refactor(log): some types

* update types

* docs: regen

* fix(log): make setting log level by config work

* feat(iferr): write error to log file if occur

* feat(gotests): add logger

* add deprecation message (#67)

---------

Co-authored-by: Arne Van Maele <93863978+arnevm123@users.noreply.github.com>
Co-authored-by: Alex <49870662+ysomad@users.noreply.github.com>
Co-authored-by: Steve M <gearcog@users.noreply.github.com>
This commit is contained in:
Smirnov Oleksandr 2024-06-15 12:43:06 +03:00 • committed by GitHub
parent ac27f4b679
commit a995af3415
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
47 changed files with 1594 additions and 737 deletions
Download patch file Download diff file Expand all files Collapse all files

250
README.md
View file

@ -4,157 +4,230 @@
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.
It's **NOT** an LSP tool, the main goal of this plugin is to add go tooling support in Neovim.
## Install
> If you want to use new and maybe undocumented, and unstable features you might use [develop](https://github.com/olexsmir/gopher.nvim/tree/develop) branch.
Pre-dependency: [go](https://github.com/golang/go) (tested on 1.17 and 1.18)
## Install (using [lazy.nvim](https://github.com/folke/lazy.nvim))
Pre-dependency:
- [Go](https://github.com/golang/go)
- `go` treesitter parser, install by `:TSInstall go`
```lua
use {
{
"olexsmir/gopher.nvim",
requires = { -- dependencies
ft = "go",
-- branch = "develop", -- if you want develop branch
-- keep in mind, it might break everything
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-treesitter/nvim-treesitter",
"mfussenegger/nvim-dap", -- (optional) only if you use `gopher.dap`
},
-- (optional) will update plugin's deps on every update
build = function()
vim.cmd.GoInstallDeps()
end,
---@type gopher.Config
opts = {},
}
```
Also, run `TSInstall go` if `go` parser if isn't installed yet.
## Configuratoin
## Config
> [!IMPORTANT]
>
> If you need more info look `:h gopher.nvim`
By `.setup` function you can configure the plugin.
Note:
- `installer` does not install the tool in user set path
**Take a look at default options**
```lua
require("gopher").setup {
commands = {
go = "go",
gomodifytags = "gomodifytags",
gotests = "~/go/bin/gotests", -- also you can set custom command path
gotests = "gotests",
impl = "impl",
iferr = "iferr",
dlv = "dlv",
},
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
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,
},
gotag = {
transform = "snakecase",
},
}
```
## Features
1. Installation requires this go tool:
<!-- markdownlint-disable -->
```vim
:GoInstallDeps
```
<details>
<summary>
<b>Install plugin's go deps</b>
</summary>
It will install next tools:
```vim
:GoInstallDeps
```
- [gomodifytags](https://github.com/fatih/gomodifytags)
- [impl](https://github.com/josharian/impl)
- [gotests](https://github.com/cweill/gotests)
- [iferr](https://github.com/koron/iferr)
This will install the following tools:
2. Modify struct tags:
By default `json` tag will be added/removed, if not set:
- [gomodifytags](https://github.com/fatih/gomodifytags)
- [impl](https://github.com/josharian/impl)
- [gotests](https://github.com/cweill/gotests)
- [iferr](https://github.com/koron/iferr)
- [dlv](github.com/go-delve/delve/cmd/dlv)
</details>
```vim
:GoTagAdd json " For add json tag
:GoTagRm yaml " For remove yaml tag
```
<details>
<summary>
<b>Add and remove tags for structs via <a href="https://github.com/fatih/gomodifytags">gomodifytags</a></b>
</summary>
3. Run `go mod` command:
By default `json` tag will be added/removed, if not set:
```vim
:GoMod tidy " Runs `go mod tidy`
:GoMod init asdf " Runs `go mod init asdf`
```
```vim
" add json tag
:GoTagAdd json
4. Run `go get` command
" remove yaml tag
:GoTagRm yaml
```
Link can have a `http` or `https` prefix.
```lua
-- or you can use lua api
require("gopher").tags.add "xml"
require("gopher").tags.rm "proto"
```
</details>
You can provide more than one package url:
<details>
<summary>
<b>Generating tests via <a href="https://github.com/cweill/gotests">gotests</a></b>
</summary>
```vim
:GoGet github.com/gorilla/mux
```
```vim
" Generate one test for a specific function/method(one under cursor)
:GoTestAdd
5. Interface implementation
" Generate all tests for all functions/methods in the current file
:GoTestsAll
Command syntax:
" Generate tests for only exported functions/methods in the current file
:GoTestsExp
```
```vim
:GoImpl [receiver] [interface]
```lua
-- or you can use lua api
require("gopher").test.add()
require("gopher").test.exported()
require("gopher").test.all()
```
" Also you can put cursor on the struct and run:
:GoImpl [interface]
```
For named tests see `:h gopher.nvim-gotests-named`
</details>
Example of usage:
<details>
<summary>
<b>Run commands like <code>go mod/get/etc</code> inside of nvim</b>
</summary>
```vim
" Example
:GoImpl r Read io.Reader
" or simply put your cursor in the struct and run:
:GoImpl io.Reader
```
```vim
:GoGet github.com/gorilla/mux
6. Generate tests with [gotests](https://github.com/cweill/gotests)
" Link can have an `http` or `https` prefix.
:GoGet https://github.com/lib/pq
Generate one test for a specific function/method:
" You can provide more than one package url
:GoGet github.com/jackc/pgx/v5 github.com/google/uuid/
```vim
:GoTestAdd
```
" go mod commands
:GoMod tidy
:GoMod init new-shiny-project
Generate all tests for all functions/methods in current file:
" go work commands
:GoWork sync
```vim
:GoTestsAll
```
" run go generate in cwd
:GoGenerate
Generate tests only for exported functions/methods in current file:
" run go generate for the current file
:GoGenerate %
```
</details>
```vim
:GoTestsExp
```
<details>
<summary>
<b>Interface implementation via <a href="https://github.com/josharian/impl">impl<a></b>
</summary>
7. Run `go generate` command;
Syntax of the command:
```vim
:GoImpl [receiver] [interface]
```vim
" Run `go generate` in cwd path
:GoGenerate
" also you can put a cursor on the struct and run
:GoImpl [interface]
```
" Run `go generate` for current file
:GoGenerate %
```
Usage examples:
```vim
:GoImpl r Read io.Reader
:GoImpl Write io.Writer
8. Generate doc comment
" or you can simply put a cursor on the struct and run
:GoImpl io.Reader
```
</details>
First set a cursor on **public** package/function/interface/struct and execute:
<details>
<summary>
<b>Generate boilerplate for doc comments</b>
</summary>
```vim
:GoCmt
```
First set a cursor on **public** package/function/interface/struct and execute:
9. Generate `if err`
```vim
:GoCmt
```
</details>
Set cursor on the line with **err** and execute:
```vim
:GoIfErr
```
<details>
<summary>
<b>Generate <code>if err != nil {</code> via <a href="https://github.com/koron/iferr">iferr</a></b>
</summary>
10. Setup nvim-dap for go in one line.
Set the cursor on the line with `err` and execute
Notice: [nvim-dap](https://github.com/mfussenegger/nvim-dap) is required
```vim
:GoIfErr
```
</details>
```lua
require"gopher.dap".setup()
```
<details>
<summary>
<b>Setup <a href="https://github.com/mfussenegger/nvim-dap">nvim-dap</a> for go in one line</b>
</summary>
THIS FEATURE WILL BE REMOVED IN `0.1.6`
note [nvim-dap](https://github.com/mfussenegger/nvim-dap) has to be installed
```lua
require("gopher.dap").setup()
```
</details>
## Contributing
@ -164,3 +237,4 @@ PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)
- [go.nvim](https://github.com/ray-x/go.nvim)
- [nvim-dap-go](https://github.com/leoluz/nvim-dap-go)
- [iferr](https://github.com/koron/iferr)