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

Compare commits

base: olexsmir:main
Branches Tags
olexsmir:main
olexsmir:v0.5.0
olexsmir:v0.4.0
olexsmir:v0.3.0
olexsmir:v0.2.4
olexsmir:v0.2.3
olexsmir:v0.2.2
olexsmir:v0.2.1
olexsmir:v0.2.0
olexsmir:v0.1.5
olexsmir:v0.1.4
olexsmir:v0.1.3
olexsmir:v0.1.2
olexsmir:v0.1.1
olexsmir:v0.1.0
..
compare: olexsmir:v0.3.0
Branches Tags
olexsmir:main
olexsmir:v0.5.0
olexsmir:v0.4.0
olexsmir:v0.3.0
olexsmir:v0.2.4
olexsmir:v0.2.3
olexsmir:v0.2.2
olexsmir:v0.2.1
olexsmir:v0.2.0
olexsmir:v0.1.5
olexsmir:v0.1.4
olexsmir:v0.1.3
olexsmir:v0.1.2
olexsmir:v0.1.1
olexsmir:v0.1.0

No commits in common. "main" and "v0.3.0" have entirely different histories.
main ... v0.3.0

68 changed files with 271 additions and 1116 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/tests.yml vendored
View file

@ -21,7 +21,6 @@ jobs:
- v0.11.1
- v0.11.2
- v0.11.3
- v0.11.4
runs-on: ${{ matrix.os }}
steps:
- name: Install Task

75
README.md
View file

