olexsmir.xyz
+9
-7
.github/workflows/tests.yml
+9
-7
.github/workflows/tests.yml
···
15
15
version:
16
16
- stable
17
17
- nightly
18
+
- v0.10.0
19
+
- v0.10.4
20
+
- v0.11.0
21
+
- v0.11.1
22
+
- v0.11.2
23
+
- v0.11.3
24
+
- v0.11.4
18
25
runs-on: ${{ matrix.os }}
19
26
steps:
20
27
- name: Install Task
···
47
54
key: ${{ runner.os }}-tests-${{ hashFiles('${{ github.workspace }}/.tests') }}
48
55
49
56
- name: Install Go bins
50
-
run: |
51
-
# TODO: install with :GoInstallDeps
52
-
go install github.com/fatih/gomodifytags@latest
53
-
go install github.com/josharian/impl@latest
54
-
go install github.com/cweill/gotests/...@latest
55
-
go install github.com/koron/iferr@latest
57
+
run: task install-deps
56
58
57
59
- name: Run Tests
58
60
run: |
59
61
nvim --version
60
-
task tests
62
+
task test
+10
-12
CONTRIBUTING.md
+10
-12
CONTRIBUTING.md
···
1
1
# Contributing to `gopher.nvim`
2
-
3
2
Thank you for taking the time to submit some code to gopher.nvim. It means a lot!
4
3
5
4
### Task running
6
-
7
5
In this codebase for running tasks is used [Taskfile](https://taskfile.dev).
8
6
You can install it with:
9
7
```bash
10
8
go install github.com/go-task/task/v3/cmd/task@latest
11
9
```
12
10
13
-
### Styling and formatting
14
-
11
+
### Formatting and linting
15
12
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
16
13
You can install these with:
17
14
···
22
19
23
20
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
24
21
```bash
25
-
task stylua
26
-
task lint # lintering and format chewing
22
+
task format
23
+
task lint
27
24
```
28
25
29
26
### Documentation
27
+
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
28
+
for generating vimhelp files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
30
29
31
-
Here we are using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
32
-
for generating help files based on EmmyLua-like annotations in comments
30
+
For demo gifs in [readme](./README.md) we're using [vhs](https://github.com/charmbracelet/vhs).
31
+
All files related to demos live in [/vhs](./vhs) dir.
33
32
34
33
You can generate docs with:
35
34
```bash
36
-
task docgen
35
+
task docgen # generates vimhelp
36
+
task vhs:generate # generates demo gifs
37
37
```
38
38
39
39
### Commit messages
40
-
41
40
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it.
42
41
43
42
### Testing
44
-
45
43
For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md).
46
44
All tests live in [/spec](./spec) dir.
47
45
48
46
You can run tests with:
49
47
```bash
50
-
task tests
48
+
task test
51
49
```
+122
-55
README.md
+122
-55
README.md
···
4
4
5
5
Minimalistic plugin for Go development in Neovim written in Lua.
6
6
7
-
It's **NOT** an LSP tool, the main goal of this plugin is to add go tooling support in Neovim.
7
+
It's **NOT** an LSP tool, the goal of this plugin is to add go tooling support in Neovim.
8
8
9
-
> 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.
9
+
> All development of new and maybe undocumented, and unstable features is happening on [develop](https://github.com/olexsmir/gopher.nvim/tree/develop) branch.
10
+
11
+
## Table of content
12
+
* [How to install](#install-using-lazynvim)
13
+
* [Features](#features)
14
+
* [Configuration](#configuration)
15
+
* [Troubleshooting](#troubleshooting)
16
+
* [Contributing](#contributing)
10
17
11
18
## Install (using [lazy.nvim](https://github.com/folke/lazy.nvim))
12
19
13
20
Requirements:
14
21
15
22
- **Neovim 0.10** or later
16
-
- Treesitter `go` parser(`:TSInstall go` if you use [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter))
17
-
- [Go](https://github.com/golang/go) installed (tested on 1.23)
23
+
- Treesitter parser for `go`(`:TSInstall go` if you use [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter))
24
+
- [Go](https://github.com/golang/go) installed
25
+
26
+
> [!IMPORTANT]
27
+
> If you prefer using other forges, this repository is also mirrored at:
28
+
> - [tangled.org](https://tangled.org): [`https://tangled.org/olexsmir.xyz/gopher.nvim`](https://tangled.org/olexsmir.xyz/gopher.nvim)
29
+
> - [codeberg.org](https://codeberg.org): [`https://codeberg.org/olexsmir/gopher.nvim`](https://codeberg.org/olexsmir/gopher.nvim)
18
30
19
31
```lua
32
+
-- NOTE: this plugin is already lazy-loaded and adds only about 1ms
33
+
-- of load time to your config
20
34
{
21
35
"olexsmir/gopher.nvim",
22
36
ft = "go",
23
37
-- branch = "develop"
24
-
-- (optional) will update plugin's deps on every update
38
+
-- (optional) updates the plugin's dependencies on each update
25
39
build = function()
26
40
vim.cmd.GoInstallDeps()
27
41
end,
42
+
---@module "gopher"
28
43
---@type gopher.Config
29
44
opts = {},
30
45
}
31
46
```
32
47
33
-
## Configuration
34
-
35
-
> [!IMPORTANT]
36
-
>
37
-
> If you need more info look `:h gopher.nvim`
38
-
39
-
**Take a look at default options (might be a bit outdated, look `:h gopher.nvim-config`)**
40
-
41
-
```lua
42
-
require("gopher").setup {
43
-
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
44
-
log_level = vim.log.levels.INFO,
45
-
46
-
-- timeout for running internal commands
47
-
timeout = 2000,
48
-
49
-
commands = {
50
-
go = "go",
51
-
gomodifytags = "gomodifytags",
52
-
gotests = "gotests",
53
-
impl = "impl",
54
-
iferr = "iferr",
55
-
},
56
-
gotests = {
57
-
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
58
-
template = "default",
59
-
-- path to a directory containing custom test code templates
60
-
template_dir = nil,
61
-
-- switch table tests from using slice to map (with test name for the key)
62
-
named = false,
63
-
},
64
-
gotag = {
65
-
transform = "snakecase",
66
-
-- default tags to add to struct fields
67
-
default_tag = "json",
68
-
},
69
-
iferr = {
70
-
-- choose a custom error message
71
-
message = nil,
72
-
},
73
-
}
74
-
```
75
-
76
48
## Features
77
-
78
-
<!-- markdownlint-disable -->
79
49
80
50
<details>
81
51
<summary>
···
92
62
- [impl](https://github.com/josharian/impl)
93
63
- [gotests](https://github.com/cweill/gotests)
94
64
- [iferr](https://github.com/koron/iferr)
65
+
- [json2go](https://github.com/olexsmir/json2go)
95
66
</details>
96
67
97
68
<details>
···
99
70
<b>Add and remove tags for structs via <a href="https://github.com/fatih/gomodifytags">gomodifytags</a></b>
100
71
</summary>
101
72
73
+
74
+
102
75
By default `json` tag will be added/removed, if not set:
103
76
104
77
```vim
105
78
" add json tag
106
79
:GoTagAdd json
80
+
81
+
" add json tag with omitempty option
82
+
:GoTagAdd json=omitempty
107
83
108
84
" remove yaml tag
109
85
:GoTagRm yaml
···
175
151
<summary>
176
152
<b>Interface implementation via <a href="https://github.com/josharian/impl">impl<a></b>
177
153
</summary>
154
+
155
+
178
156
179
157
Syntax of the command:
180
158
```vim
···
199
177
<b>Generate boilerplate for doc comments</b>
200
178
</summary>
201
179
180
+
181
+
202
182
First set a cursor on **public** package/function/interface/struct and execute:
203
183
204
184
```vim
···
206
186
```
207
187
</details>
208
188
189
+
<details>
190
+
<summary>
191
+
<b>Convert json to Go types</b>
192
+
</summary>
193
+
194
+
195
+
196
+
`:GoJson` opens a temporary buffer where you can paste or write JSON.
197
+
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the generated Go struct into the original buffer at the cursor position.
198
+
199
+
Alternatively, you can pass JSON directly as an argument:
200
+
```vim
201
+
:GoJson {"name": "Alice", "age": 30}
202
+
```
203
+
204
+
Additionally, `gopher.json2go` provides lua api, see `:h gopher.nvim-json2go` for details.
205
+
</details>
206
+
209
207
210
208
<details>
211
209
<summary>
212
210
<b>Generate <code>if err != nil {</code> via <a href="https://github.com/koron/iferr">iferr</a></b>
213
211
</summary>
212
+
213
+
214
214
215
215
Set the cursor on the line with `err` and execute
216
216
···
219
219
```
220
220
</details>
221
221
222
-
## Contributing
222
+
## Configuration
223
223
224
-
PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)
224
+
> [!IMPORTANT]
225
+
>
226
+
> If you need more info look `:h gopher.nvim`
225
227
226
-
## Thanks
228
+
**Take a look at default options (might be a bit outdated, look `:h gopher.nvim-config`)**
227
229
228
-
- [go.nvim](https://github.com/ray-x/go.nvim)
229
-
- [iferr](https://github.com/koron/iferr)
230
+
```lua
231
+
require("gopher").setup {
232
+
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
233
+
log_level = vim.log.levels.INFO,
234
+
235
+
-- timeout for running internal commands
236
+
timeout = 2000,
237
+
238
+
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
239
+
installer_timeout = 999999,
240
+
241
+
-- user specified paths to binaries
242
+
commands = {
243
+
go = "go",
244
+
gomodifytags = "gomodifytags",
245
+
gotests = "gotests",
246
+
impl = "impl",
247
+
iferr = "iferr",
248
+
},
249
+
gotests = {
250
+
-- a default template that gotess will use.
251
+
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
252
+
template = "default",
253
+
254
+
-- path to a directory containing custom test code templates
255
+
template_dir = nil,
256
+
257
+
-- use named tests(map with test name as key) in table tests(slice of structs by default)
258
+
named = false,
259
+
},
260
+
gotag = {
261
+
transform = "snakecase",
262
+
263
+
-- default tags to add to struct fields
264
+
default_tag = "json",
265
+
266
+
-- default tag option added struct fields, set to nil to disable
267
+
-- e.g: `option = "json=omitempty,xml=omitempty`
268
+
option = nil,
269
+
},
270
+
iferr = {
271
+
-- choose a custom error message, nil to use default
272
+
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
273
+
message = nil,
274
+
},
275
+
json2go = {
276
+
-- command used to open interactive input.
277
+
-- e.g: `split`, `botright split`, `tabnew`
278
+
interactive_cmd = "vsplit",
279
+
280
+
-- name of autogenerated struct
281
+
-- e.g: "MySuperCoolName"
282
+
type_name = nil,
283
+
},
284
+
}
285
+
```
286
+
287
+
## Troubleshooting
288
+
The most common issue with the plugin is missing dependencies.
289
+
Run `:checkhealth gopher` to verify that the plugin is installed correctly.
290
+
If any binaries are missing, install them using `:GoInstallDeps`.
291
+
292
+
If the issue persists, feel free to [open a new issue](https://github.com/olexsmir/gopher.nvim/issues/new).
293
+
294
+
## Contributing
295
+
296
+
PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)
+22
-14
Taskfile.yml
+22
-14
Taskfile.yml
···
1
1
version: "3"
2
+
3
+
includes:
4
+
vhs:
5
+
taskfile: ./vhs/Taskfile.yml
6
+
dir: ./vhs
7
+
2
8
tasks:
3
9
lint:
4
-
desc: runs all linters
5
-
cmds:
6
-
- task: selene
7
-
- stylua --check .
8
-
9
-
selene:
10
-
desc: runs lua linter(selene)
11
10
cmds:
12
11
- selene .
12
+
- stylua --check .
13
13
14
-
stylua:
15
-
desc: runs lua formatter
16
-
cmds:
17
-
- stylua .
14
+
format:
15
+
cmd: stylua .
18
16
19
-
tests:
20
-
desc: run all tests
17
+
test:
21
18
cmds:
22
19
- |
23
20
nvim --clean --headless \
24
21
-u ./scripts/minimal_init.lua \
25
-
-c "lua MiniTest.run()"
22
+
-c "lua MiniTest.run()" \
23
+
-c ":qa!"
24
+
nvim:
25
+
cmd: nvim --clean -u "./scripts/minimal_init.lua" {{ .CLI_ARGS }}
26
26
27
27
docgen:
28
28
desc: generate vimhelp
···
32
32
-u "./scripts/minimal_init.lua" \
33
33
-c "luafile ./scripts/docgen.lua" \
34
34
-c ":qa!"
35
+
36
+
install-deps:
37
+
desc: installs go bin (used in CI)
38
+
cmds:
39
+
- |
40
+
nvim --clean --headless \
41
+
-u "./scripts/minimal_init.lua" \
42
+
+GoInstallDepsSync +qa
+104
-30
doc/gopher.nvim.txt
+104
-30
doc/gopher.nvim.txt
···
13
13
Config ................................................ |gopher.nvim-config|
14
14
Commands ............................................ |gopher.nvim-commands|
15
15
Modify struct tags ............................... |gopher.nvim-struct-tags|
16
+
json2go .............................................. |gopher.nvim-json2go|
16
17
Auto implementation of interface methods ................ |gopher.nvim-impl|
17
18
Generating unit tests boilerplate .................... |gopher.nvim-gotests|
18
19
Iferr .................................................. |gopher.nvim-iferr|
···
36
37
------------------------------------------------------------------------------
37
38
*gopher.nvim-dependencies*
38
39
`gopher.install_deps`
39
-
Gopher.nvim implements most of its features using third-party tools.
40
-
To install these tools, you can run `:GoInstallDeps` command
41
-
or call `require("gopher").install_deps()` if you want to use lua api.
42
-
By default dependencies will be installed asynchronously,
43
-
to install them synchronously pass `{sync = true}` as an argument.
40
+
41
+
Gopher.nvim implements most of its features using third-party tools. To
42
+
install plugin's dependencies, you can run:
43
+
`:GoInstallDeps` or `:GoInstallDepsSync`
44
+
or use `require("gopher").install_deps()` if you prefer lua api.
44
45
45
46
46
47
==============================================================================
···
57
58
---@type number
58
59
timeout = 2000,
59
60
61
+
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
62
+
---@type number
63
+
installer_timeout = 999999,
64
+
60
65
-- user specified paths to binaries
61
66
---@class gopher.ConfigCommand
62
67
commands = {
···
65
70
gotests = "gotests",
66
71
impl = "impl",
67
72
iferr = "iferr",
73
+
json2go = "json2go",
68
74
},
69
75
---@class gopher.ConfigGotests
70
76
gotests = {
71
-
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
77
+
-- a default template that gotess will use.
78
+
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
72
79
template = "default",
80
+
73
81
-- path to a directory containing custom test code templates
74
82
---@type string|nil
75
83
template_dir = nil,
76
-
-- switch table tests from using slice to map (with test name for the key)
84
+
85
+
-- use named tests(map with test name as key) in table tests(slice of structs by default)
77
86
named = false,
78
87
},
79
88
---@class gopher.ConfigGoTag
···
83
92
84
93
-- default tags to add to struct fields
85
94
default_tag = "json",
95
+
96
+
-- default tag option added struct fields, set to nil to disable
97
+
-- e.g: `option = "json=omitempty,xml=omitempty`
98
+
---@type string|nil
99
+
option = nil,
86
100
},
101
+
---@class gopher.ConfigIfErr
87
102
iferr = {
88
-
-- choose a custom error message
103
+
-- choose a custom error message, nil to use default
104
+
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
89
105
---@type string|nil
90
106
message = nil,
91
107
},
108
+
---@class gopher.ConfigJson2Go
109
+
json2go = {
110
+
-- command used to open interactive input.
111
+
-- e.g: `split`, `botright split`, `tabnew`
112
+
interactive_cmd = "vsplit",
113
+
114
+
-- name of autogenerated struct, if nil none, will the default one of json2go.
115
+
-- e.g: "MySuperCoolName"
116
+
---@type string|nil
117
+
type_name = nil,
118
+
},
92
119
}
93
120
<
94
121
Class ~
95
122
{gopher.Config}
123
+
Fields ~
124
+
{setup} `(fun(user_config?: gopher.Config))`
96
125
97
126
98
127
==============================================================================
···
107
136
------------------------------------------------------------------------------
108
137
*gopher.nvim-struct-tags*
109
138
110
-
`struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to struct fields.
139
+
`struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to
140
+
struct fields.
111
141
112
142
Usage ~
113
143
114
-
How to add/remove tags to struct fields:
144
+
How to add/remove/clear tags to struct fields:
115
145
1. Place cursor on the struct
116
146
2. Run `:GoTagAdd json` to add json tags to struct fields
117
147
3. Run `:GoTagRm json` to remove json tags to struct fields
148
+
4. Run `:GoTagClear` to clear all tags from struct fields
118
149
119
-
To clear all tags from struct run: `:GoTagClear`
150
+
If you want to add/remove tag with options, you can use `json=omitempty`
151
+
(where json is tag, and omitempty is its option).
152
+
Example: `:GoTagAdd xml json=omitempty`
153
+
120
154
121
155
NOTE: if you dont specify the tag it will use `json` as default
122
156
···
139
173
140
174
==============================================================================
141
175
------------------------------------------------------------------------------
176
+
*gopher.nvim-json2go*
177
+
178
+
Convert json to go type annotations.
179
+
180
+
Usage ~
181
+
182
+
`:GoJson` opens a temporary buffer where you can paste or write JSON.
183
+
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
184
+
generated Go struct into the original buffer at the cursor position.
185
+
186
+
Alternatively, you can pass JSON directly as an argument:
187
+
>vim
188
+
:GoJson {"name": "Alice", "age": 30}
189
+
<
190
+
------------------------------------------------------------------------------
191
+
*json2go.transform()*
192
+
`json2go.transform`({json_str})
193
+
194
+
Parameters ~
195
+
{json_str} `(string)` Json string that is going to be converted to go type.
196
+
Return ~
197
+
`(string)` `(optional)` Go type, or nil if failed.
198
+
199
+
------------------------------------------------------------------------------
200
+
*json2go.json2go()*
201
+
`json2go.json2go`({json_str})
202
+
Converts json string to go type, and puts result under the cursor. If
203
+
[json_str] is nil, will open an interactive prompt (with cmd set in
204
+
config).
205
+
206
+
Parameters ~
207
+
{json_str} `(optional)` `(string)`
208
+
209
+
210
+
==============================================================================
211
+
------------------------------------------------------------------------------
142
212
*gopher.nvim-impl*
143
213
144
214
Integration of `impl` tool to generate method stubs for interfaces.
145
215
146
216
Usage ~
217
+
147
218
1. Automatically implement an interface for a struct:
148
-
- Place your cursor on the struct where you want to implement the interface.
149
-
- Run `:GoImpl io.Reader`
150
-
- This will automatically determine the receiver and implement the `io.Reader` interface.
219
+
- Place your cursor on the struct where you want to implement the interface.
220
+
- Run `:GoImpl io.Reader`
221
+
- This will automatically determine the receiver and implement the `io.Reader` interface.
151
222
152
223
2. Specify a custom receiver:
153
-
- Place your cursor on the struct
154
-
- Run `:GoImpl w io.Writer`, where:
155
-
- `w` is the receiver.
156
-
- `io.Writer` is the interface to implement.
224
+
- Place your cursor on the struct
225
+
- Run `:GoImpl w io.Writer`, where:
226
+
- `w` is the receiver.
227
+
- `io.Writer` is the interface to implement.
157
228
158
229
3. Explicitly specify the receiver, struct, and interface:
159
-
- No need to place the cursor on the struct if all arguments are provided.
160
-
- Run `:GoImpl r RequestReader io.Reader`, where:
161
-
- `r` is the receiver.
162
-
- `RequestReader` is the struct.
163
-
- `io.Reader` is the interface to implement.
230
+
- No need to place the cursor on the struct if all arguments are provided.
231
+
- Run `:GoImpl r RequestReader io.Reader`, where:
232
+
- `r` is the receiver.
233
+
- `RequestReader` is the struct.
234
+
- `io.Reader` is the interface to implement.
164
235
165
236
Example:
166
237
>go
···
181
252
Usage ~
182
253
183
254
- Generate unit test for specific function/method:
184
-
1. Place your cursor on the desired function/method.
185
-
2. Run `:GoTestAdd`
255
+
1. Place your cursor on the desired function/method.
256
+
2. Run `:GoTestAdd`
186
257
187
258
- Generate unit tests for *all* functions/methods in current file:
188
-
- run `:GoTestsAll`
259
+
- run `:GoTestsAll`
189
260
190
261
- Generate unit tests *only* for *exported(public)* functions/methods:
191
-
- run `:GoTestsExp`
262
+
- run `:GoTestsExp`
192
263
193
-
You can also specify the template to use for generating the tests. See |gopher.nvim-config|
194
-
More details about templates can be found at: https://github.com/cweill/gotests
264
+
You can also specify the template to use for generating the tests.
265
+
See |gopher.nvim-config|.
266
+
More details about templates: https://github.com/cweill/gotests
195
267
196
268
If you prefer named tests, you can enable them in |gopher.nvim-config|.
197
269
···
214
286
This module provides a way to generate comments for Go code.
215
287
216
288
Usage ~
217
-
Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment.
289
+
290
+
Set cursor on line with function/method/struct/etc and
291
+
run `:GoCmt` to generate a comment.
218
292
219
293
220
294
vim:tw=78:ts=8:noet:ft=help:norl:
-51
lua/gopher/_utils/gocmd.lua
-51
lua/gopher/_utils/gocmd.lua
···
1
-
local r = require "gopher._utils.runner"
2
-
local c = require("gopher.config").commands
3
-
local u = require "gopher._utils"
4
-
local gocmd = {}
5
-
6
-
---@param args string[]
7
-
---@return string[]
8
-
local function if_get(args)
9
-
for i, arg in ipairs(args) do
10
-
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
11
-
table.remove(args, i)
12
-
table.insert(args, i, m)
13
-
end
14
-
return args
15
-
end
16
-
17
-
---@param args unknown[]
18
-
---@return string[]
19
-
local function if_generate(args)
20
-
if #args == 1 and args[1] == "%" then
21
-
args[1] = vim.fn.expand "%"
22
-
end
23
-
return args
24
-
end
25
-
26
-
---@param subcmd string
27
-
---@param args string[]
28
-
---@return string
29
-
function gocmd.run(subcmd, args)
30
-
if #args == 0 and subcmd ~= "generate" then
31
-
error "please provide any arguments"
32
-
end
33
-
34
-
if subcmd == "get" then
35
-
args = if_get(args)
36
-
end
37
-
38
-
if subcmd == "generate" then
39
-
args = if_generate(args)
40
-
end
41
-
42
-
local rs = r.sync { c.go, subcmd, unpack(args) }
43
-
if rs.code ~= 0 then
44
-
error("go " .. subcmd .. " failed: " .. rs.stderr)
45
-
end
46
-
47
-
u.notify(c.go .. " " .. subcmd .. " ran successful")
48
-
return rs.stdout
49
-
end
50
-
51
-
return gocmd
+32
-1
lua/gopher/_utils/init.lua
+32
-1
lua/gopher/_utils/init.lua
···
3
3
local utils = {}
4
4
5
5
---@param msg string
6
-
---@param lvl? number
6
+
---@param lvl? integer by default `vim.log.levels.INFO`
7
7
function utils.notify(msg, lvl)
8
8
lvl = lvl or vim.log.levels.INFO
9
9
vim.notify(msg, lvl, {
···
36
36
function utils.trimend(s)
37
37
local r, _ = string.gsub(s, "%s+$", "")
38
38
return r
39
+
end
40
+
41
+
-- Since indentation can be spaces or tabs, that's my hack around it
42
+
---@param line string
43
+
---@param indent integer
44
+
---@return string
45
+
function utils.indent(line, indent)
46
+
local char = string.sub(line, 1, 1)
47
+
if char ~= " " and char ~= "\t" then
48
+
char = " "
49
+
end
50
+
return string.rep(char, indent)
51
+
end
52
+
53
+
---@generic T
54
+
---@param tbl T[]
55
+
---@return T[]
56
+
function utils.list_unique(tbl)
57
+
if vim.fn.has "nvim-0.12" == 1 then
58
+
return vim.list.unique(tbl)
59
+
end
60
+
61
+
for i = #tbl, 1, -1 do
62
+
for j = 1, i - 1 do
63
+
if tbl[i] == tbl[j] then
64
+
table.remove(tbl, i)
65
+
break
66
+
end
67
+
end
68
+
end
69
+
return tbl
39
70
end
40
71
41
72
return utils
+2
-2
lua/gopher/_utils/log.lua
+2
-2
lua/gopher/_utils/log.lua
···
3
3
-- for the code i have stolen(or have inspected by idk)
4
4
local c = require "gopher.config"
5
5
6
-
---@class Gopher.Logger
6
+
---@class gopher.Logger
7
7
---@field get_outfile fun():string
8
8
---@field trace fun(...)
9
9
---@field fmt_trace fun(...)
···
44
44
float_precision = 0.01,
45
45
}
46
46
47
-
---@type Gopher.Logger
47
+
---@type gopher.Logger
48
48
---@diagnostic disable-next-line: missing-fields
49
49
local log = {}
50
50
+42
-18
lua/gopher/_utils/ts.lua
+42
-18
lua/gopher/_utils/ts.lua
···
11
11
right: (expression_list (composite_literal
12
12
type: (struct_type))))]
13
13
]],
14
+
struct_field = [[
15
+
(field_declaration name: (field_identifier) @_name)
16
+
]],
14
17
func = [[
15
18
[(function_declaration name: (identifier) @_name)
16
-
(method_declaration name: (field_identifier) @_name)]
19
+
(method_declaration name: (field_identifier) @_name)
20
+
(method_elem name: (field_identifier) @_name)]
17
21
]],
18
22
package = [[
19
23
(package_identifier) @_name
···
23
27
name: (type_identifier) @_name
24
28
type: (interface_type))
25
29
]],
30
+
var = [[
31
+
[(var_declaration (var_spec name: (identifier) @_name))
32
+
(short_var_declaration
33
+
left: (expression_list (identifier) @_name @_var))]
34
+
]],
26
35
}
27
36
28
37
---@param parent_type string[]
29
38
---@param node TSNode
30
39
---@return TSNode?
31
-
local function get_parrent_node(parent_type, node)
40
+
local function get_parent_node(parent_type, node)
32
41
---@type TSNode?
33
42
local current = node
34
43
while current do
···
64
73
end
65
74
66
75
---@class gopher.TsResult
67
-
---@field name string
68
-
---@field start_line integer
69
-
---@field end_line integer
70
-
---@field is_varstruct boolean
76
+
---@field name string Name of the struct, function, etc
77
+
---@field start integer Line number where the declaration starts
78
+
---@field end_ integer Line number where the declaration ends
79
+
---@field indent integer Number of spaces/tabs in the current cursor line
80
+
---@field is_varstruct boolean Is struct declared as `var S struct{}` or `s := struct{}{}`
71
81
72
82
---@param bufnr integer
73
83
---@param parent_type string[]
···
78
88
error "No treesitter parser found for go"
79
89
end
80
90
81
-
local node = vim.treesitter.get_node {
82
-
bufnr = bufnr,
83
-
}
91
+
local node = vim.treesitter.get_node { bufnr = bufnr }
84
92
if not node then
85
-
error "No nodes found under cursor"
93
+
error "No nodes found under the cursor"
86
94
end
87
95
88
-
local parent_node = get_parrent_node(parent_type, node)
96
+
local parent_node = get_parent_node(parent_type, node)
89
97
if not parent_node then
90
-
error "No parent node found under cursor"
98
+
error "No parent node found under the cursor"
91
99
end
92
100
93
101
local q = vim.treesitter.query.parse("go", query)
94
102
local res = get_captures(q, parent_node, bufnr)
95
103
assert(res.name ~= nil, "No capture name found")
96
104
97
-
local start_row, _, end_row, _ = parent_node:range()
98
-
res["start_line"] = start_row + 1
99
-
res["end_line"] = end_row + 1
105
+
local start_row, start_col, end_row, _ = parent_node:range()
106
+
res["indent"] = start_col
107
+
res["start"] = start_row + 1
108
+
res["end_"] = end_row + 1
100
109
101
110
return res
102
111
end
···
104
113
---@param bufnr integer
105
114
function ts.get_struct_under_cursor(bufnr)
106
115
--- should be both type_spec and type_declaration
107
-
--- because in cases like `type ( T struct{}, U strict{} )`
108
-
--- i will be choosing always last struct in the list
116
+
--- because in cases like `type ( T struct{}, U struct{} )`
109
117
---
110
118
--- var_declaration is for cases like `var x struct{}`
111
119
--- short_var_declaration is for cases like `x := struct{}{}`
120
+
---
121
+
--- it always chooses last struct type in the list
112
122
return do_stuff(bufnr, {
113
123
"type_spec",
114
124
"type_declaration",
···
118
128
end
119
129
120
130
---@param bufnr integer
131
+
function ts.get_struct_field_under_cursor(bufnr)
132
+
return do_stuff(bufnr, { "field_declaration" }, queries.struct_field)
133
+
end
134
+
135
+
---@param bufnr integer
121
136
function ts.get_func_under_cursor(bufnr)
122
137
--- since this handles both and funcs and methods we should check for both parent nodes
123
-
return do_stuff(bufnr, { "function_declaration", "method_declaration" }, queries.func)
138
+
return do_stuff(bufnr, {
139
+
"method_elem",
140
+
"function_declaration",
141
+
"method_declaration",
142
+
}, queries.func)
124
143
end
125
144
126
145
---@param bufnr integer
···
131
150
---@param bufnr integer
132
151
function ts.get_interface_under_cursor(bufnr)
133
152
return do_stuff(bufnr, { "type_declaration" }, queries.interface)
153
+
end
154
+
155
+
---@param bufnr integer
156
+
function ts.get_variable_under_cursor(bufnr)
157
+
return do_stuff(bufnr, { "var_declaration", "short_var_declaration" }, queries.var)
134
158
end
135
159
136
160
return ts
+31
-17
lua/gopher/comment.lua
+31
-17
lua/gopher/comment.lua
···
3
3
---@text
4
4
--- This module provides a way to generate comments for Go code.
5
5
---
6
-
---@usage Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment.
6
+
---@usage
7
+
--- Set cursor on line with function/method/struct/etc and
8
+
--- run `:GoCmt` to generate a comment.
7
9
8
10
local ts = require "gopher._utils.ts"
9
11
local log = require "gopher._utils.log"
12
+
local u = require "gopher._utils"
10
13
local comment = {}
11
14
12
-
---@param name string
13
-
---@return string
14
-
---@dochide
15
-
local function template(name)
16
-
return "// " .. name .. " "
17
-
end
18
-
15
+
--- NOTE: The order of functions executed inside this function is IMPORTANT.
16
+
--- This function is extremely fragile; run tests after making any changes.
17
+
---
19
18
---@param bufnr integer
19
+
---@param line string
20
20
---@return string
21
21
---@dochide
22
-
local function generate(bufnr)
22
+
local function generate(bufnr, line)
23
+
local sf_ok, sf_res = pcall(ts.get_struct_field_under_cursor, bufnr)
24
+
if sf_ok then
25
+
return u.indent(line, sf_res.indent) .. "// " .. sf_res.name .. " "
26
+
end
27
+
23
28
local s_ok, s_res = pcall(ts.get_struct_under_cursor, bufnr)
24
29
if s_ok then
25
-
return template(s_res.name)
30
+
return u.indent(line, s_res.indent) .. "// " .. s_res.name .. " "
31
+
end
32
+
33
+
local v_ok, v_res = pcall(ts.get_variable_under_cursor, bufnr)
34
+
if v_ok then
35
+
return u.indent(line, v_res.indent) .. "// " .. v_res.name .. " "
26
36
end
27
37
28
38
local f_ok, f_res = pcall(ts.get_func_under_cursor, bufnr)
29
39
if f_ok then
30
-
return template(f_res.name)
40
+
return u.indent(line, f_res.indent) .. "// " .. f_res.name .. " "
31
41
end
32
42
33
43
local i_ok, i_res = pcall(ts.get_interface_under_cursor, bufnr)
34
44
if i_ok then
35
-
return template(i_res.name)
45
+
return u.indent(line, i_res.indent) .. "// " .. i_res.name .. " "
36
46
end
37
47
38
48
local p_ok, p_res = pcall(ts.get_package_under_cursor, bufnr)
···
45
55
46
56
function comment.comment()
47
57
local bufnr = vim.api.nvim_get_current_buf()
48
-
local cmt = generate(bufnr)
49
-
log.debug("generated comment: " .. cmt)
58
+
local lnum = vim.fn.getcurpos()[2]
59
+
local line = vim.fn.getline(lnum)
60
+
local cmt = generate(bufnr, line)
61
+
log.debug("generated comment:", {
62
+
comment = cmt,
63
+
line = line,
64
+
})
50
65
51
-
local pos = vim.fn.getcurpos()[2]
52
-
vim.fn.append(pos - 1, cmt)
53
-
vim.fn.setpos(".", { 0, pos, #cmt })
66
+
vim.fn.append(lnum - 1, cmt)
67
+
vim.fn.setpos(".", { bufnr, lnum, #cmt })
54
68
vim.cmd "startinsert!"
55
69
end
56
70
+56
-24
lua/gopher/config.lua
+56
-24
lua/gopher/config.lua
···
1
+
---@type gopher.Config
2
+
---@dochide
3
+
---@diagnostic disable-next-line: missing-fields .setup() gets injected later
1
4
local config = {}
2
5
3
6
---@tag gopher.nvim-config.ConfigGoTagTransform
···
16
19
---@tag gopher.nvim-config
17
20
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
18
21
---@class gopher.Config
22
+
---@field setup fun(user_config?: gopher.Config)
19
23
local default_config = {
20
24
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
21
25
---@type number
···
25
29
---@type number
26
30
timeout = 2000,
27
31
32
+
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
33
+
---@type number
34
+
installer_timeout = 999999,
35
+
28
36
-- user specified paths to binaries
29
37
---@class gopher.ConfigCommand
30
38
commands = {
···
33
41
gotests = "gotests",
34
42
impl = "impl",
35
43
iferr = "iferr",
44
+
json2go = "json2go",
36
45
},
37
46
---@class gopher.ConfigGotests
38
47
gotests = {
39
-
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
48
+
-- a default template that gotess will use.
49
+
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
40
50
template = "default",
51
+
41
52
-- path to a directory containing custom test code templates
42
53
---@type string|nil
43
54
template_dir = nil,
44
-
-- switch table tests from using slice to map (with test name for the key)
55
+
56
+
-- use named tests(map with test name as key) in table tests(slice of structs by default)
45
57
named = false,
46
58
},
47
59
---@class gopher.ConfigGoTag
···
51
63
52
64
-- default tags to add to struct fields
53
65
default_tag = "json",
66
+
67
+
-- default tag option added struct fields, set to nil to disable
68
+
-- e.g: `option = "json=omitempty,xml=omitempty`
69
+
---@type string|nil
70
+
option = nil,
54
71
},
72
+
---@class gopher.ConfigIfErr
55
73
iferr = {
56
-
-- choose a custom error message
74
+
-- choose a custom error message, nil to use default
75
+
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
57
76
---@type string|nil
58
77
message = nil,
59
78
},
79
+
---@class gopher.ConfigJson2Go
80
+
json2go = {
81
+
-- command used to open interactive input.
82
+
-- e.g: `split`, `botright split`, `tabnew`
83
+
interactive_cmd = "vsplit",
84
+
85
+
-- name of autogenerated struct, if nil none, will the default one of json2go.
86
+
-- e.g: "MySuperCoolName"
87
+
---@type string|nil
88
+
type_name = nil,
89
+
},
60
90
}
61
91
--minidoc_afterlines_end
62
92
···
74
104
---@param user_config? gopher.Config
75
105
---@dochide
76
106
function config.setup(user_config)
77
-
vim.validate { user_config = { user_config, "table", true } }
107
+
vim.validate("user_config", user_config, "table", true)
78
108
79
109
_config = vim.tbl_deep_extend("force", vim.deepcopy(default_config), user_config or {})
80
110
81
-
vim.validate {
82
-
log_level = { _config.log_level, "number" },
83
-
timeout = { _config.timeout, "number" },
84
-
["commands"] = { _config.commands, "table" },
85
-
["commands.go"] = { _config.commands.go, "string" },
86
-
["commands.gomodifytags"] = { _config.commands.gomodifytags, "string" },
87
-
["commands.gotests"] = { _config.commands.gotests, "string" },
88
-
["commands.impl"] = { _config.commands.impl, "string" },
89
-
["commands.iferr"] = { _config.commands.iferr, "string" },
90
-
["gotests"] = { _config.gotests, "table" },
91
-
["gotests.template"] = { _config.gotests.template, "string" },
92
-
["gotests.template_dir"] = { _config.gotests.template, "string", true },
93
-
["gotests.named"] = { _config.gotests.named, "boolean" },
94
-
["gotag"] = { _config.gotag, "table" },
95
-
["gotag.transform"] = { _config.gotag.transform, "string" },
96
-
["gotag.default_tag"] = { _config.gotag.default_tag, "string" },
97
-
["iferr"] = { _config.iferr, "table" },
98
-
["iferr.message"] = { _config.iferr.message, "string", true },
99
-
}
111
+
vim.validate("log_level", _config.log_level, "number")
112
+
vim.validate("timeout", _config.timeout, "number")
113
+
vim.validate("installer_timeout", _config.timeout, "number")
114
+
vim.validate("commands", _config.commands, "table")
115
+
vim.validate("commands.go", _config.commands.go, "string")
116
+
vim.validate("commands.gomodifytags", _config.commands.gomodifytags, "string")
117
+
vim.validate("commands.gotests", _config.commands.gotests, "string")
118
+
vim.validate("commands.impl", _config.commands.impl, "string")
119
+
vim.validate("commands.iferr", _config.commands.iferr, "string")
120
+
vim.validate("commands.json2go", _config.commands.json2go, "string")
121
+
vim.validate("gotests", _config.gotests, "table")
122
+
vim.validate("gotests.template", _config.gotests.template, "string")
123
+
vim.validate("gotests.template_dir", _config.gotests.template_dir, { "string", "nil" })
124
+
vim.validate("gotests.named", _config.gotests.named, "boolean")
125
+
vim.validate("gotag", _config.gotag, "table")
126
+
vim.validate("gotag.transform", _config.gotag.transform, "string")
127
+
vim.validate("gotag.default_tag", _config.gotag.default_tag, "string")
128
+
vim.validate("gotag.option", _config.gotag.option, { "string", "nil" })
129
+
vim.validate("iferr", _config.iferr, "table")
130
+
vim.validate("iferr.message", _config.iferr.message, { "string", "nil" })
131
+
vim.validate("json2go.installer_timeout", _config.json2go.interactive_cmd, "string")
132
+
vim.validate("json2go.type_name", _config.json2go.type_name, { "string", "nil" })
100
133
end
101
134
102
135
setmetatable(config, {
···
106
139
})
107
140
108
141
---@dochide
109
-
---@return gopher.Config
110
142
return config
+56
lua/gopher/go.lua
+56
lua/gopher/go.lua
···
1
+
local c = require "gopher.config"
2
+
local u = require "gopher._utils"
3
+
local r = require "gopher._utils.runner"
4
+
local go = {}
5
+
6
+
local function run(subcmd, args)
7
+
local rs = r.sync { c.commands.go, subcmd, unpack(args) }
8
+
if rs.code ~= 0 then
9
+
error("go " .. subcmd .. " failed: " .. rs.stderr)
10
+
end
11
+
12
+
u.notify(c.commands.go .. " " .. subcmd .. " ran successful")
13
+
return rs.stdout
14
+
end
15
+
16
+
---@param args string[]
17
+
function go.get(args)
18
+
for i, arg in ipairs(args) do
19
+
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
20
+
table.remove(args, i)
21
+
table.insert(args, i, m)
22
+
end
23
+
24
+
run("get", args)
25
+
end
26
+
27
+
---@param args string[]
28
+
function go.mod(args)
29
+
run("mod", args)
30
+
end
31
+
32
+
---@param args string[]
33
+
function go.work(args)
34
+
-- TODO: use `gopls.tidy`
35
+
36
+
run("work", args)
37
+
end
38
+
39
+
---Executes `go generate`
40
+
---If only argument is `%` it's going to be equivalent to `go generate <path to current file>`
41
+
---@param args string[]
42
+
function go.generate(args)
43
+
-- TODO: use `gopls.generate`
44
+
45
+
if #args == 0 then
46
+
error "please provide arguments"
47
+
end
48
+
49
+
if #args == 1 and args[1] == "%" then
50
+
args[1] = vim.fn.expand "%"
51
+
end
52
+
53
+
run("generate", args)
54
+
end
55
+
56
+
return go
+7
-6
lua/gopher/gotests.lua
+7
-6
lua/gopher/gotests.lua
···
3
3
---@text gotests is utilizing the `gotests` tool to generate unit tests boilerplate.
4
4
---@usage
5
5
--- - Generate unit test for specific function/method:
6
-
--- 1. Place your cursor on the desired function/method.
7
-
--- 2. Run `:GoTestAdd`
6
+
--- 1. Place your cursor on the desired function/method.
7
+
--- 2. Run `:GoTestAdd`
8
8
---
9
9
--- - Generate unit tests for *all* functions/methods in current file:
10
-
--- - run `:GoTestsAll`
10
+
--- - run `:GoTestsAll`
11
11
---
12
12
--- - Generate unit tests *only* for *exported(public)* functions/methods:
13
-
--- - run `:GoTestsExp`
13
+
--- - run `:GoTestsExp`
14
14
---
15
-
--- You can also specify the template to use for generating the tests. See |gopher.nvim-config|
16
-
--- More details about templates can be found at: https://github.com/cweill/gotests
15
+
--- You can also specify the template to use for generating the tests.
16
+
--- See |gopher.nvim-config|.
17
+
--- More details about templates: https://github.com/cweill/gotests
17
18
---
18
19
--- If you prefer named tests, you can enable them in |gopher.nvim-config|.
19
20
+33
-37
lua/gopher/health.lua
+33
-37
lua/gopher/health.lua
···
1
+
local c = require("gopher.config").commands
1
2
local health = {}
2
-
local cmd = require("gopher.config").commands
3
3
4
4
local deps = {
5
+
vim_version = "nvim-0.10",
5
6
bin = {
6
7
{
7
-
bin = cmd.go,
8
+
bin = c.go,
8
9
msg = "required for `:GoGet`, `:GoMod`, `:GoGenerate`, `:GoWork`, `:GoInstallDeps`, `:GoInstallDepsSync`",
9
-
optional = false,
10
10
},
11
-
{ bin = cmd.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`", optional = true },
12
-
{ bin = cmd.impl, msg = "required for `:GoImpl`", optional = true },
13
-
{ bin = cmd.iferr, msg = "required for `:GoIfErr`", optional = true },
14
-
{
15
-
bin = cmd.gotests,
16
-
msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`",
17
-
optional = true,
18
-
},
11
+
{ bin = c.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`" },
12
+
{ bin = c.impl, msg = "required for `:GoImpl`" },
13
+
{ bin = c.iferr, msg = "required for `:GoIfErr`" },
14
+
{ bin = c.gotests, msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`" },
19
15
},
20
16
treesitter = {
21
17
{ parser = "go", msg = "required for most of the parts of `gopher.nvim`" },
22
18
},
23
19
}
24
20
25
-
---@param bin string
26
-
---@return boolean
27
-
local function is_binary_found(bin)
28
-
return vim.fn.executable(bin) == 1
21
+
---@param bin {bin:string, msg:string, optional:boolean}
22
+
local function check_binary(bin)
23
+
if vim.fn.executable(bin.bin) == 1 then
24
+
vim.health.ok(bin.bin .. " is found oh PATH: `" .. vim.fn.exepath(bin.bin) .. "`")
25
+
else
26
+
vim.health.error(bin.bin .. " not found on PATH, " .. bin.msg)
27
+
end
29
28
end
30
29
31
-
---@param ft string
32
-
---@return boolean
33
-
local function is_treesitter_parser_available(ft)
34
-
local ok, parser = pcall(vim.treesitter.get_parser, 0, ft)
35
-
return ok and parser ~= nil
30
+
---@param ts {parser:string, msg:string}
31
+
local function check_treesitter(ts)
32
+
local ok, parser = pcall(vim.treesitter.get_parser, 0, ts.parser)
33
+
if ok and parser ~= nil then
34
+
vim.health.ok("`" .. ts.parser .. "` parser is installed")
35
+
else
36
+
vim.health.error("`" .. ts.parser .. "` parser not found")
37
+
end
36
38
end
37
39
38
40
function health.check()
39
-
vim.health.start "required binaries"
40
-
vim.health.info "all those binaries can be installed by `:GoInstallDeps`"
41
+
vim.health.start "Neovim version"
42
+
if vim.fn.has(deps.vim_version) == 1 then
43
+
vim.health.ok "Neovim version is compatible"
44
+
else
45
+
vim.health.error(deps.vim_version .. " or newer is required")
46
+
end
47
+
48
+
vim.health.start "Required binaries (those can be installed with `:GoInstallDeps`)"
41
49
for _, bin in ipairs(deps.bin) do
42
-
if is_binary_found(bin.bin) then
43
-
vim.health.ok(bin.bin .. " installed")
44
-
else
45
-
if bin.optional then
46
-
vim.health.warn(bin.bin .. " not found, " .. bin.msg)
47
-
else
48
-
vim.health.error(bin.bin .. " not found, " .. bin.msg)
49
-
end
50
-
end
50
+
check_binary(bin)
51
51
end
52
52
53
-
vim.health.start "required treesitter parsers"
53
+
vim.health.start "Treesitter"
54
54
for _, parser in ipairs(deps.treesitter) do
55
-
if is_treesitter_parser_available(parser.parser) then
56
-
vim.health.ok(parser.parser .. " parser installed")
57
-
else
58
-
vim.health.error(parser.parser .. " parser not found, " .. parser.msg)
59
-
end
55
+
check_treesitter(parser)
60
56
end
61
57
end
62
58
+1
-1
lua/gopher/iferr.lua
+1
-1
lua/gopher/iferr.lua
+23
-15
lua/gopher/impl.lua
+23
-15
lua/gopher/impl.lua
···
3
3
---@text
4
4
--- Integration of `impl` tool to generate method stubs for interfaces.
5
5
---
6
-
---@usage 1. Automatically implement an interface for a struct:
7
-
--- - Place your cursor on the struct where you want to implement the interface.
8
-
--- - Run `:GoImpl io.Reader`
9
-
--- - This will automatically determine the receiver and implement the `io.Reader` interface.
6
+
---@usage
7
+
--- 1. Automatically implement an interface for a struct:
8
+
--- - Place your cursor on the struct where you want to implement the interface.
9
+
--- - Run `:GoImpl io.Reader`
10
+
--- - This will automatically determine the receiver and implement the `io.Reader` interface.
10
11
---
11
12
--- 2. Specify a custom receiver:
12
-
--- - Place your cursor on the struct
13
-
--- - Run `:GoImpl w io.Writer`, where:
14
-
--- - `w` is the receiver.
15
-
--- - `io.Writer` is the interface to implement.
13
+
--- - Place your cursor on the struct
14
+
--- - Run `:GoImpl w io.Writer`, where:
15
+
--- - `w` is the receiver.
16
+
--- - `io.Writer` is the interface to implement.
16
17
---
17
18
--- 3. Explicitly specify the receiver, struct, and interface:
18
-
--- - No need to place the cursor on the struct if all arguments are provided.
19
-
--- - Run `:GoImpl r RequestReader io.Reader`, where:
20
-
--- - `r` is the receiver.
21
-
--- - `RequestReader` is the struct.
22
-
--- - `io.Reader` is the interface to implement.
19
+
--- - No need to place the cursor on the struct if all arguments are provided.
20
+
--- - Run `:GoImpl r RequestReader io.Reader`, where:
21
+
--- - `r` is the receiver.
22
+
--- - `RequestReader` is the struct.
23
+
--- - `io.Reader` is the interface to implement.
23
24
---
24
25
--- Example:
25
26
--- >go
···
44
45
local iface, recv = "", ""
45
46
local bufnr = vim.api.nvim_get_current_buf()
46
47
47
-
if #args == 1 then -- :GoImpl io.Reader
48
+
if #args == 0 then
49
+
u.notify("arguments not provided. usage: :GoImpl f *File io.Reader", vim.log.levels.ERROR)
50
+
return
51
+
elseif #args == 1 then -- :GoImpl io.Reader
48
52
local st = ts_utils.get_struct_under_cursor(bufnr)
49
53
iface = args[1]
50
54
recv = string.lower(st.name) .. " *" .. st.name
···
57
61
iface = args[3]
58
62
end
59
63
60
-
local rs = r.sync { c.impl, "-dir", vim.fn.fnameescape(vim.fn.expand "%:p:h"), recv, iface }
64
+
assert(iface ~= "", "interface not provided")
65
+
assert(recv ~= "", "receiver not provided")
66
+
67
+
local dir = vim.fn.fnameescape(vim.fn.expand "%:p:h")
68
+
local rs = r.sync { c.impl, "-dir", dir, recv, iface }
61
69
if rs.code ~= 0 then
62
70
error("failed to implement interface: " .. rs.stderr)
63
71
end
+10
-21
lua/gopher/init.lua
+10
-21
lua/gopher/init.lua
···
13
13
local log = require "gopher._utils.log"
14
14
local tags = require "gopher.struct_tags"
15
15
local tests = require "gopher.gotests"
16
-
local gocmd = require("gopher._utils.gocmd").run
16
+
local go = require "gopher.go"
17
17
local gopher = {}
18
18
19
19
---@toc_entry Setup
···
35
35
36
36
---@toc_entry Install dependencies
37
37
---@tag gopher.nvim-dependencies
38
-
---@text Gopher.nvim implements most of its features using third-party tools.
39
-
--- To install these tools, you can run `:GoInstallDeps` command
40
-
--- or call `require("gopher").install_deps()` if you want to use lua api.
41
-
--- By default dependencies will be installed asynchronously,
42
-
--- to install them synchronously pass `{sync = true}` as an argument.
38
+
---@text
39
+
--- Gopher.nvim implements most of its features using third-party tools. To
40
+
--- install plugin's dependencies, you can run:
41
+
--- `:GoInstallDeps` or `:GoInstallDepsSync`
42
+
--- or use `require("gopher").install_deps()` if you prefer lua api.
43
43
gopher.install_deps = require("gopher.installer").install_deps
44
44
45
45
gopher.impl = require("gopher.impl").impl
···
58
58
all = tests.all_tests,
59
59
}
60
60
61
-
gopher.get = function(...)
62
-
gocmd("get", ...)
63
-
end
64
-
65
-
gopher.mod = function(...)
66
-
gocmd("mod", ...)
67
-
end
68
-
69
-
gopher.generate = function(...)
70
-
gocmd("generate", ...)
71
-
end
72
-
73
-
gopher.work = function(...)
74
-
gocmd("work", ...)
75
-
end
61
+
gopher.get = go.get
62
+
gopher.mod = go.mod
63
+
gopher.work = go.work
64
+
gopher.generate = go.generate
76
65
77
66
return gopher
+13
-4
lua/gopher/installer.lua
+13
-4
lua/gopher/installer.lua
···
1
-
local c = require("gopher.config").commands
1
+
local c = require "gopher.config"
2
2
local r = require "gopher._utils.runner"
3
3
local u = require "gopher._utils"
4
4
local log = require "gopher._utils.log"
···
9
9
impl = "github.com/josharian/impl@latest",
10
10
gotests = "github.com/cweill/gotests/...@develop",
11
11
iferr = "github.com/koron/iferr@latest",
12
+
json2go = "olexsmir.xyz/json2go/cmd/json2go@latest",
12
13
}
13
14
14
15
---@param opt vim.SystemCompleted
···
30
31
31
32
---@param url string
32
33
local function install(url)
33
-
r.async({ c.go, "install", url }, function(opt)
34
+
vim.schedule(function()
35
+
u.notify("go install-ing: " .. url)
36
+
end)
37
+
38
+
r.async({ c.commands.go, "install", url }, function(opt)
34
39
handle_intall_exit(opt, url)
35
-
end)
40
+
end, { timeout = c.installer_timeout })
36
41
end
37
42
38
43
---@param url string
39
44
local function install_sync(url)
40
-
local rs = r.sync { c.go, "install", url }
45
+
vim.schedule(function()
46
+
u.notify("go install-ing: " .. url)
47
+
end)
48
+
49
+
local rs = r.sync({ c.commands.go, "install", url }, { timeout = c.installer_timeout })
41
50
handle_intall_exit(rs, url)
42
51
end
43
52
+137
lua/gopher/json2go.lua
+137
lua/gopher/json2go.lua
···
1
+
---@toc_entry json2go
2
+
---@tag gopher.nvim-json2go
3
+
---@text
4
+
--- Convert json to go type annotations.
5
+
---
6
+
---@usage
7
+
--- `:GoJson` opens a temporary buffer where you can paste or write JSON.
8
+
--- Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
9
+
--- generated Go struct into the original buffer at the cursor position.
10
+
---
11
+
--- Alternatively, you can pass JSON directly as an argument:
12
+
--- >vim
13
+
--- :GoJson {"name": "Alice", "age": 30}
14
+
--- <
15
+
16
+
local c = require "gopher.config"
17
+
local log = require "gopher._utils.log"
18
+
local u = require "gopher._utils"
19
+
local r = require "gopher._utils.runner"
20
+
local json2go = {}
21
+
22
+
---@dochide
23
+
---@param bufnr integer
24
+
---@param cpos integer
25
+
---@param type_ string
26
+
local function apply(bufnr, cpos, type_)
27
+
local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
28
+
local input_lines = u.remove_empty_lines(vim.split(type_, "\n"))
29
+
for i, line in pairs(input_lines) do
30
+
table.insert(lines, cpos + i, line)
31
+
end
32
+
vim.api.nvim_buf_set_lines(bufnr, 0, -1, true, lines)
33
+
end
34
+
35
+
-- Convert json string to go type.
36
+
---
37
+
---@param json_str string Json string that is going to be converted to go type.
38
+
---@return string? Go type, or nil if failed.
39
+
function json2go.transform(json_str)
40
+
local cmd = { c.commands.json2go }
41
+
if c.json2go.type_name then
42
+
table.insert(cmd, "-type", c.json2go.type_name)
43
+
end
44
+
45
+
local rs = r.sync(cmd, { stdin = json_str })
46
+
if rs.code ~= 0 then
47
+
u.notify("json2go: got this error: " .. rs.stdout, vim.log.levels.ERROR)
48
+
log.error("json2go: got this error: " .. rs.stdout)
49
+
return
50
+
end
51
+
return rs.stdout
52
+
end
53
+
54
+
---@dochide
55
+
---@param ocpos integer
56
+
local function interactive(ocpos)
57
+
local obuf = vim.api.nvim_get_current_buf()
58
+
local owin = vim.api.nvim_get_current_win()
59
+
60
+
-- setup the input window
61
+
local buf = vim.api.nvim_create_buf(false, true)
62
+
vim.cmd(c.json2go.interactive_cmd)
63
+
64
+
local win = vim.api.nvim_get_current_win()
65
+
vim.api.nvim_win_set_buf(win, buf)
66
+
vim.api.nvim_buf_set_name(buf, "[GoJson input]")
67
+
vim.api.nvim_set_option_value("filetype", "jsonc", { buf = buf })
68
+
vim.api.nvim_set_option_value("buftype", "acwrite", { buf = buf })
69
+
vim.api.nvim_set_option_value("swapfile", false, { buf = buf })
70
+
vim.api.nvim_set_option_value("bufhidden", "delete", { buf = buf })
71
+
vim.api.nvim_buf_set_lines(buf, 0, -1, false, {
72
+
"// Write your json here.",
73
+
"// Writing and quitting (:wq), will generate go struct under the cursor.",
74
+
"",
75
+
"",
76
+
})
77
+
78
+
vim.api.nvim_create_autocmd("BufLeave", { buffer = buf, command = "stopinsert" })
79
+
vim.api.nvim_create_autocmd("BufWriteCmd", {
80
+
buffer = buf,
81
+
once = true,
82
+
callback = function()
83
+
local input = vim.api.nvim_buf_get_lines(buf, 0, -1, true)
84
+
local inp = table.concat(
85
+
vim
86
+
.iter(input)
87
+
:filter(function(line)
88
+
local found = string.find(line, "^//.*")
89
+
return (not found) or (line == "")
90
+
end)
91
+
:totable(),
92
+
"\n"
93
+
)
94
+
95
+
local go_type = json2go.transform(inp)
96
+
if not go_type then
97
+
error "cound't convert json to go type"
98
+
end
99
+
100
+
vim.api.nvim_set_option_value("modified", false, { buf = buf })
101
+
apply(obuf, ocpos, go_type)
102
+
103
+
vim.api.nvim_set_current_win(owin)
104
+
vim.api.nvim_win_set_cursor(owin, { ocpos + 1, 0 })
105
+
106
+
vim.schedule(function()
107
+
pcall(vim.api.nvim_win_close, win, true)
108
+
pcall(vim.api.nvim_buf_delete, buf, {})
109
+
end)
110
+
end,
111
+
})
112
+
113
+
vim.cmd "normal! G"
114
+
vim.cmd "startinsert"
115
+
end
116
+
117
+
--- Converts json string to go type, and puts result under the cursor. If
118
+
--- [json_str] is nil, will open an interactive prompt (with cmd set in
119
+
--- config).
120
+
---
121
+
---@param json_str? string
122
+
function json2go.json2go(json_str)
123
+
local cur_line = vim.api.nvim_win_get_cursor(0)[1]
124
+
if not json_str then
125
+
interactive(cur_line)
126
+
return
127
+
end
128
+
129
+
local go_type = json2go.transform(json_str)
130
+
if not go_type then
131
+
error "cound't convert json to go type"
132
+
end
133
+
134
+
apply(0, cur_line, go_type)
135
+
end
136
+
137
+
return json2go
-40
nvim.toml
-40
nvim.toml
···
3
3
4
4
[MiniTest]
5
5
any = true
6
-
7
-
[describe]
8
-
any = true
9
-
[[describe.args]]
10
-
type = "string"
11
-
[[describe.args]]
12
-
type = "function"
13
-
14
-
[it]
15
-
any = true
16
-
[[it.args]]
17
-
type = "string"
18
-
[[it.args]]
19
-
type = "function"
20
-
21
-
[before_each]
22
-
any = true
23
-
[[before_each.args]]
24
-
type = "function"
25
-
[[after_each.args]]
26
-
type = "function"
27
-
28
-
[assert]
29
-
any = true
30
-
31
-
[assert.is_not]
32
-
any = true
33
-
34
-
[[assert.equals.args]]
35
-
type = "any"
36
-
[[assert.equals.args]]
37
-
type = "any"
38
-
[[assert.equals.args]]
39
-
type = "any"
40
-
required = false
41
-
42
-
[[assert.same.args]]
43
-
type = "any"
44
-
[[assert.same.args]]
45
-
type = "any"
+29
-9
plugin/gopher.lua
+29
-9
plugin/gopher.lua
···
11
11
---@param name string
12
12
---@param fn fun(args: table)
13
13
---@param nargs? number|"*"|"?"
14
+
---@param range? boolean
14
15
---@private
15
-
local function cmd(name, fn, nargs)
16
-
nargs = nargs or 0
17
-
vim.api.nvim_create_user_command(name, fn, { nargs = nargs })
16
+
local function cmd(name, fn, nargs, range)
17
+
vim.api.nvim_create_user_command(name, fn, {
18
+
nargs = nargs or 0,
19
+
range = range or false,
20
+
})
18
21
end
19
22
20
23
cmd("GopherLog", function()
···
44
47
45
48
-- :GoTag
46
49
cmd("GoTagAdd", function(opts)
47
-
require("gopher").tags.add(unpack(opts.fargs))
48
-
end, "*")
50
+
require("gopher").tags.add {
51
+
input = opts.fargs,
52
+
range = (opts.count ~= -1) and {
53
+
start = opts.line1,
54
+
end_ = opts.line2,
55
+
} or nil,
56
+
}
57
+
end, "*", true)
49
58
50
59
cmd("GoTagRm", function(opts)
51
-
require("gopher").tags.rm(unpack(opts.fargs))
52
-
end, "*")
60
+
require("gopher").tags.rm {
61
+
input = opts.fargs,
62
+
range = (opts.count ~= -1) and {
63
+
start = opts.line1,
64
+
end_ = opts.line2,
65
+
} or nil,
66
+
}
67
+
end, "*", true)
53
68
54
69
cmd("GoTagClear", function()
55
70
require("gopher").tags.clear()
56
71
end)
57
72
73
+
-- :GoJson
74
+
cmd("GoJson", function(opts)
75
+
local inp = ((opts.args ~= "" and opts.args) or nil)
76
+
require("gopher.json2go").json2go(inp)
77
+
end, "*")
78
+
58
79
-- :GoTest
59
80
cmd("GoTestAdd", function()
60
81
require("gopher").test.add()
···
74
95
end, "*")
75
96
76
97
cmd("GoGet", function(opts)
77
-
vim.print(opts)
78
98
require("gopher").get(opts.fargs)
79
99
end, "*")
80
100
···
83
103
end, "*")
84
104
85
105
cmd("GoGenerate", function(opts)
86
-
require("gopher").generate(opts.fargs or "")
106
+
require("gopher").generate(opts.fargs or { "" })
87
107
end, "?")
+1
scripts/docgen.lua
+1
scripts/docgen.lua
+10
-1
scripts/minimal_init.lua
+10
-1
scripts/minimal_init.lua
···
20
20
end
21
21
end
22
22
23
-
install_plug "nvim-lua/plenary.nvim"
24
23
install_plug "nvim-treesitter/nvim-treesitter"
25
24
install_plug "echasnovski/mini.doc" -- used for docs generation
25
+
install_plug "folke/tokyonight.nvim" -- theme for generating demos
26
26
install_plug "echasnovski/mini.test"
27
27
28
28
vim.env.XDG_CONFIG_HOME = root ".tests/config"
···
32
32
33
33
vim.opt.runtimepath:append(root())
34
34
vim.opt.packpath:append(root ".tests/site")
35
+
vim.o.swapfile = false
36
+
vim.o.writebackup = false
35
37
vim.notify = vim.print
36
38
37
39
-- install go treesitter parse
···
51
53
end,
52
54
},
53
55
}
56
+
end
57
+
58
+
-- set colorscheme only when running ui
59
+
if #vim.api.nvim_list_uis() == 1 then
60
+
vim.cmd.colorscheme "tokyonight-night"
61
+
vim.o.cursorline = true
62
+
vim.o.number = true
54
63
end
55
64
56
65
-- needed for tests, i dont know the reason why, but on start
+6
spec/fixtures/comment/interface_many_method_input.go
+6
spec/fixtures/comment/interface_many_method_input.go
+7
spec/fixtures/comment/interface_many_method_output.go
+7
spec/fixtures/comment/interface_many_method_output.go
+5
spec/fixtures/comment/interface_method_input.go
+5
spec/fixtures/comment/interface_method_input.go
+6
spec/fixtures/comment/interface_method_output.go
+6
spec/fixtures/comment/interface_method_output.go
+18
spec/fixtures/comment/many_structs_fields_input.go
+18
spec/fixtures/comment/many_structs_fields_input.go
+19
spec/fixtures/comment/many_structs_fields_output.go
+19
spec/fixtures/comment/many_structs_fields_output.go
+7
spec/fixtures/comment/struct_fields_input.go
+7
spec/fixtures/comment/struct_fields_input.go
+8
spec/fixtures/comment/struct_fields_output.go
+8
spec/fixtures/comment/struct_fields_output.go
+5
spec/fixtures/comment/svar_input.go
+5
spec/fixtures/comment/svar_input.go
+6
spec/fixtures/comment/svar_output.go
+6
spec/fixtures/comment/svar_output.go
+5
spec/fixtures/comment/var_input.go
+5
spec/fixtures/comment/var_input.go
+6
spec/fixtures/comment/var_output.go
+6
spec/fixtures/comment/var_output.go
+8
spec/fixtures/comment/var_struct_fields_input.go
+8
spec/fixtures/comment/var_struct_fields_input.go
+9
spec/fixtures/comment/var_struct_fields_output.go
+9
spec/fixtures/comment/var_struct_fields_output.go
+5
spec/fixtures/json2go/interativly_output.go
+5
spec/fixtures/json2go/interativly_output.go
+7
spec/fixtures/json2go/manual_output.go
+7
spec/fixtures/json2go/manual_output.go
+35
-7
spec/integration/comment_test.lua
+35
-7
spec/integration/comment_test.lua
···
1
1
local t = require "spec.testutils"
2
-
local child, T = t.setup "comment"
2
+
local child, T, comment = t.setup "comment"
3
3
4
4
local function do_the_test(fixture, pos)
5
5
local rs = t.setup_test("comment/" .. fixture, child, pos)
···
10
10
t.cleanup(rs)
11
11
end
12
12
13
-
T["comment"]["should add comment to package"] = function()
13
+
comment["should add comment to package"] = function()
14
14
do_the_test("package", { 1, 1 })
15
15
end
16
16
17
-
T["comment"]["should add comment to struct"] = function()
17
+
comment["should add comment to struct"] = function()
18
18
do_the_test("struct", { 4, 1 })
19
19
end
20
20
21
-
T["comment"]["should add comment to function"] = function()
21
+
comment["should add a comment on struct field"] = function()
22
+
do_the_test("struct_fields", { 5, 8 })
23
+
end
24
+
25
+
comment["should add a comment on var struct field"] = function()
26
+
do_the_test("var_struct_fields", { 6, 4 })
27
+
end
28
+
29
+
comment["should add a comment on one field of many structs"] = function()
30
+
do_the_test("many_structs_fields", { 10, 4 })
31
+
end
32
+
33
+
comment["should add comment to function"] = function()
22
34
do_the_test("func", { 3, 1 })
23
35
end
24
36
25
-
T["comment"]["should add comment to method"] = function()
37
+
comment["should add comment to method"] = function()
26
38
do_the_test("method", { 5, 1 })
27
39
end
28
40
29
-
T["comment"]["should add comment to interface"] = function()
41
+
comment["should add comment to interface"] = function()
30
42
do_the_test("interface", { 3, 6 })
31
43
end
32
44
33
-
T["comment"]["otherwise should add // above cursor"] = function()
45
+
comment["should add comment on interface method"] = function()
46
+
do_the_test("interface_method", { 4, 2 })
47
+
end
48
+
49
+
comment["should add a comment on interface with many method"] = function()
50
+
do_the_test("interface_many_method", { 5, 2 })
51
+
end
52
+
53
+
comment["should add a comment on a var"] = function()
54
+
do_the_test("var", { 4, 2 })
55
+
end
56
+
57
+
comment["should add a comment on a short declared var"] = function()
58
+
do_the_test("svar", { 4, 8 })
59
+
end
60
+
61
+
comment["otherwise should add // above cursor"] = function()
34
62
do_the_test("empty", { 1, 1 })
35
63
end
36
64
+3
-3
spec/integration/gotests_test.lua
+3
-3
spec/integration/gotests_test.lua
···
1
1
local t = require "spec.testutils"
2
-
local child, T = t.setup "gotests"
2
+
local child, T, gotests = t.setup "gotests"
3
3
4
4
--- NOTE: :GoTestAdd is the only place that has actual logic
5
5
--- All other parts are handled `gotests` itself.
···
10
10
return t.readfile(fpath:gsub(".go", "_test.go"))
11
11
end
12
12
13
-
T["gotests"]["should add test for function under cursor"] = function()
13
+
gotests["should add test for function under cursor"] = function()
14
14
local rs = t.setup_test("tests/function", child, { 3, 5 })
15
15
child.cmd "GoTestAdd"
16
16
···
18
18
t.cleanup(rs)
19
19
end
20
20
21
-
T["gotests"]["should add test for method under cursor"] = function()
21
+
gotests["should add test for method under cursor"] = function()
22
22
local rs = t.setup_test("tests/method", child, { 5, 19 })
23
23
child.cmd "GoTestAdd"
24
24
+5
-4
spec/integration/iferr_test.lua
+5
-4
spec/integration/iferr_test.lua
···
1
1
local t = require "spec.testutils"
2
-
local child, T = t.setup "iferr"
2
+
local child, T, iferr = t.setup "iferr"
3
3
4
-
T["iferr"]["should add if != nil {"] = function()
4
+
iferr["should add if != nil {"] = function()
5
5
local rs = t.setup_test("iferr/iferr", child, { 8, 2 })
6
6
child.cmd "GoIfErr"
7
7
child.cmd "write"
···
10
10
t.cleanup(rs)
11
11
end
12
12
13
-
T["iferr"]["should add if err with custom message"] = function()
13
+
iferr["should add if err with custom message"] = function()
14
14
child.lua [[
15
15
require("gopher").setup {
16
16
iferr = { message = 'fmt.Errorf("failed to %w", err)' }
17
-
} ]]
17
+
}
18
+
]]
18
19
19
20
local rs = t.setup_test("iferr/message", child, { 6, 2 })
20
21
child.cmd "GoIfErr"
+4
-4
spec/integration/impl_test.lua
+4
-4
spec/integration/impl_test.lua
···
1
1
local t = require "spec.testutils"
2
-
local child, T = t.setup "impl"
2
+
local child, T, impl = t.setup "impl"
3
3
4
-
T["impl"]["should do impl with 'w io.Writer'"] = function()
4
+
impl["should do impl with 'w io.Writer'"] = function()
5
5
local rs = t.setup_test("impl/writer", child, { 3, 0 })
6
6
child.cmd "GoImpl w io.Writer"
7
7
child.cmd "write"
···
12
12
t.cleanup(rs)
13
13
end
14
14
15
-
T["impl"]["should work with full input, 'r Read io.Reader'"] = function()
15
+
impl["should work with full input, 'r Read io.Reader'"] = function()
16
16
local rs = t.setup_test("impl/reader", child)
17
17
child.cmd "GoImpl r Read io.Reader"
18
18
child.cmd "write"
···
22
22
t.cleanup(rs)
23
23
end
24
24
25
-
T["impl"]["should work with minimal input 'io.Closer'"] = function()
25
+
impl["should work with minimal input 'io.Closer'"] = function()
26
26
local rs = t.setup_test("impl/closer", child, { 3, 6 })
27
27
child.cmd "GoImpl io.Closer"
28
28
child.cmd "write"
+25
spec/integration/json2go_test.lua
+25
spec/integration/json2go_test.lua
···
1
+
local t = require "spec.testutils"
2
+
local child, T, json2go = t.setup "json2go"
3
+
4
+
json2go["should convert interativly"] = function()
5
+
local rs = t.setup_test("json2go/interativly", child, { 2, 0 })
6
+
child.cmd "GoJson"
7
+
child.type_keys [[{"json": true}]]
8
+
child.type_keys "<Esc>"
9
+
child.cmd "wq" -- quit prompt
10
+
child.cmd "write" -- the fixture file
11
+
12
+
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
13
+
t.cleanup(rs)
14
+
end
15
+
16
+
json2go["should convert argument"] = function()
17
+
local rs = t.setup_test("json2go/manual", child, { 2, 0 })
18
+
child.cmd [[GoJson {"user": {"name": "user-ovic"}}]]
19
+
child.cmd "write"
20
+
21
+
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
22
+
t.cleanup(rs)
23
+
end
24
+
25
+
return T
+11
-5
spec/testutils.lua
+11
-5
spec/testutils.lua
···
6
6
testutils.mininit_path = vim.fs.joinpath(base_dir, "scripts", "minimal_init.lua")
7
7
testutils.fixtures_dir = vim.fs.joinpath(base_dir, "spec/fixtures")
8
8
9
-
---@param name string
10
-
---@return MiniTest.child, table
11
-
function testutils.setup(name)
9
+
---@param mod string Module name for which to create a nested test set.
10
+
---@return MiniTest.child child nvim client.
11
+
---@return table T root test set created by `MiniTest.new_set()`.
12
+
---@return table mod_name nested set of tests in `T[mod]`.
13
+
function testutils.setup(mod)
12
14
local child = MiniTest.new_child_neovim()
13
15
local T = MiniTest.new_set {
14
16
hooks = {
···
19
21
},
20
22
}
21
23
22
-
T[name] = MiniTest.new_set {}
23
-
return child, T
24
+
T[mod] = MiniTest.new_set {}
25
+
return child, T, T[mod]
24
26
end
25
27
26
28
---@generic T
···
76
78
---@param pos? number[]
77
79
---@return gopher.TestUtilsSetup
78
80
function testutils.setup_test(fixture, child, pos)
81
+
vim.validate("pos", pos, "table", true)
82
+
79
83
local tmp = testutils.tmpfile()
80
84
local fixtures = testutils.get_fixtures(fixture)
81
85
···
84
88
85
89
local bufnr = child.fn.bufnr(tmp)
86
90
if pos then
91
+
assert(#pos == 2, "invalid cursor position")
92
+
87
93
child.fn.setpos(".", { bufnr, unpack(pos) })
88
94
end
89
95
+25
spec/unit/config_test.lua
+25
spec/unit/config_test.lua
···
1
+
local t = require "spec.testutils"
2
+
local _, T, config = t.setup "config"
3
+
4
+
config["can be called without any arguments passed"] = function()
5
+
---@diagnostic disable-next-line: missing-parameter
6
+
require("gopher").setup()
7
+
end
8
+
9
+
config["can be called with empty table"] = function()
10
+
---@diagnostic disable-next-line: missing-fields
11
+
require("gopher").setup {}
12
+
end
13
+
14
+
config["should change option"] = function()
15
+
local log_level = 1234567890
16
+
17
+
---@diagnostic disable-next-line: missing-fields
18
+
require("gopher").setup {
19
+
log_level = log_level,
20
+
}
21
+
22
+
t.eq(log_level, require("gopher.config").log_level)
23
+
end
24
+
25
+
return T
+68
spec/unit/struct_tag_test.lua
+68
spec/unit/struct_tag_test.lua
···
1
+
local t = require "spec.testutils"
2
+
local _, T, st = t.setup "struct_tags"
3
+
4
+
st["should parse tags"] = function()
5
+
local out = require("gopher.struct_tags").parse_args { "json", "yaml", "etc" }
6
+
7
+
t.eq(out.tags, "json,yaml,etc")
8
+
t.eq(out.options, "")
9
+
end
10
+
11
+
st["should parse tags separated by commas"] = function()
12
+
local out = require("gopher.struct_tags").parse_args { "json,yaml,etc" }
13
+
14
+
t.eq(out.tags, "json,yaml,etc")
15
+
t.eq(out.options, "")
16
+
end
17
+
18
+
st["should parse tags separated by command and spaces"] = function()
19
+
local out = require("gopher.struct_tags").parse_args {
20
+
"json,yaml",
21
+
"json=omitempty",
22
+
"xml=something",
23
+
}
24
+
25
+
t.eq(out.tags, "json,yaml,xml")
26
+
t.eq(out.options, "json=omitempty,xml=something")
27
+
end
28
+
29
+
st["should parse tag with an option"] = function()
30
+
local out = require("gopher.struct_tags").parse_args {
31
+
"json=omitempty",
32
+
"xml",
33
+
"xml=theoption",
34
+
}
35
+
36
+
t.eq(out.tags, "json,xml")
37
+
t.eq(out.options, "json=omitempty,xml=theoption")
38
+
end
39
+
40
+
st["should parse tags with an option"] = function()
41
+
local out = require("gopher.struct_tags").parse_args { "json=omitempty", "yaml" }
42
+
43
+
t.eq(out.tags, "json,yaml")
44
+
t.eq(out.options, "json=omitempty")
45
+
end
46
+
47
+
st["should parse tags with an option separated with comma"] = function()
48
+
local out = require("gopher.struct_tags").parse_args { "json=omitempty,yaml" }
49
+
50
+
t.eq(out.tags, "json,yaml")
51
+
t.eq(out.options, "json=omitempty")
52
+
end
53
+
54
+
st["should parse tags with options specified separately"] = function()
55
+
local out = require("gopher.struct_tags").parse_args { "json", "yaml", "json=omitempty" }
56
+
57
+
t.eq(out.tags, "json,yaml")
58
+
t.eq(out.options, "json=omitempty")
59
+
end
60
+
61
+
st["should parse tags with options specified separately and separated by comma"] = function()
62
+
local out = require("gopher.struct_tags").parse_args { "json,yaml,json=omitempty" }
63
+
64
+
t.eq(out.tags, "json,yaml")
65
+
t.eq(out.options, "json=omitempty")
66
+
end
67
+
68
+
return T
+38
-4
spec/unit/utils_test.lua
+38
-4
spec/unit/utils_test.lua
···
1
1
local t = require "spec.testutils"
2
-
local _, T = t.setup "utils"
2
+
local _, T, utils = t.setup "utils"
3
3
4
-
T["utils"]["should .remove_empty_lines()"] = function()
4
+
utils["should .remove_empty_lines()"] = function()
5
5
local u = require "gopher._utils"
6
6
local inp = { "hi", "", "a", "", "", "asdf" }
7
7
8
8
t.eq(u.remove_empty_lines(inp), { "hi", "a", "asdf" })
9
9
end
10
10
11
-
T["utils"]["should .readfile_joined()"] = function()
11
+
utils["should .readfile_joined()"] = function()
12
12
local data = "line1\nline2\nline3"
13
13
local tmp = t.tmpfile()
14
14
local u = require "gopher._utils"
···
17
17
t.eq(u.readfile_joined(tmp), data)
18
18
end
19
19
20
-
T["utils"]["should .trimend()"] = function()
20
+
utils["should .trimend()"] = function()
21
21
local u = require "gopher._utils"
22
22
t.eq(u.trimend " hi ", " hi")
23
+
end
24
+
25
+
utils["should add .indent() spaces"] = function()
26
+
local u = require "gopher._utils"
27
+
local line = " func Test() error {"
28
+
local indent = 4
29
+
30
+
t.eq(" ", u.indent(line, indent))
31
+
end
32
+
33
+
utils["should add .indent() a tab"] = function()
34
+
local u = require "gopher._utils"
35
+
local line = "\tfunc Test() error {"
36
+
local indent = 1
37
+
38
+
t.eq("\t", u.indent(line, indent))
39
+
end
40
+
41
+
utils["should add .indent() 2 tabs"] = function()
42
+
local u = require "gopher._utils"
43
+
local line = "\t\tfunc Test() error {"
44
+
local indent = 2
45
+
46
+
t.eq("\t\t", u.indent(line, indent))
47
+
end
48
+
49
+
utils["should .list_unique on list with duplicates"] = function()
50
+
local u = require "gopher._utils"
51
+
t.eq({ "json", "xml" }, u.list_unique { "json", "xml", "json" })
52
+
end
53
+
54
+
utils["should .list_unique on list with no duplicates"] = function()
55
+
local u = require "gopher._utils"
56
+
t.eq({ "json", "xml" }, u.list_unique { "json", "xml" })
23
57
end
24
58
25
59
return T
+23
vhs/Taskfile.yml
+23
vhs/Taskfile.yml
···
1
+
version: "3"
2
+
tasks:
3
+
generate:
4
+
deps:
5
+
- comment
6
+
- iferr
7
+
- tags
8
+
- impl
9
+
10
+
comment:
11
+
cmd: vhs comment.tape
12
+
13
+
iferr:
14
+
cmd: vhs iferr.tape
15
+
16
+
tags:
17
+
cmd: vhs tags.tape
18
+
19
+
impl:
20
+
cmd: vhs impl.tape
21
+
22
+
json2go:
23
+
cmd: vhs json2go.tape
vhs/comment.gif
vhs/comment.gif
This is a binary file and will not be displayed.
+7
vhs/comment.go
+7
vhs/comment.go
+29
vhs/comment.tape
+29
vhs/comment.tape
···
1
+
Output comment.gif
2
+
Require nvim
3
+
4
+
Set FontFamily "JetBrains Mono"
5
+
Set Height 800
6
+
Set Width 1500
7
+
Set Padding 20
8
+
Set Shell "bash"
9
+
Set Theme "tokyonight"
10
+
Set TypingSpeed 250ms
11
+
12
+
Hide Type@0ms "./nvim.sh comment.go" Enter Show
13
+
14
+
# package
15
+
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
16
+
17
+
# func
18
+
Type@400ms "jjj"
19
+
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
20
+
21
+
# struct
22
+
Type@400ms "jjj"
23
+
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
24
+
25
+
# interface
26
+
Type@400ms "jjj"
27
+
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
28
+
29
+
Sleep 5s
vhs/iferr.gif
vhs/iferr.gif
This is a binary file and will not be displayed.
+11
vhs/iferr.go
+11
vhs/iferr.go
+18
vhs/iferr.tape
+18
vhs/iferr.tape
···
1
+
Output iferr.gif
2
+
Require nvim
3
+
Require iferr
4
+
5
+
Set FontFamily "JetBrains Mono"
6
+
Set Height 800
7
+
Set Width 1500
8
+
Set Padding 20
9
+
Set Shell "bash"
10
+
Set Theme "tokyonight"
11
+
Set TypingSpeed 250ms
12
+
13
+
Hide Type@0ms "./nvim.sh iferr.go" Enter Show
14
+
15
+
Type "3j"
16
+
Type ":GoIfErr" Sleep 500ms Enter
17
+
18
+
Sleep 5s
vhs/impl.gif
vhs/impl.gif
This is a binary file and will not be displayed.
+18
vhs/impl.tape
+18
vhs/impl.tape
···
1
+
Output impl.gif
2
+
Require nvim
3
+
Require impl
4
+
5
+
Set FontFamily "JetBrains Mono"
6
+
Set Height 800
7
+
Set Width 1500
8
+
Set Padding 20
9
+
Set Shell "bash"
10
+
Set Theme "tokyonight"
11
+
Set TypingSpeed 250ms
12
+
13
+
Hide Type@0ms "./nvim.sh impl.go" Enter Show
14
+
15
+
Type "2j"
16
+
Type ":GoImpl c io.Reader" Sleep 700ms Enter
17
+
18
+
Sleep 5s
vhs/json2go.gif
vhs/json2go.gif
This is a binary file and will not be displayed.
+27
vhs/json2go.tape
+27
vhs/json2go.tape
···
1
+
Output json2go.gif
2
+
Require nvim
3
+
Require json2go
4
+
5
+
Set FontFamily "JetBrains Mono"
6
+
Set Height 800
7
+
Set Width 1500
8
+
Set Padding 20
9
+
Set Shell "bash"
10
+
Set Theme "tokyonight"
11
+
Set TypingSpeed 250ms
12
+
13
+
Hide Type@0ms "./nvim.sh json2go.go" Enter Show
14
+
15
+
Type@0ms "G"
16
+
Type@400ms ":GoJson" Sleep 500ms Enter
17
+
Type@70ms "{" Enter
18
+
Type@70ms `"json": true,` Enter
19
+
Type@70ms `"user": {"name": "Name", "of_age": true}` Enter
20
+
Type@70ms "}"
21
+
Escape Type@500ms ":wq" Enter
22
+
Sleep 1s
23
+
24
+
Type@25ms "G2o" Escape
25
+
Type@120ms `:GoJson {"json": true}` Enter
26
+
27
+
Sleep 5s