[mirror] Make your go dev experience better
github.com/olexsmir/gopher.nvim
neovim
golang
feat(strct-tags): add support for tag options (#126)
* feat(struct_tags): add options support
* refactor(struct-tags): give input field better name
* feat(struct-tag): add default option
* refactor: make it work on neovim version below 0.12
* chore(struct-tags): update the demo
* refactor: unite struct_tags util with main logic
+300
-14
+5
README.md
+5
README.md
···
72
72
" add json tag
73
73
:GoTagAdd json
74
74
75
+
" add json tag with omitempty option
76
+
:GoTagAdd json=omitempty
77
+
75
78
" remove yaml tag
76
79
:GoTagRm yaml
77
80
```
···
233
236
transform = "snakecase",
234
237
-- default tags to add to struct fields
235
238
default_tag = "json",
239
+
-- default tag option added struct fields, set to nil to disable
240
+
option = nil,
236
241
},
237
242
iferr = {
238
243
-- choose a custom error message
+7
doc/gopher.nvim.txt
+7
doc/gopher.nvim.txt
···
89
89
90
90
-- default tags to add to struct fields
91
91
default_tag = "json",
92
+
93
+
-- default tag option added struct fields, set to nil to disable
94
+
---@type string|nil
95
+
option = nil,
92
96
},
93
97
iferr = {
94
98
-- choose a custom error message
···
123
127
1. Place cursor on the struct
124
128
2. Run `:GoTagAdd json` to add json tags to struct fields
125
129
3. Run `:GoTagRm json` to remove json tags to struct fields
130
+
131
+
If you want to add/remove tag with options, you can use `json=omitempty` (where json is tag, and omitempty is its option).
132
+
Example: `:GoTagAdd xml json=omitempty`
126
133
127
134
To clear all tags from struct run: `:GoTagClear`
128
135
+19
lua/gopher/_utils/init.lua
+19
lua/gopher/_utils/init.lua
···
50
50
return string.rep(char, indent)
51
51
end
52
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
70
+
end
71
+
53
72
return utils
+5
lua/gopher/config.lua
+5
lua/gopher/config.lua
···
61
61
62
62
-- default tags to add to struct fields
63
63
default_tag = "json",
64
+
65
+
-- default tag option added struct fields, set to nil to disable
66
+
---@type string|nil
67
+
option = nil,
64
68
},
65
69
iferr = {
66
70
-- choose a custom error message
···
105
109
vim.validate("gotag", _config.gotag, "table")
106
110
vim.validate("gotag.transform", _config.gotag.transform, "string")
107
111
vim.validate("gotag.default_tag", _config.gotag.default_tag, "string")
112
+
vim.validate("gotag.option", _config.gotag.option, { "string", "nil" })
108
113
vim.validate("iferr", _config.iferr, "table")
109
114
vim.validate("iferr.message", _config.iferr.message, { "string", "nil" })
110
115
end
+2
-2
plugin/gopher.lua
+2
-2
plugin/gopher.lua
···
48
48
-- :GoTag
49
49
cmd("GoTagAdd", function(opts)
50
50
require("gopher").tags.add {
51
-
tags = opts.fargs,
51
+
input = opts.fargs,
52
52
range = (opts.count ~= -1) and {
53
53
start = opts.line1,
54
54
end_ = opts.line2,
···
58
58
59
59
cmd("GoTagRm", function(opts)
60
60
require("gopher").tags.rm {
61
-
tags = opts.fargs,
61
+
input = opts.fargs,
62
62
range = (opts.count ~= -1) and {
63
63
start = opts.line1,
64
64
end_ = opts.line2,
+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
+10
spec/unit/utils_test.lua
+10
spec/unit/utils_test.lua
···
46
46
t.eq("\t\t", u.indent(line, indent))
47
47
end
48
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" })
57
+
end
58
+
49
59
return T