@ -8,13 +8,6 @@ It's **NOT** an LSP tool, the goal of this plugin is to add go tooling support i
> All development of new and maybe undocumented, and unstable features is happening on [develop](https://github.com/olexsmir/gopher.nvim/tree/develop) branch.
## Table of content
* [How to install](#install-using-lazynvim)
* [Features](#features)
* [Configuration](#configuration)
* [Troubleshooting](#troubleshooting)
* [Contributing](#contributing)
## Install (using [lazy.nvim](https://github.com/folke/lazy.nvim))
Requirements:
@ -23,19 +16,14 @@ Requirements:
- Treesitter parser for `go`(`:TSInstall go` if you use [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter))
- [Go](https://github.com/golang/go) installed
> [!IMPORTANT]
> If you prefer using other forges, this repository is also mirrored at:
> - [tangled.org](https://tangled.org): [`https://tangled.org/olexsmir.xyz/gopher.nvim`](https://tangled.org/olexsmir.xyz/gopher.nvim)
> - [codeberg.org](https://codeberg.org): [`https://codeberg.org/olexsmir/gopher.nvim`](https://codeberg.org/olexsmir/gopher.nvim)
```lua
-- NOTE: this plugin is already lazy-loaded and adds only about 1ms
-- of load time to your config
-- NOTE: this plugin is already lazy-loaded, it adds only about 1ms of load
-- time to your config
{
"olexsmir/gopher.nvim",
ft = "go",
-- branch = "develop"
-- (optional) updates the plugin's dependencies on each update
-- (optional) will update plugin's deps on every update
build = function()
vim.cmd.GoInstallDeps()
end,
@ -62,7 +50,6 @@ Requirements:
- [impl](https://github.com/josharian/impl)
- [gotests](https://github.com/cweill/gotests)
- [iferr](https://github.com/koron/iferr)
- [json2go](https://github.com/olexsmir/json2go)
</details>
<details>
@ -78,9 +65,6 @@ Requirements:
" add json tag
:GoTagAdd json
" add json tag with omitempty option
:GoTagAdd json=omitempty
" remove yaml tag
:GoTagRm yaml
```
@ -186,24 +170,6 @@ Requirements:
```
</details>
<details>
<summary>
<b>Convert json to Go types</b>
</summary>
![Convert JSON to Go types](./vhs/json2go.gif)
`:GoJson` opens a temporary buffer where you can paste or write JSON.
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the generated Go struct into the original buffer at the cursor position.
Alternatively, you can pass JSON directly as an argument:
```vim
:GoJson {"name": "Alice", "age": 30}
```
Additionally, `gopher.json2go` provides lua api, see `:h gopher.nvim-json2go` for details.
</details>
<details>
<summary>
@ -235,10 +201,6 @@ require("gopher").setup {
-- timeout for running internal commands
timeout = 2000,
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
installer_timeout = 999999,
-- user specified paths to binaries
commands = {
go = "go",
gomodifytags = "gomodifytags",
@ -247,50 +209,25 @@ require("gopher").setup {
iferr = "iferr",
},
gotests = {
-- a default template that gotess will use.
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
-- 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,
-- use named tests(map with test name as key) in table tests(slice of structs by default)
-- switch table tests from using slice to map (with test name for the key)
named = false,
},
gotag = {
transform = "snakecase",
-- default tags to add to struct fields
default_tag = "json",
-- default tag option added struct fields, set to nil to disable
-- e.g: `option = "json=omitempty,xml=omitempty`
option = nil,
},
iferr = {
-- choose a custom error message, nil to use default
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
-- choose a custom error message
message = nil,
},
json2go = {
-- command used to open interactive input.
-- e.g: `split`, `botright split`, `tabnew`
interactive_cmd = "vsplit",
-- name of autogenerated struct
-- e.g: "MySuperCoolName"
type_name = nil,
},
}
```
## Troubleshooting
The most common issue with the plugin is missing dependencies.
Run `:checkhealth gopher` to verify that the plugin is installed correctly.
If any binaries are missing, install them using `:GoInstallDeps`.
If the issue persists, feel free to [open a new issue](https://github.com/olexsmir/gopher.nvim/issues/new).
## Contributing
PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)

2
Taskfile.yml
View file

@ -21,8 +21,6 @@ tasks:
-u ./scripts/minimal_init.lua \
-c "lua MiniTest.run()" \
-c ":qa!"
nvim:
cmd: nvim --clean -u "./scripts/minimal_init.lua" {{ .CLI_ARGS }}
docgen:
desc: generate vimhelp

133
doc/gopher.nvim.txt
View file

@ -13,7 +13,6 @@ Table of Contents
Config ................................................ |gopher.nvim-config|
Commands ............................................ |gopher.nvim-commands|
Modify struct tags ............................... |gopher.nvim-struct-tags|
json2go .............................................. |gopher.nvim-json2go|
Auto implementation of interface methods ................ |gopher.nvim-impl|
Generating unit tests boilerplate .................... |gopher.nvim-gotests|
Iferr .................................................. |gopher.nvim-iferr|
@ -37,11 +36,11 @@ Parameters ~
------------------------------------------------------------------------------
*gopher.nvim-dependencies*
`gopher.install_deps`
Gopher.nvim implements most of its features using third-party tools. To
install plugin's dependencies, you can run:
`:GoInstallDeps` or `:GoInstallDepsSync`
or use `require("gopher").install_deps()` if you prefer lua api.
Gopher.nvim implements most of its features using third-party tools.
To install these tools, you can run `:GoInstallDeps` command
or call `require("gopher").install_deps()` if you want to use lua api.
By default dependencies will be installed asynchronously,
to install them synchronously pass `{sync = true}` as an argument.
==============================================================================
@ -58,8 +57,7 @@ or use `require("gopher").install_deps()` if you prefer lua api.
---@type number
timeout = 2000,
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
---@type number
--- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
installer_timeout = 999999,
-- user specified paths to binaries
@ -70,19 +68,15 @@ or use `require("gopher").install_deps()` if you prefer lua api.
gotests = "gotests",
impl = "impl",
iferr = "iferr",
json2go = "json2go",
},
---@class gopher.ConfigGotests
gotests = {
-- a default template that gotess will use.
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
template = "default",
-- path to a directory containing custom test code templates
---@type string|nil
template_dir = nil,
-- use named tests(map with test name as key) in table tests(slice of structs by default)
-- switch table tests from using slice to map (with test name for the key)
named = false,
},
---@class gopher.ConfigGoTag
@ -92,36 +86,16 @@ or use `require("gopher").install_deps()` if you prefer lua api.
-- default tags to add to struct fields
default_tag = "json",
-- default tag option added struct fields, set to nil to disable
-- e.g: `option = "json=omitempty,xml=omitempty`
---@type string|nil
option = nil,
},
---@class gopher.ConfigIfErr
iferr = {
-- choose a custom error message, nil to use default
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
-- choose a custom error message
---@type string|nil
message = nil,
},
---@class gopher.ConfigJson2Go
json2go = {
-- command used to open interactive input.
-- e.g: `split`, `botright split`, `tabnew`
interactive_cmd = "vsplit",
-- name of autogenerated struct, if nil none, will the default one of json2go.
-- e.g: "MySuperCoolName"
---@type string|nil
type_name = nil,
},
}
<
Class ~
{gopher.Config}
Fields ~
{setup} `(fun(user_config?: gopher.Config))`
==============================================================================
@ -136,21 +110,16 @@ you can set `vim.g.gopher_register_commands` to `false`, before loading the plug
------------------------------------------------------------------------------
*gopher.nvim-struct-tags*
`struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to
struct fields.
`struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to struct fields.
Usage ~
How to add/remove/clear tags to struct fields:
How to add/remove tags to struct fields:
1. Place cursor on the struct
2. Run `:GoTagAdd json` to add json tags to struct fields
3. Run `:GoTagRm json` to remove json tags to struct fields
4. Run `:GoTagClear` to clear all tags from struct fields
If you want to add/remove tag with options, you can use `json=omitempty`
(where json is tag, and omitempty is its option).
Example: `:GoTagAdd xml json=omitempty`
To clear all tags from struct run: `:GoTagClear`
NOTE: if you dont specify the tag it will use `json` as default
@ -171,42 +140,6 @@ Example:
}
<
==============================================================================
------------------------------------------------------------------------------
*gopher.nvim-json2go*
Convert json to go type annotations.
Usage ~
`:GoJson` opens a temporary buffer where you can paste or write JSON.
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
generated Go struct into the original buffer at the cursor position.
Alternatively, you can pass JSON directly as an argument:
>vim
:GoJson {"name": "Alice", "age": 30}
<
------------------------------------------------------------------------------
*json2go.transform()*
`json2go.transform`({json_str})
Parameters ~
{json_str} `(string)` Json string that is going to be converted to go type.
Return ~
`(string)` `(optional)` Go type, or nil if failed.
------------------------------------------------------------------------------
*json2go.json2go()*
`json2go.json2go`({json_str})
Converts json string to go type, and puts result under the cursor. If
[json_str] is nil, will open an interactive prompt (with cmd set in
config).
Parameters ~
{json_str} `(optional)` `(string)`
==============================================================================
------------------------------------------------------------------------------
*gopher.nvim-impl*
@ -214,24 +147,23 @@ Parameters ~
Integration of `impl` tool to generate method stubs for interfaces.
Usage ~
1. Automatically implement an interface for a struct:
- Place your cursor on the struct where you want to implement the interface.
- Run `:GoImpl io.Reader`
- This will automatically determine the receiver and implement the `io.Reader` interface.
- Place your cursor on the struct where you want to implement the interface.
- Run `:GoImpl io.Reader`
- This will automatically determine the receiver and implement the `io.Reader` interface.
2. Specify a custom receiver:
- Place your cursor on the struct
- Run `:GoImpl w io.Writer`, where:
- `w` is the receiver.
- `io.Writer` is the interface to implement.
- Place your cursor on the struct
- Run `:GoImpl w io.Writer`, where:
- `w` is the receiver.
- `io.Writer` is the interface to implement.
3. Explicitly specify the receiver, struct, and interface:
- No need to place the cursor on the struct if all arguments are provided.
- Run `:GoImpl r RequestReader io.Reader`, where:
- `r` is the receiver.
- `RequestReader` is the struct.
- `io.Reader` is the interface to implement.
- No need to place the cursor on the struct if all arguments are provided.
- Run `:GoImpl r RequestReader io.Reader`, where:
- `r` is the receiver.
- `RequestReader` is the struct.
- `io.Reader` is the interface to implement.
Example:
>go
@ -252,18 +184,17 @@ gotests is utilizing the `gotests` tool to generate unit tests boilerplate.
Usage ~
- Generate unit test for specific function/method:
1. Place your cursor on the desired function/method.
2. Run `:GoTestAdd`
1. Place your cursor on the desired function/method.
2. Run `:GoTestAdd`
- Generate unit tests for *all* functions/methods in current file:
- run `:GoTestsAll`
- run `:GoTestsAll`
- Generate unit tests *only* for *exported(public)* functions/methods:
- run `:GoTestsExp`
- run `:GoTestsExp`
You can also specify the template to use for generating the tests.
See |gopher.nvim-config|.
More details about templates: https://github.com/cweill/gotests
You can also specify the template to use for generating the tests. See |gopher.nvim-config|
More details about templates can be found at: https://github.com/cweill/gotests
If you prefer named tests, you can enable them in |gopher.nvim-config|.
@ -286,9 +217,7 @@ Execute `:GoIfErr` near any `err` variable to insert the check
This module provides a way to generate comments for Go code.
Usage ~
Set cursor on line with function/method/struct/etc and
run `:GoCmt` to generate a comment.
Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment.
vim:tw=78:ts=8:noet:ft=help:norl:

51
lua/gopher/_utils/gocmd.lua Normal file
View file

@ -0,0 +1,51 @@
local r = require "gopher._utils.runner"
local c = require("gopher.config").commands
local u = require "gopher._utils"
local gocmd = {}
---@param args string[]
---@return string[]
local function if_get(args)
for i, arg in ipairs(args) do
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
table.remove(args, i)
table.insert(args, i, m)
end
return args
end
---@param args unknown[]
---@return string[]
local function if_generate(args)
if #args == 1 and args[1] == "%" then
args[1] = vim.fn.expand "%"
end
return args
end
---@param subcmd string
---@param args string[]
---@return string
function gocmd.run(subcmd, args)
if #args == 0 and subcmd ~= "generate" then
error "please provide any arguments"
end
if subcmd == "get" then
args = if_get(args)
end
if subcmd == "generate" then
args = if_generate(args)
end
local rs = r.sync { c.go, subcmd, unpack(args) }
if rs.code ~= 0 then
error("go " .. subcmd .. " failed: " .. rs.stderr)
end
u.notify(c.go .. " " .. subcmd .. " ran successful")
return rs.stdout
end
return gocmd

33
lua/gopher/_utils/init.lua
View file

@ -3,7 +3,7 @@ local log = require "gopher._utils.log"
local utils = {}
---@param msg string
---@param lvl? integer by default `vim.log.levels.INFO`
---@param lvl? number by default `vim.log.levels.INFO`
function utils.notify(msg, lvl)
lvl = lvl or vim.log.levels.INFO
vim.notify(msg, lvl, {
@ -38,35 +38,4 @@ function utils.trimend(s)
return r
end
-- Since indentation can be spaces or tabs, that's my hack around it
---@param line string
---@param indent integer
---@return string
function utils.indent(line, indent)
local char = string.sub(line, 1, 1)
if char ~= " " and char ~= "\t" then
char = " "
end
return string.rep(char, indent)
end
---@generic T
---@param tbl T[]
---@return T[]
function utils.list_unique(tbl)
if vim.fn.has "nvim-0.12" == 1 then
return vim.list.unique(tbl)
end
for i = #tbl, 1, -1 do
for j = 1, i - 1 do
if tbl[i] == tbl[j] then
table.remove(tbl, i)
break
end
end
end
return tbl
end
return utils

4
lua/gopher/_utils/log.lua
View file

@ -3,7 +3,7 @@
-- for the code i have stolen(or have inspected by idk)
local c = require "gopher.config"
---@class gopher.Logger
---@class Gopher.Logger
---@field get_outfile fun():string
---@field trace fun(...)
---@field fmt_trace fun(...)
@ -44,7 +44,7 @@ local config = {
float_precision = 0.01,
}
---@type gopher.Logger
---@type Gopher.Logger
---@diagnostic disable-next-line: missing-fields
local log = {}

56
lua/gopher/_utils/ts.lua
View file

@ -11,13 +11,9 @@ local queries = {
right: (expression_list (composite_literal
type: (struct_type))))]
]],
struct_field = [[
(field_declaration name: (field_identifier) @_name)
]],
func = [[
[(function_declaration name: (identifier) @_name)
(method_declaration name: (field_identifier) @_name)
(method_elem name: (field_identifier) @_name)]
(method_declaration name: (field_identifier) @_name)]
]],
package = [[
(package_identifier) @_name
@ -27,17 +23,12 @@ local queries = {
name: (type_identifier) @_name
type: (interface_type))
]],
var = [[
[(var_declaration (var_spec name: (identifier) @_name))
(short_var_declaration
left: (expression_list (identifier) @_name @_var))]
]],
}
---@param parent_type string[]
---@param node TSNode
---@return TSNode?
local function get_parent_node(parent_type, node)
local function get_parrent_node(parent_type, node)
---@type TSNode?
local current = node
while current do
@ -73,11 +64,10 @@ local function get_captures(query, node, bufnr)
end
---@class gopher.TsResult
---@field name string Name of the struct, function, etc
---@field start integer Line number where the declaration starts
---@field end_ integer Line number where the declaration ends
---@field indent integer Number of spaces/tabs in the current cursor line
---@field is_varstruct boolean Is struct declared as `var S struct{}` or `s := struct{}{}`
---@field name string
---@field start integer
---@field end_ integer
---@field is_varstruct boolean
---@param bufnr integer
---@param parent_type string[]
@ -88,22 +78,23 @@ local function do_stuff(bufnr, parent_type, query)
error "No treesitter parser found for go"
end
local node = vim.treesitter.get_node { bufnr = bufnr }
local node = vim.treesitter.get_node {
bufnr = bufnr,
}
if not node then
error "No nodes found under the cursor"
error "No nodes found under cursor"
end
local parent_node = get_parent_node(parent_type, node)
local parent_node = get_parrent_node(parent_type, node)
if not parent_node then
error "No parent node found under the cursor"
error "No parent node found under cursor"
end
local q = vim.treesitter.query.parse("go", query)
local res = get_captures(q, parent_node, bufnr)
assert(res.name ~= nil, "No capture name found")
local start_row, start_col, end_row, _ = parent_node:range()
res["indent"] = start_col
local start_row, _, end_row, _ = parent_node:range()
res["start"] = start_row + 1
res["end_"] = end_row + 1
@ -113,12 +104,11 @@ end
---@param bufnr integer
function ts.get_struct_under_cursor(bufnr)
--- should be both type_spec and type_declaration
--- because in cases like `type ( T struct{}, U struct{} )`
--- because in cases like `type ( T struct{}, U strict{} )`
--- i will be choosing always last struct in the list
---
--- var_declaration is for cases like `var x struct{}`
--- short_var_declaration is for cases like `x := struct{}{}`
---
--- it always chooses last struct type in the list
return do_stuff(bufnr, {
"type_spec",
"type_declaration",
@ -127,19 +117,10 @@ function ts.get_struct_under_cursor(bufnr)
}, queries.struct)
end
---@param bufnr integer
function ts.get_struct_field_under_cursor(bufnr)
return do_stuff(bufnr, { "field_declaration" }, queries.struct_field)
end
---@param bufnr integer
function ts.get_func_under_cursor(bufnr)
--- since this handles both and funcs and methods we should check for both parent nodes
return do_stuff(bufnr, {
"method_elem",
"function_declaration",
"method_declaration",
}, queries.func)
return do_stuff(bufnr, { "function_declaration", "method_declaration" }, queries.func)
end
---@param bufnr integer
@ -152,9 +133,4 @@ function ts.get_interface_under_cursor(bufnr)
return do_stuff(bufnr, { "type_declaration" }, queries.interface)
end
---@param bufnr integer
function ts.get_variable_under_cursor(bufnr)
return do_stuff(bufnr, { "var_declaration", "short_var_declaration" }, queries.var)
end
return ts

48
lua/gopher/comment.lua
View file

@ -3,46 +3,36 @@
---@text
--- This module provides a way to generate comments for Go code.
---
---@usage
--- Set cursor on line with function/method/struct/etc and
--- run `:GoCmt` to generate a comment.
---@usage Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment.
local ts = require "gopher._utils.ts"
local log = require "gopher._utils.log"
local u = require "gopher._utils"
local comment = {}
--- NOTE: The order of functions executed inside this function is IMPORTANT.
--- This function is extremely fragile; run tests after making any changes.
---
---@param bufnr integer
---@param line string
---@param name string
---@return string
---@dochide
local function generate(bufnr, line)
local sf_ok, sf_res = pcall(ts.get_struct_field_under_cursor, bufnr)
if sf_ok then
return u.indent(line, sf_res.indent) .. "// " .. sf_res.name .. " "
end
local function template(name)
return "// " .. name .. " "
end
---@param bufnr integer
---@return string
---@dochide
local function generate(bufnr)
local s_ok, s_res = pcall(ts.get_struct_under_cursor, bufnr)
if s_ok then
return u.indent(line, s_res.indent) .. "// " .. s_res.name .. " "
end
local v_ok, v_res = pcall(ts.get_variable_under_cursor, bufnr)
if v_ok then
return u.indent(line, v_res.indent) .. "// " .. v_res.name .. " "
return template(s_res.name)
end
local f_ok, f_res = pcall(ts.get_func_under_cursor, bufnr)
if f_ok then
return u.indent(line, f_res.indent) .. "// " .. f_res.name .. " "
return template(f_res.name)
end
local i_ok, i_res = pcall(ts.get_interface_under_cursor, bufnr)
if i_ok then
return u.indent(line, i_res.indent) .. "// " .. i_res.name .. " "
return template(i_res.name)
end
local p_ok, p_res = pcall(ts.get_package_under_cursor, bufnr)
@ -55,16 +45,12 @@ end
function comment.comment()
local bufnr = vim.api.nvim_get_current_buf()
local lnum = vim.fn.getcurpos()[2]
local line = vim.fn.getline(lnum)
local cmt = generate(bufnr, line)
log.debug("generated comment:", {
comment = cmt,
line = line,
})
local cmt = generate(bufnr)
log.debug("generated comment: " .. cmt)
vim.fn.append(lnum - 1, cmt)
vim.fn.setpos(".", { bufnr, lnum, #cmt })
local pos = vim.fn.getcurpos()[2]
vim.fn.append(pos - 1, cmt)
vim.fn.setpos(".", { 0, pos, #cmt })
vim.cmd "startinsert!"
end

46
lua/gopher/config.lua
View file

@ -1,6 +1,3 @@
---@type gopher.Config
---@dochide
---@diagnostic disable-next-line: missing-fields .setup() gets injected later
local config = {}
---@tag gopher.nvim-config.ConfigGoTagTransform
@ -19,7 +16,6 @@ local config = {}
---@tag gopher.nvim-config
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
---@class gopher.Config
---@field setup fun(user_config?: gopher.Config)
local default_config = {
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
---@type number
@ -29,8 +25,7 @@ local default_config = {
---@type number
timeout = 2000,
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
---@type number
--- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
installer_timeout = 999999,
-- user specified paths to binaries
@ -41,19 +36,15 @@ local default_config = {
gotests = "gotests",
impl = "impl",
iferr = "iferr",
json2go = "json2go",
},
---@class gopher.ConfigGotests
gotests = {
-- a default template that gotess will use.
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
-- gotests doesn't have template named "default" so this plugin uses "default" to set the default template
template = "default",
-- path to a directory containing custom test code templates
---@type string|nil
template_dir = nil,
-- use named tests(map with test name as key) in table tests(slice of structs by default)
-- switch table tests from using slice to map (with test name for the key)
named = false,
},
---@class gopher.ConfigGoTag
@ -63,30 +54,12 @@ local default_config = {
-- default tags to add to struct fields
default_tag = "json",
-- default tag option added struct fields, set to nil to disable
-- e.g: `option = "json=omitempty,xml=omitempty`
---@type string|nil
option = nil,
},
---@class gopher.ConfigIfErr
iferr = {
-- choose a custom error message, nil to use default
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
-- choose a custom error message
---@type string|nil
message = nil,
},
---@class gopher.ConfigJson2Go
json2go = {
-- command used to open interactive input.
-- e.g: `split`, `botright split`, `tabnew`
interactive_cmd = "vsplit",
-- name of autogenerated struct, if nil none, will the default one of json2go.
-- e.g: "MySuperCoolName"
---@type string|nil
type_name = nil,
},
}
--minidoc_afterlines_end
@ -117,19 +90,15 @@ function config.setup(user_config)
vim.validate("commands.gotests", _config.commands.gotests, "string")
vim.validate("commands.impl", _config.commands.impl, "string")
vim.validate("commands.iferr", _config.commands.iferr, "string")
vim.validate("commands.json2go", _config.commands.json2go, "string")
vim.validate("gotests", _config.gotests, "table")
vim.validate("gotests.template", _config.gotests.template, "string")
vim.validate("gotests.template_dir", _config.gotests.template_dir, { "string", "nil" })
vim.validate("gotests.template_dir", _config.gotests.template_dir, "string", true)
vim.validate("gotests.named", _config.gotests.named, "boolean")
vim.validate("gotag", _config.gotag, "table")
vim.validate("gotag.transform", _config.gotag.transform, "string")
vim.validate("gotag.default_tag", _config.gotag.default_tag, "string")
vim.validate("gotag.option", _config.gotag.option, { "string", "nil" })
vim.validate("iferr", _config.iferr, "table")
vim.validate("iferr.message", _config.iferr.message, { "string", "nil" })
vim.validate("json2go.installer_timeout", _config.json2go.interactive_cmd, "string")
vim.validate("json2go.type_name", _config.json2go.type_name, { "string", "nil" })
vim.validate("iferr.message", _config.iferr.message, "string", true)
end
setmetatable(config, {
@ -139,4 +108,5 @@ setmetatable(config, {
})
---@dochide
return config
---@return gopher.Config
return config --[[ @as gopher.Config ]]

56
lua/gopher/go.lua
View file

@ -1,56 +0,0 @@
local c = require "gopher.config"
local u = require "gopher._utils"
local r = require "gopher._utils.runner"
local go = {}
local function run(subcmd, args)
local rs = r.sync { c.commands.go, subcmd, unpack(args) }
if rs.code ~= 0 then
error("go " .. subcmd .. " failed: " .. rs.stderr)
end
u.notify(c.commands.go .. " " .. subcmd .. " ran successful")
return rs.stdout
end
---@param args string[]
function go.get(args)
for i, arg in ipairs(args) do
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
table.remove(args, i)
table.insert(args, i, m)
end
run("get", args)
end
---@param args string[]
function go.mod(args)
run("mod", args)
end
---@param args string[]
function go.work(args)
-- TODO: use `gopls.tidy`
run("work", args)
end
---Executes `go generate`
---If only argument is `%` it's going to be equivalent to `go generate <path to current file>`
---@param args string[]
function go.generate(args)
-- TODO: use `gopls.generate`
if #args == 0 then
error "please provide arguments"
end
if #args == 1 and args[1] == "%" then
args[1] = vim.fn.expand "%"
end
run("generate", args)
end
return go

13
lua/gopher/gotests.lua
View file

@ -3,18 +3,17 @@
---@text gotests is utilizing the `gotests` tool to generate unit tests boilerplate.
---@usage
--- - Generate unit test for specific function/method:
--- 1. Place your cursor on the desired function/method.
--- 2. Run `:GoTestAdd`
--- 1. Place your cursor on the desired function/method.
--- 2. Run `:GoTestAdd`
---
--- - Generate unit tests for *all* functions/methods in current file:
--- - run `:GoTestsAll`
--- - run `:GoTestsAll`
---
--- - Generate unit tests *only* for *exported(public)* functions/methods:
--- - run `:GoTestsExp`
--- - run `:GoTestsExp`
---
--- You can also specify the template to use for generating the tests.
--- See |gopher.nvim-config|.
--- More details about templates: https://github.com/cweill/gotests
--- You can also specify the template to use for generating the tests. See |gopher.nvim-config|
--- More details about templates can be found at: https://github.com/cweill/gotests
---
--- If you prefer named tests, you can enable them in |gopher.nvim-config|.

70
lua/gopher/health.lua
View file

@ -1,58 +1,62 @@
local c = require("gopher.config").commands
local health = {}
local cmd = require("gopher.config").commands
local deps = {
vim_version = "nvim-0.10",
bin = {
{
bin = c.go,
bin = cmd.go,
msg = "required for `:GoGet`, `:GoMod`, `:GoGenerate`, `:GoWork`, `:GoInstallDeps`, `:GoInstallDepsSync`",
optional = false,
},
{ bin = cmd.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`", optional = true },
{ bin = cmd.impl, msg = "required for `:GoImpl`", optional = true },
{ bin = cmd.iferr, msg = "required for `:GoIfErr`", optional = true },
{
bin = cmd.gotests,
msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`",
optional = true,
},
{ bin = c.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`" },
{ bin = c.impl, msg = "required for `:GoImpl`" },
{ bin = c.iferr, msg = "required for `:GoIfErr`" },
{ bin = c.gotests, msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`" },
},
treesitter = {
{ parser = "go", msg = "required for most of the parts of `gopher.nvim`" },
},
}
---@param bin {bin:string, msg:string, optional:boolean}
local function check_binary(bin)
if vim.fn.executable(bin.bin) == 1 then
vim.health.ok(bin.bin .. " is found oh PATH: `" .. vim.fn.exepath(bin.bin) .. "`")
else
vim.health.error(bin.bin .. " not found on PATH, " .. bin.msg)
end
---@param bin string
---@return boolean
local function is_binary_found(bin)
return vim.fn.executable(bin) == 1
end
---@param ts {parser:string, msg:string}
local function check_treesitter(ts)
local ok, parser = pcall(vim.treesitter.get_parser, 0, ts.parser)
if ok and parser ~= nil then
vim.health.ok("`" .. ts.parser .. "` parser is installed")
else
vim.health.error("`" .. ts.parser .. "` parser not found")
end
---@param ft string
---@return boolean
local function is_treesitter_parser_available(ft)
local ok, parser = pcall(vim.treesitter.get_parser, 0, ft)
return ok and parser ~= nil
end
function health.check()
vim.health.start "Neovim version"
if vim.fn.has(deps.vim_version) == 1 then
vim.health.ok "Neovim version is compatible"
else
vim.health.error(deps.vim_version .. " or newer is required")
end
vim.health.start "Required binaries (those can be installed with `:GoInstallDeps`)"
vim.health.start "required binaries"
vim.health.info "all those binaries can be installed by `:GoInstallDeps`"
for _, bin in ipairs(deps.bin) do
check_binary(bin)
if is_binary_found(bin.bin) then
vim.health.ok(bin.bin .. " installed")
else
if bin.optional then
vim.health.warn(bin.bin .. " not found, " .. bin.msg)
else
vim.health.error(bin.bin .. " not found, " .. bin.msg)
end
end
end
vim.health.start "Treesitter"
vim.health.start "required treesitter parsers"
for _, parser in ipairs(deps.treesitter) do
check_treesitter(parser)
if is_treesitter_parser_available(parser.parser) then
vim.health.ok(parser.parser .. " parser installed")
else
vim.health.error(parser.parser .. " parser not found, " .. parser.msg)
end
end
end

2
lua/gopher/iferr.lua
View file

@ -42,7 +42,7 @@ function iferr.iferr()
vim.fn.append(pos, u.remove_empty_lines(vim.split(rs.stdout, "\n")))
vim.cmd [[silent normal! j=2j]]
vim.fn.setpos(".", pos --[[@as integer[] ]])
vim.fn.setpos(".", pos)
end
return iferr

27
lua/gopher/impl.lua
View file

@ -3,24 +3,23 @@
---@text
--- Integration of `impl` tool to generate method stubs for interfaces.
---
---@usage
--- 1. Automatically implement an interface for a struct:
--- - Place your cursor on the struct where you want to implement the interface.
--- - Run `:GoImpl io.Reader`
--- - This will automatically determine the receiver and implement the `io.Reader` interface.
---@usage 1. Automatically implement an interface for a struct:
--- - Place your cursor on the struct where you want to implement the interface.
--- - Run `:GoImpl io.Reader`
--- - This will automatically determine the receiver and implement the `io.Reader` interface.
---
--- 2. Specify a custom receiver:
--- - Place your cursor on the struct
--- - Run `:GoImpl w io.Writer`, where:
--- - `w` is the receiver.
--- - `io.Writer` is the interface to implement.
--- - Place your cursor on the struct
--- - Run `:GoImpl w io.Writer`, where:
--- - `w` is the receiver.
--- - `io.Writer` is the interface to implement.
---
--- 3. Explicitly specify the receiver, struct, and interface:
--- - No need to place the cursor on the struct if all arguments are provided.
--- - Run `:GoImpl r RequestReader io.Reader`, where:
--- - `r` is the receiver.
--- - `RequestReader` is the struct.
--- - `io.Reader` is the interface to implement.
--- - No need to place the cursor on the struct if all arguments are provided.
--- - Run `:GoImpl r RequestReader io.Reader`, where:
--- - `r` is the receiver.
--- - `RequestReader` is the struct.
--- - `io.Reader` is the interface to implement.
---
--- Example:
--- >go

31
lua/gopher/init.lua
View file

@ -13,7 +13,7 @@
local log = require "gopher._utils.log"
local tags = require "gopher.struct_tags"
local tests = require "gopher.gotests"
local go = require "gopher.go"
local gocmd = require("gopher._utils.gocmd").run
local gopher = {}
---@toc_entry Setup
@ -35,11 +35,11 @@ end
---@toc_entry Install dependencies
---@tag gopher.nvim-dependencies
---@text
--- Gopher.nvim implements most of its features using third-party tools. To
--- install plugin's dependencies, you can run:
--- `:GoInstallDeps` or `:GoInstallDepsSync`
--- or use `require("gopher").install_deps()` if you prefer lua api.
---@text Gopher.nvim implements most of its features using third-party tools.
--- To install these tools, you can run `:GoInstallDeps` command
--- or call `require("gopher").install_deps()` if you want to use lua api.
--- By default dependencies will be installed asynchronously,
--- to install them synchronously pass `{sync = true}` as an argument.
gopher.install_deps = require("gopher.installer").install_deps
gopher.impl = require("gopher.impl").impl
@ -58,9 +58,20 @@ gopher.test = {
all = tests.all_tests,
}
gopher.get = go.get
gopher.mod = go.mod
gopher.work = go.work
gopher.generate = go.generate
gopher.get = function(...)
gocmd("get", ...)
end
gopher.mod = function(...)
gocmd("mod", ...)
end
gopher.generate = function(...)
gocmd("generate", ...)
end
gopher.work = function(...)
gocmd("work", ...)
end
return gopher

1
lua/gopher/installer.lua
View file

@ -9,7 +9,6 @@ local urls = {
impl = "github.com/josharian/impl@latest",
gotests = "github.com/cweill/gotests/...@develop",
iferr = "github.com/koron/iferr@latest",
json2go = "olexsmir.xyz/json2go/cmd/json2go@latest",
}
---@param opt vim.SystemCompleted

137
lua/gopher/json2go.lua
View file

@ -1,137 +0,0 @@
---@toc_entry json2go
---@tag gopher.nvim-json2go
---@text
--- Convert json to go type annotations.
---
---@usage
--- `:GoJson` opens a temporary buffer where you can paste or write JSON.
--- Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
--- generated Go struct into the original buffer at the cursor position.
---
--- Alternatively, you can pass JSON directly as an argument:
--- >vim
--- :GoJson {"name": "Alice", "age": 30}
--- <
local c = require "gopher.config"
local log = require "gopher._utils.log"
local u = require "gopher._utils"
local r = require "gopher._utils.runner"
local json2go = {}
---@dochide
---@param bufnr integer
---@param cpos integer
---@param type_ string
local function apply(bufnr, cpos, type_)
local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
local input_lines = u.remove_empty_lines(vim.split(type_, "\n"))
for i, line in pairs(input_lines) do
table.insert(lines, cpos + i, line)
end
vim.api.nvim_buf_set_lines(bufnr, 0, -1, true, lines)
end
-- Convert json string to go type.
---
---@param json_str string Json string that is going to be converted to go type.
---@return string? Go type, or nil if failed.
function json2go.transform(json_str)
local cmd = { c.commands.json2go }
if c.json2go.type_name then
table.insert(cmd, "-type", c.json2go.type_name)
end
local rs = r.sync(cmd, { stdin = json_str })
if rs.code ~= 0 then
u.notify("json2go: got this error: " .. rs.stdout, vim.log.levels.ERROR)
log.error("json2go: got this error: " .. rs.stdout)
return
end
return rs.stdout
end
---@dochide
---@param ocpos integer
local function interactive(ocpos)
local obuf = vim.api.nvim_get_current_buf()
local owin = vim.api.nvim_get_current_win()
-- setup the input window
local buf = vim.api.nvim_create_buf(false, true)
vim.cmd(c.json2go.interactive_cmd)
local win = vim.api.nvim_get_current_win()
vim.api.nvim_win_set_buf(win, buf)
vim.api.nvim_buf_set_name(buf, "[GoJson input]")
vim.api.nvim_set_option_value("filetype", "jsonc", { buf = buf })
vim.api.nvim_set_option_value("buftype", "acwrite", { buf = buf })
vim.api.nvim_set_option_value("swapfile", false, { buf = buf })
vim.api.nvim_set_option_value("bufhidden", "delete", { buf = buf })
vim.api.nvim_buf_set_lines(buf, 0, -1, false, {
"// Write your json here.",
"// Writing and quitting (:wq), will generate go struct under the cursor.",
"",
"",
})
vim.api.nvim_create_autocmd("BufLeave", { buffer = buf, command = "stopinsert" })
vim.api.nvim_create_autocmd("BufWriteCmd", {
buffer = buf,
once = true,
callback = function()
local input = vim.api.nvim_buf_get_lines(buf, 0, -1, true)
local inp = table.concat(
vim
.iter(input)
:filter(function(line)
local found = string.find(line, "^//.*")
return (not found) or (line == "")
end)
:totable(),
"\n"
)
local go_type = json2go.transform(inp)
if not go_type then
error "cound't convert json to go type"
end
vim.api.nvim_set_option_value("modified", false, { buf = buf })
apply(obuf, ocpos, go_type)
vim.api.nvim_set_current_win(owin)
vim.api.nvim_win_set_cursor(owin, { ocpos + 1, 0 })
vim.schedule(function()
pcall(vim.api.nvim_win_close, win, true)
pcall(vim.api.nvim_buf_delete, buf, {})
end)
end,
})
vim.cmd "normal! G"
vim.cmd "startinsert"
end
--- Converts json string to go type, and puts result under the cursor. If
--- [json_str] is nil, will open an interactive prompt (with cmd set in
--- config).
---
---@param json_str? string
function json2go.json2go(json_str)
local cur_line = vim.api.nvim_win_get_cursor(0)[1]
if not json_str then
interactive(cur_line)
return
end
local go_type = json2go.transform(json_str)
if not go_type then
error "cound't convert json to go type"
end
apply(0, cur_line, go_type)
end
return json2go

88
lua/gopher/struct_tags.lua
View file

@ -1,20 +1,15 @@
---@toc_entry Modify struct tags
---@tag gopher.nvim-struct-tags
---@text
--- `struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to
--- struct fields.
--- `struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to struct fields.
---
---@usage
--- How to add/remove/clear tags to struct fields:
--- How to add/remove tags to struct fields:
--- 1. Place cursor on the struct
--- 2. Run `:GoTagAdd json` to add json tags to struct fields
--- 3. Run `:GoTagRm json` to remove json tags to struct fields
--- 4. Run `:GoTagClear` to clear all tags from struct fields
---
--- If you want to add/remove tag with options, you can use `json=omitempty`
--- (where json is tag, and omitempty is its option).
--- Example: `:GoTagAdd xml json=omitempty`
---
--- To clear all tags from struct run: `:GoTagClear`
---
--- NOTE: if you dont specify the tag it will use `json` as default
---
@ -44,7 +39,7 @@ local struct_tags = {}
---@dochide
---@class gopher.StructTagInput
---@field input string[] User provided tags
---@field tags string[] User provided tags
---@field range? gopher.StructTagRange (optional)
---@dochide
@ -107,52 +102,18 @@ local function handle_tags(fpath, bufnr, range, user_args)
)
end
---@dochide
---@param option string
local function option_to_tag(option)
return option:match "^(.-)="
end
---@dochide
---@param args string[]
local function unwrap_if_needed(args)
local out = {}
for _, v in pairs(args) do
for _, p in pairs(vim.split(v, ",")) do
table.insert(out, p)
end
---@return string
---@dochide
local function handler_user_tags(args)
if #args == 0 then
return c.gotag.default_tag
end
return out
return table.concat(args, ",")
end
---@dochide
---@class gopher.StructTagsArgs
---@field tags string
---@field options string
---@dochide
---@param args string[]
---@return gopher.StructTagsArgs
function struct_tags.parse_args(args)
args = unwrap_if_needed(args)
local tags, options = {}, {}
for _, v in pairs(args) do
if string.find(v, "=") then
table.insert(options, v)
table.insert(tags, option_to_tag(v))
else
table.insert(tags, v)
end
end
return {
tags = table.concat(u.list_unique(tags), ","),
options = table.concat(u.list_unique(options), ","),
}
end
-- Adds tags to a struct under the cursor. See `:h gopher.nvim-struct-tags`.
-- Adds tags to a struct under the cursor
-- See |gopher.nvim-struct-tags|
---@param opts gopher.StructTagInput
---@dochide
function struct_tags.add(opts)
@ -161,16 +122,12 @@ function struct_tags.add(opts)
local fpath = vim.fn.expand "%"
local bufnr = vim.api.nvim_get_current_buf()
local user_args = struct_tags.parse_args(opts.input)
handle_tags(fpath, bufnr, opts.range, {
"-add-tags",
(user_args.tags ~= "") and user_args.tags or c.gotag.default_tag,
(user_args.options ~= "" or c.gotag.option) and "-add-options" or nil,
(user_args.options ~= "") and user_args.options or c.gotag.option,
})
local user_tags = handler_user_tags(opts.tags)
handle_tags(fpath, bufnr, opts.range, { "-add-tags", user_tags })
end
-- Removes tags from a struct under the cursor. See `:h gopher.nvim-struct-tags`.
-- Removes tags from a struct under the cursor
-- See `:h gopher.nvim-struct-tags`
---@dochide
---@param opts gopher.StructTagInput
function struct_tags.remove(opts)
@ -179,17 +136,12 @@ function struct_tags.remove(opts)
local fpath = vim.fn.expand "%"
local bufnr = vim.api.nvim_get_current_buf()
local user_args = struct_tags.parse_args(opts.input)
handle_tags(fpath, bufnr, opts.range, {
"-remove-tags",
(user_args.tags ~= "") and user_args.tags or c.gotag.default_tag,
(user_args.options ~= "" or c.gotag.option ~= nil) and "-remove-options" or nil,
(user_args.options ~= "") and user_args.options or c.gotag.option,
})
local user_tags = handler_user_tags(opts.tags)
handle_tags(fpath, bufnr, opts.range, { "-remove-tags", user_tags })
end
-- Removes all tags from a struct under the cursor.
-- See `:h gopher.nvim-struct-tags`.
-- Removes all tags from a struct under the cursor
-- See `:h gopher.nvim-struct-tags`
---@dochide
function struct_tags.clear()
local fpath = vim.fn.expand "%"

13
plugin/gopher.lua
View file

@ -48,7 +48,7 @@ end)
-- :GoTag
cmd("GoTagAdd", function(opts)
require("gopher").tags.add {
input = opts.fargs,
tags = opts.fargs,
range = (opts.count ~= -1) and {
start = opts.line1,
end_ = opts.line2,
@ -58,7 +58,7 @@ end, "*", true)
cmd("GoTagRm", function(opts)
require("gopher").tags.rm {
input = opts.fargs,
tags = opts.fargs,
range = (opts.count ~= -1) and {
start = opts.line1,
end_ = opts.line2,
@ -70,12 +70,6 @@ cmd("GoTagClear", function()
require("gopher").tags.clear()
end)
-- :GoJson
cmd("GoJson", function(opts)
local inp = ((opts.args ~= "" and opts.args) or nil)
require("gopher.json2go").json2go(inp)
end, "*")
-- :GoTest
cmd("GoTestAdd", function()
require("gopher").test.add()
@ -95,6 +89,7 @@ cmd("GoMod", function(opts)
end, "*")
cmd("GoGet", function(opts)
vim.print(opts)
require("gopher").get(opts.fargs)
end, "*")
@ -103,5 +98,5 @@ cmd("GoWork", function(opts)
end, "*")
cmd("GoGenerate", function(opts)
require("gopher").generate(opts.fargs or { "" })
require("gopher").generate(opts.fargs or "")
end, "?")

1
scripts/docgen.lua
View file

@ -12,7 +12,6 @@ local files = {
"lua/gopher/config.lua",
"plugin/gopher.lua",
"lua/gopher/struct_tags.lua",
"lua/gopher/json2go.lua",
"lua/gopher/impl.lua",
"lua/gopher/gotests.lua",
"lua/gopher/iferr.lua",

1
scripts/minimal_init.lua
View file

@ -20,6 +20,7 @@ local function install_plug(plugin)
end
end
install_plug "nvim-lua/plenary.nvim"
install_plug "nvim-treesitter/nvim-treesitter"
install_plug "echasnovski/mini.doc" -- used for docs generation
install_plug "folke/tokyonight.nvim" -- theme for generating demos

6
spec/fixtures/comment/interface_many_method_input.go vendored
View file

@ -1,6 +0,0 @@
package main
type Testinger interface {
Get(id string) int
Set(id string, val int)
}

7
spec/fixtures/comment/interface_many_method_output.go vendored
View file

@ -1,7 +0,0 @@
package main
type Testinger interface {
Get(id string) int
// Set
Set(id string, val int)
}

5
spec/fixtures/comment/interface_method_input.go vendored
View file

@ -1,5 +0,0 @@
package main
type Testinger interface {
Method(input string) error
}

6
spec/fixtures/comment/interface_method_output.go vendored
View file

@ -1,6 +0,0 @@
package main
type Testinger interface {
// Method
Method(input string) error
}

18
spec/fixtures/comment/many_structs_fields_input.go vendored
View file

@ -1,18 +0,0 @@
package main
type (
TestOne struct {
Asdf string
ID int
}
TestTwo struct {
Fesa int
A bool
}
TestThree struct {
Asufj int
Fs string
}
)

19
spec/fixtures/comment/many_structs_fields_output.go vendored
View file

@ -1,19 +0,0 @@
package main
type (
TestOne struct {
Asdf string
ID int
}
TestTwo struct {
// Fesa
Fesa int
A bool
}
TestThree struct {
Asufj int
Fs string
}
)

7
spec/fixtures/comment/struct_fields_input.go vendored
View file

@ -1,7 +0,0 @@
package main
type CommentStruct struct {
Name string
Address string
Aliases []string
}

8
spec/fixtures/comment/struct_fields_output.go vendored
View file

@ -1,8 +0,0 @@
package main
type CommentStruct struct {
Name string
// Address
Address string
Aliases []string
}

5
spec/fixtures/comment/svar_input.go vendored
View file

@ -1,5 +0,0 @@
package main
func varTest() {
s := "something"
}

6
spec/fixtures/comment/svar_output.go vendored
View file

@ -1,6 +0,0 @@
package main
func varTest() {
// s
s := "something"
}

5
spec/fixtures/comment/var_input.go vendored
View file

@ -1,5 +0,0 @@
package main
func test() {
var imAVar string
}

6
spec/fixtures/comment/var_output.go vendored
View file

@ -1,6 +0,0 @@
package main
func test() {
// imAVar
var imAVar string
}

8
spec/fixtures/comment/var_struct_fields_input.go vendored
View file

@ -1,8 +0,0 @@
package main
func main() {
var s struct {
API string
Key string
}
}

9
spec/fixtures/comment/var_struct_fields_output.go vendored
View file

@ -1,9 +0,0 @@
package main
func main() {
var s struct {
API string
// Key
Key string
}
}

2
spec/fixtures/json2go/interativly_input.go vendored
View file

@ -1,2 +0,0 @@
package main

5
spec/fixtures/json2go/interativly_output.go vendored
View file

@ -1,5 +0,0 @@
package main
type AutoGenerated struct {
Json bool `json:"json"`
}

2
spec/fixtures/json2go/manual_input.go vendored
View file

@ -1,2 +0,0 @@
package main

7
spec/fixtures/json2go/manual_output.go vendored
View file

@ -1,7 +0,0 @@
package main
type AutoGenerated struct {
User struct {
Name string `json:"name"`
} `json:"user"`
}

8
spec/fixtures/tags/overwrite_default_option_input.go vendored
View file

@ -1,8 +0,0 @@
package main
type Test struct {
ID int
Another struct {
Second string
}
}

8
spec/fixtures/tags/overwrite_default_option_output.go vendored
View file

@ -1,8 +0,0 @@
package main
type Test struct {
ID int `xml:"id,otheroption"`
Another struct {
Second string `xml:"second,otheroption"`
} `xml:"another,otheroption"`
}

11
spec/fixtures/tags/remove_with_option_input.go vendored
View file

@ -1,11 +0,0 @@
package main
type Test struct {
ID int `json:"id,omitempty" xml:"id,someoption"`
Name string `json:"name,omitempty" xml:"name,someoption"`
Num int64 `json:"num,omitempty" xml:"num,someoption"`
Another struct {
First int `json:"first,omitempty" xml:"first,someoption"`
Second string `json:"second,omitempty" xml:"second,someoption"`
} `json:"another,omitempty" xml:"another,someoption"`
}

11
spec/fixtures/tags/remove_with_option_output.go vendored
View file

@ -1,11 +0,0 @@
package main
type Test struct {
ID int `xml:"id,someoption"`
Name string `xml:"name,someoption"`
Num int64 `xml:"num,someoption"`
Another struct {
First int `xml:"first,someoption"`
Second string `xml:"second,someoption"`
} `xml:"another,someoption"`
}

8
spec/fixtures/tags/with_default_option_input.go vendored
View file

@ -1,8 +0,0 @@
package main
type Test struct {
ID int
Another struct {
Second string
}
}

8
spec/fixtures/tags/with_default_option_output.go vendored
View file

@ -1,8 +0,0 @@
package main
type Test struct {
ID int `xml:"id,theoption"`
Another struct {
Second string `xml:"second,theoption"`
} `xml:"another,theoption"`
}

11
spec/fixtures/tags/with_option_input.go vendored
View file

@ -1,11 +0,0 @@
package main
type Test struct {
ID int
Name string
Num int64
Another struct {
First int
Second string
}
}

11
spec/fixtures/tags/with_option_output.go vendored
View file

@ -1,11 +0,0 @@
package main
type Test struct {
ID int `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Num int64 `json:"num,omitempty"`
Another struct {
First int `json:"first,omitempty"`
Second string `json:"second,omitempty"`
} `json:"another,omitempty"`
}

28
spec/integration/comment_test.lua
View file

@ -18,18 +18,6 @@ comment["should add comment to struct"] = function()
do_the_test("struct", { 4, 1 })
end
comment["should add a comment on struct field"] = function()
do_the_test("struct_fields", { 5, 8 })
end
comment["should add a comment on var struct field"] = function()
do_the_test("var_struct_fields", { 6, 4 })
end
comment["should add a comment on one field of many structs"] = function()
do_the_test("many_structs_fields", { 10, 4 })
end
comment["should add comment to function"] = function()
do_the_test("func", { 3, 1 })
end
@ -42,22 +30,6 @@ comment["should add comment to interface"] = function()
do_the_test("interface", { 3, 6 })
end
comment["should add comment on interface method"] = function()
do_the_test("interface_method", { 4, 2 })
end
comment["should add a comment on interface with many method"] = function()
do_the_test("interface_many_method", { 5, 2 })
end
comment["should add a comment on a var"] = function()
do_the_test("var", { 4, 2 })
end
comment["should add a comment on a short declared var"] = function()
do_the_test("svar", { 4, 8 })
end
comment["otherwise should add // above cursor"] = function()
do_the_test("empty", { 1, 1 })
end

3
spec/integration/iferr_test.lua
View file

@ -14,8 +14,7 @@ iferr["should add if err with custom message"] = function()
child.lua [[
require("gopher").setup {
iferr = { message = 'fmt.Errorf("failed to %w", err)' }
}
]]
} ]]
local rs = t.setup_test("iferr/message", child, { 6, 2 })
child.cmd "GoIfErr"

25
spec/integration/json2go_test.lua
View file

@ -1,25 +0,0 @@
local t = require "spec.testutils"
local child, T, json2go = t.setup "json2go"
json2go["should convert interativly"] = function()
local rs = t.setup_test("json2go/interativly", child, { 2, 0 })
child.cmd "GoJson"
child.type_keys [[{"json": true}]]
child.type_keys "<Esc>"
child.cmd "wq" -- quit prompt
child.cmd "write" -- the fixture file
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
json2go["should convert argument"] = function()
local rs = t.setup_test("json2go/manual", child, { 2, 0 })
child.cmd [[GoJson {"user": {"name": "user-ovic"}}]]
child.cmd "write"
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
return T

48
spec/integration/struct_tags_test.lua
View file

@ -96,52 +96,4 @@ struct_tags["should remove tag with range"] = function()
t.cleanup(rs)
end
struct_tags["should add tags with option"] = function()
local rs = t.setup_test("tags/with_option", child, { 3, 6 })
child.cmd "GoTagAdd json=omitempty"
child.cmd "write"
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
struct_tags["should add tags with default option"] = function()
child.lua [[
require("gopher").setup {
gotag = { option = "xml=theoption" },
}
]]
local rs = t.setup_test("tags/with_default_option", child, { 3, 6 })
child.cmd "GoTagAdd xml"
child.cmd "write"
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
struct_tags["should add tags and overwrite default option"] = function()
child.lua [[
require("gopher").setup {
gotag = { option = "xml=theoption" },
}
]]
local rs = t.setup_test("tags/overwrite_default_option", child, { 3, 6 })
child.cmd "GoTagAdd xml=otheroption"
child.cmd "write"
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
struct_tags["should remove tag with specified option"] = function()
local rs = t.setup_test("tags/remove_with_option", child, { 3, 6 })
child.cmd "GoTagRm json=omitempty"
child.cmd "write"
t.eq(t.readfile(rs.tmp), rs.fixtures.output)
t.cleanup(rs)
end
return T

3
spec/unit/config_test.lua
View file

@ -7,14 +7,11 @@ config["can be called without any arguments passed"] = function()
end
config["can be called with empty table"] = function()
---@diagnostic disable-next-line: missing-fields
require("gopher").setup {}
end
config["should change option"] = function()
local log_level = 1234567890
---@diagnostic disable-next-line: missing-fields
require("gopher").setup {
log_level = log_level,
}

68
spec/unit/struct_tag_test.lua
View file

@ -1,68 +0,0 @@
local t = require "spec.testutils"
local _, T, st = t.setup "struct_tags"
st["should parse tags"] = function()
local out = require("gopher.struct_tags").parse_args { "json", "yaml", "etc" }
t.eq(out.tags, "json,yaml,etc")
t.eq(out.options, "")
end
st["should parse tags separated by commas"] = function()
local out = require("gopher.struct_tags").parse_args { "json,yaml,etc" }
t.eq(out.tags, "json,yaml,etc")
t.eq(out.options, "")
end
st["should parse tags separated by command and spaces"] = function()
local out = require("gopher.struct_tags").parse_args {
"json,yaml",
"json=omitempty",
"xml=something",
}
t.eq(out.tags, "json,yaml,xml")
t.eq(out.options, "json=omitempty,xml=something")
end
st["should parse tag with an option"] = function()
local out = require("gopher.struct_tags").parse_args {
"json=omitempty",
"xml",
"xml=theoption",
}
t.eq(out.tags, "json,xml")
t.eq(out.options, "json=omitempty,xml=theoption")
end
st["should parse tags with an option"] = function()
local out = require("gopher.struct_tags").parse_args { "json=omitempty", "yaml" }
t.eq(out.tags, "json,yaml")
t.eq(out.options, "json=omitempty")
end
st["should parse tags with an option separated with comma"] = function()
local out = require("gopher.struct_tags").parse_args { "json=omitempty,yaml" }
t.eq(out.tags, "json,yaml")
t.eq(out.options, "json=omitempty")
end
st["should parse tags with options specified separately"] = function()
local out = require("gopher.struct_tags").parse_args { "json", "yaml", "json=omitempty" }
t.eq(out.tags, "json,yaml")
t.eq(out.options, "json=omitempty")
end
st["should parse tags with options specified separately and separated by comma"] = function()
local out = require("gopher.struct_tags").parse_args { "json,yaml,json=omitempty" }
t.eq(out.tags, "json,yaml")
t.eq(out.options, "json=omitempty")
end
return T

34
spec/unit/utils_test.lua
View file

@ -22,38 +22,4 @@ utils["should .trimend()"] = function()
t.eq(u.trimend " hi ", " hi")
end
utils["should add .indent() spaces"] = function()
local u = require "gopher._utils"
local line = " func Test() error {"
local indent = 4
t.eq(" ", u.indent(line, indent))
end
utils["should add .indent() a tab"] = function()
local u = require "gopher._utils"
local line = "\tfunc Test() error {"
local indent = 1
t.eq("\t", u.indent(line, indent))
end
utils["should add .indent() 2 tabs"] = function()
local u = require "gopher._utils"
local line = "\t\tfunc Test() error {"
local indent = 2
t.eq("\t\t", u.indent(line, indent))
end
utils["should .list_unique on list with duplicates"] = function()
local u = require "gopher._utils"
t.eq({ "json", "xml" }, u.list_unique { "json", "xml", "json" })
end
utils["should .list_unique on list with no duplicates"] = function()
local u = require "gopher._utils"
t.eq({ "json", "xml" }, u.list_unique { "json", "xml" })
end
return T

3
vhs/Taskfile.yml
View file

@ -18,6 +18,3 @@ tasks:
impl:
cmd: vhs impl.tape
json2go:
cmd: vhs json2go.tape

BIN
vhs/comment.gif
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 272 KiB

After

Width:  |  Height:  |  Size: 220 KiB

Before After
Before After

13
vhs/comment.tape
View file

@ -9,21 +9,26 @@ Set Shell "bash"
Set Theme "tokyonight"
Set TypingSpeed 250ms
Hide Type@0ms "./nvim.sh comment.go" Enter Show
Hide
Type@0ms "alias nvim='./nvim.sh'" Enter
Type@0ms "clear" Enter
Show
Type "nvim comment.go" Sleep 150ms Enter
# package
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
# func
Type@400ms "jjj"
Type "3j"
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
# struct
Type@400ms "jjj"
Type "3j"
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
# interface
Type@400ms "jjj"
Type "3j"
Type ":GoCmt" Enter Sleep 500ms Escape Sleep 700ms
Sleep 5s

BIN
vhs/iferr.gif
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 93 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Before After
Before After

2
vhs/iferr.go
View file

@ -1,6 +1,6 @@
package demos
func ifErr() error {
func ifErr() {
out, err := doSomething()
_ = out

7
vhs/iferr.tape
View file

@ -10,7 +10,12 @@ Set Shell "bash"
Set Theme "tokyonight"
Set TypingSpeed 250ms
Hide Type@0ms "./nvim.sh iferr.go" Enter Show
Hide
Type@0ms "alias nvim='./nvim.sh'" Enter
Type@0ms "clear" Enter
Show
Type "nvim iferr.go" Sleep 150ms Enter
Type "3j"
Type ":GoIfErr" Sleep 500ms Enter

BIN
vhs/impl.gif
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Before After
Before After

11
vhs/impl.tape
View file

@ -1,6 +1,6 @@
Output impl.gif
Require nvim
Require impl
Require iferr
Set FontFamily "JetBrains Mono"
Set Height 800
@ -10,9 +10,14 @@ Set Shell "bash"
Set Theme "tokyonight"
Set TypingSpeed 250ms
Hide Type@0ms "./nvim.sh impl.go" Enter Show
Hide
Type@0ms "alias nvim='./nvim.sh'" Enter
Type@0ms "clear" Enter
Show
Type "nvim impl.go" Sleep 150ms Enter
Type "2j"
Type ":GoImpl c io.Reader" Sleep 700ms Enter
Type ":GoImpl io.Reader" Sleep 500ms Enter
Sleep 5s

BIN
vhs/json2go.gif
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 282 KiB

2
vhs/json2go.go
View file

@ -1,2 +0,0 @@
package main

27
vhs/json2go.tape
View file

@ -1,27 +0,0 @@
Output json2go.gif
Require nvim
Require json2go
Set FontFamily "JetBrains Mono"
Set Height 800
Set Width 1500
Set Padding 20
Set Shell "bash"
Set Theme "tokyonight"
Set TypingSpeed 250ms
Hide Type@0ms "./nvim.sh json2go.go" Enter Show
Type@0ms "G"
Type@400ms ":GoJson" Sleep 500ms Enter
Type@70ms "{" Enter
Type@70ms `"json": true,` Enter
Type@70ms `"user": {"name": "Name", "of_age": true}` Enter
Type@70ms "}"
Escape Type@500ms ":wq" Enter
Sleep 1s
Type@25ms "G2o" Escape
Type@120ms `:GoJson {"json": true}` Enter
Sleep 5s

BIN
vhs/tags.gif
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 280 KiB

After

Width:  |  Height:  |  Size: 246 KiB

Before After
Before After

17
vhs/tags.tape
View file

@ -10,22 +10,27 @@ Set Shell "bash"
Set Theme "tokyonight"
Set TypingSpeed 250ms
Hide Type@0ms "./nvim.sh tags.go" Enter Show
Hide
Type@0ms "alias nvim='./nvim.sh'" Enter
Type@0ms "clear" Enter
Show
Type@400ms "jjj"
Type "nvim tags.go" Sleep 150ms Enter
Type "3j"
Type ":GoTagAdd json yaml" Sleep 500ms Enter
Type@120ms ":w" Enter
Sleep 1s
Type ":GoTagRm json" Sleep 500ms Enter
Type ":w" Enter
Type@120ms ":w" Enter
Sleep 1s
Type ":GoTagClear" Sleep 500ms Enter
Type ":w" Enter
Type@120ms ":w" Enter
Sleep 1s
Type@400ms "jVjj"
Type ":GoTagAdd json=omitempty" Sleep 500ms Enter
Type "jV2j"
Type ":GoTagAdd xml" Sleep 500ms Enter
Sleep 5s