all repos

gopher.nvim @ 4a2384ade8005affb4a35951efff4dfd2295600e

Minimalistic plugin for Go development
51 files changed, 790 insertions(+), 236 deletions(-)
Merge pull request #129 (v0.4.0)

Author: Oleksandr Smirnov olexsmir@gmail.com
Committed by: GitHub noreply@github.com
Committed at: 2025-11-27 17:12:38 +0200
Parent: 295e21e, 7764f6e
jump to
M .github/workflows/tests.yml
M README.md
M Taskfile.yml
M doc/gopher.nvim.txt
D lua/gopher/_utils/gocmd.lua
M lua/gopher/_utils/init.lua
M lua/gopher/_utils/log.lua
M lua/gopher/_utils/ts.lua
M lua/gopher/comment.lua
M lua/gopher/config.lua
A lua/gopher/go.lua
M lua/gopher/gotests.lua
M lua/gopher/health.lua
M lua/gopher/iferr.lua
M lua/gopher/impl.lua
M lua/gopher/init.lua
M lua/gopher/struct_tags.lua
M plugin/gopher.lua
M scripts/minimal_init.lua
A spec/fixtures/comment/interface_many_method_input.go
A spec/fixtures/comment/interface_many_method_output.go
A spec/fixtures/comment/interface_method_input.go
A spec/fixtures/comment/interface_method_output.go
A spec/fixtures/comment/many_structs_fields_input.go
A spec/fixtures/comment/many_structs_fields_output.go
A spec/fixtures/comment/struct_fields_input.go
A spec/fixtures/comment/struct_fields_output.go
A spec/fixtures/comment/svar_input.go
A spec/fixtures/comment/svar_output.go
A spec/fixtures/comment/var_input.go
A spec/fixtures/comment/var_output.go
A spec/fixtures/comment/var_struct_fields_input.go
A spec/fixtures/comment/var_struct_fields_output.go
A spec/fixtures/tags/overwrite_default_option_input.go
A spec/fixtures/tags/overwrite_default_option_output.go
A spec/fixtures/tags/remove_with_option_input.go
A spec/fixtures/tags/remove_with_option_output.go
A spec/fixtures/tags/with_default_option_input.go
A spec/fixtures/tags/with_default_option_output.go
A spec/fixtures/tags/with_option_input.go
A spec/fixtures/tags/with_option_output.go
M spec/integration/comment_test.lua
M spec/integration/iferr_test.lua
M spec/integration/struct_tags_test.lua
M spec/unit/config_test.lua
A spec/unit/struct_tag_test.lua
M spec/unit/utils_test.lua
M vhs/iferr.gif
M vhs/iferr.go
M vhs/tags.gif
M vhs/tags.tape
M .github/workflows/tests.yml

@@ -21,6 +21,7 @@ - v0.11.0

- v0.11.1 - v0.11.2 - v0.11.3 + - v0.11.4 runs-on: ${{ matrix.os }} steps: - name: Install Task
M README.md

@@ -8,6 +8,13 @@ It's **NOT** an LSP tool, the goal of this plugin is to add go tooling support in Neovim.

> 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:

@@ -16,14 +23,19 @@ - **Neovim 0.10** or later

- 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, it adds only about 1ms of load --- time to your config +-- NOTE: this plugin is already lazy-loaded and adds only about 1ms +-- of load time to your config { "olexsmir/gopher.nvim", ft = "go", -- branch = "develop" - -- (optional) will update plugin's deps on every update + -- (optional) updates the plugin's dependencies on each update build = function() vim.cmd.GoInstallDeps() end,

@@ -64,6 +76,9 @@

```vim " add json tag :GoTagAdd json + + " add json tag with omitempty option + :GoTagAdd json=omitempty " remove yaml tag :GoTagRm yaml

@@ -201,6 +216,10 @@

-- 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",

@@ -209,24 +228,40 @@ impl = "impl",

iferr = "iferr", }, gotests = { - -- gotests doesn't have template named "default" so this plugin uses "default" to set the default template + -- a default template that gotess will use. + -- gotets doesn't have template named `default`, we use it to represent absence of the provided template. template = "default", + -- path to a directory containing custom test code templates template_dir = nil, - -- switch table tests from using slice to map (with test name for the key) + + -- use named tests(map with test name as key) in table tests(slice of structs by default) 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 + -- choose a custom error message, nil to use default + -- e.g: `message = 'fmt.Errorf("failed to %w", err)'` message = 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
M Taskfile.yml

@@ -21,6 +21,8 @@ nvim --clean --headless \

-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
M doc/gopher.nvim.txt

@@ -36,11 +36,11 @@

------------------------------------------------------------------------------ *gopher.nvim-dependencies* `gopher.install_deps` -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.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. ==============================================================================

@@ -57,7 +57,8 @@ -- timeout for running internal commands

---@type number timeout = 2000, - --- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync) + -- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync) + ---@type number installer_timeout = 999999, -- user specified paths to binaries

@@ -71,12 +72,15 @@ iferr = "iferr",

}, ---@class gopher.ConfigGotests gotests = { - -- gotests doesn't have template named "default" so this plugin uses "default" to set the default template + -- a default template that gotess will use. + -- gotets doesn't have template named `default`, we use it to represent absence of the provided template. template = "default", + -- path to a directory containing custom test code templates ---@type string|nil template_dir = nil, - -- switch table tests from using slice to map (with test name for the key) + + -- use named tests(map with test name as key) in table tests(slice of structs by default) named = false, }, ---@class gopher.ConfigGoTag

@@ -86,9 +90,15 @@ 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` + ---@type string|nil + option = nil, }, iferr = { - -- choose a custom error message + -- choose a custom error message, nil to use default + -- e.g: `message = 'fmt.Errorf("failed to %w", err)'` ---@type string|nil message = nil, },

@@ -96,6 +106,8 @@ }

< Class ~ {gopher.Config} +Fields ~ +{setup} `(fun(user_config?: gopher.Config))` ==============================================================================

@@ -110,16 +122,21 @@ ==============================================================================

------------------------------------------------------------------------------ *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 tags to struct fields: +How to add/remove/clear 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 -To clear all tags from struct run: `:GoTagClear` +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` + NOTE: if you dont specify the tag it will use `json` as default

@@ -147,23 +164,24 @@

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

@@ -184,17 +202,18 @@ 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 can be found at: 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: https://github.com/cweill/gotests If you prefer named tests, you can enable them in |gopher.nvim-config|.

@@ -217,7 +236,9 @@

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:
D

@@ -1,51 +0,0 @@

-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
M lua/gopher/_utils/init.lua

@@ -3,7 +3,7 @@ local log = require "gopher._utils.log"

local utils = {} ---@param msg string ----@param lvl? number by default `vim.log.levels.INFO` +---@param lvl? integer by default `vim.log.levels.INFO` function utils.notify(msg, lvl) lvl = lvl or vim.log.levels.INFO vim.notify(msg, lvl, {

@@ -36,6 +36,37 @@ ---@return string

function utils.trimend(s) local r, _ = string.gsub(s, "%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
M lua/gopher/_utils/log.lua

@@ -3,7 +3,7 @@ -- and https://github.com/williamboman/mason.nvim

-- 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 @@ -- Can limit the number of decimals displayed for floats

float_precision = 0.01, } ----@type Gopher.Logger +---@type gopher.Logger ---@diagnostic disable-next-line: missing-fields local log = {}
M lua/gopher/_utils/ts.lua

@@ -11,9 +11,13 @@ left: (expression_list (identifier) @_name @_var)

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_declaration name: (field_identifier) @_name) + (method_elem name: (field_identifier) @_name)] ]], package = [[ (package_identifier) @_name

@@ -23,12 +27,17 @@ (type_spec

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_parrent_node(parent_type, node) +local function get_parent_node(parent_type, node) ---@type TSNode? local current = node while current do

@@ -64,10 +73,11 @@ return res

end ---@class gopher.TsResult ----@field name string ----@field start integer ----@field end_ integer ----@field is_varstruct boolean +---@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{}{}` ---@param bufnr integer ---@param parent_type string[]

@@ -78,23 +88,22 @@ if not vim.treesitter.get_parser(bufnr, "go") then

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 cursor" + error "No nodes found under the cursor" end - local parent_node = get_parrent_node(parent_type, node) + local parent_node = get_parent_node(parent_type, node) if not parent_node then - error "No parent node found under cursor" + error "No parent node found under the 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, _, end_row, _ = parent_node:range() + local start_row, start_col, end_row, _ = parent_node:range() + res["indent"] = start_col res["start"] = start_row + 1 res["end_"] = end_row + 1

@@ -104,11 +113,12 @@

---@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 strict{} )` - --- i will be choosing always last struct in the list + --- because in cases like `type ( T struct{}, U struct{} )` --- --- 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",

@@ -118,9 +128,18 @@ }, 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, { "function_declaration", "method_declaration" }, queries.func) + return do_stuff(bufnr, { + "method_elem", + "function_declaration", + "method_declaration", + }, queries.func) end ---@param bufnr integer

@@ -131,6 +150,11 @@

---@param bufnr integer 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
M lua/gopher/comment.lua

@@ -3,36 +3,46 @@ ---@tag gopher.nvim-comments

---@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 = {} ----@param name string ----@return string ----@dochide -local function template(name) - return "// " .. name .. " " -end - +--- 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 ---@return string ---@dochide -local function generate(bufnr) +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 s_ok, s_res = pcall(ts.get_struct_under_cursor, bufnr) if s_ok then - return template(s_res.name) + 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 .. " " end local f_ok, f_res = pcall(ts.get_func_under_cursor, bufnr) if f_ok then - return template(f_res.name) + return u.indent(line, f_res.indent) .. "// " .. f_res.name .. " " end local i_ok, i_res = pcall(ts.get_interface_under_cursor, bufnr) if i_ok then - return template(i_res.name) + return u.indent(line, i_res.indent) .. "// " .. i_res.name .. " " end local p_ok, p_res = pcall(ts.get_package_under_cursor, bufnr)

@@ -45,12 +55,16 @@ end

function comment.comment() local bufnr = vim.api.nvim_get_current_buf() - local cmt = generate(bufnr) - log.debug("generated comment: " .. cmt) + 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 pos = vim.fn.getcurpos()[2] - vim.fn.append(pos - 1, cmt) - vim.fn.setpos(".", { 0, pos, #cmt }) + vim.fn.append(lnum - 1, cmt) + vim.fn.setpos(".", { bufnr, lnum, #cmt }) vim.cmd "startinsert!" end
M lua/gopher/config.lua

@@ -1,3 +1,6 @@

+---@type gopher.Config +---@dochide +---@diagnostic disable-next-line: missing-fields .setup() gets injected later local config = {} ---@tag gopher.nvim-config.ConfigGoTagTransform

@@ -16,6 +19,7 @@ ---@toc_entry 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

@@ -25,7 +29,8 @@ -- timeout for running internal commands

---@type number timeout = 2000, - --- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync) + -- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync) + ---@type number installer_timeout = 999999, -- user specified paths to binaries

@@ -39,12 +44,15 @@ iferr = "iferr",

}, ---@class gopher.ConfigGotests gotests = { - -- gotests doesn't have template named "default" so this plugin uses "default" to set the default template + -- a default template that gotess will use. + -- gotets doesn't have template named `default`, we use it to represent absence of the provided template. template = "default", + -- path to a directory containing custom test code templates ---@type string|nil template_dir = nil, - -- switch table tests from using slice to map (with test name for the key) + + -- use named tests(map with test name as key) in table tests(slice of structs by default) named = false, }, ---@class gopher.ConfigGoTag

@@ -54,9 +62,15 @@ 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` + ---@type string|nil + option = nil, }, iferr = { - -- choose a custom error message + -- choose a custom error message, nil to use default + -- e.g: `message = 'fmt.Errorf("failed to %w", err)'` ---@type string|nil message = nil, },

@@ -92,13 +106,14 @@ vim.validate("commands.impl", _config.commands.impl, "string")

vim.validate("commands.iferr", _config.commands.iferr, "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", true) + vim.validate("gotests.template_dir", _config.gotests.template_dir, { "string", "nil" }) 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", true) + vim.validate("iferr.message", _config.iferr.message, { "string", "nil" }) end setmetatable(config, {

@@ -108,5 +123,4 @@ end,

}) ---@dochide ----@return gopher.Config -return config --[[ @as gopher.Config ]] +return config
A lua/gopher/go.lua

@@ -0,0 +1,56 @@

+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
M lua/gopher/gotests.lua

@@ -3,17 +3,18 @@ ---@tag gopher.nvim-gotests

---@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 can be found at: 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: https://github.com/cweill/gotests --- --- If you prefer named tests, you can enable them in |gopher.nvim-config|.
M lua/gopher/health.lua

@@ -1,62 +1,58 @@

+local c = require("gopher.config").commands local health = {} -local cmd = require("gopher.config").commands local deps = { + vim_version = "nvim-0.10", bin = { { - bin = cmd.go, + bin = c.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 string ----@return boolean -local function is_binary_found(bin) - return vim.fn.executable(bin) == 1 +---@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 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 +---@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 end function health.check() - vim.health.start "required binaries" - vim.health.info "all those binaries can be installed by `:GoInstallDeps`" + 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`)" for _, bin in ipairs(deps.bin) do - 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 + check_binary(bin) end - vim.health.start "required treesitter parsers" + vim.health.start "Treesitter" for _, parser in ipairs(deps.treesitter) do - 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 + check_treesitter(parser) end end
M lua/gopher/iferr.lua

@@ -42,7 +42,7 @@ end

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

@@ -3,23 +3,24 @@ ---@tag gopher.nvim-impl

---@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
M lua/gopher/init.lua

@@ -13,7 +13,7 @@

local log = require "gopher._utils.log" local tags = require "gopher.struct_tags" local tests = require "gopher.gotests" -local gocmd = require("gopher._utils.gocmd").run +local go = require "gopher.go" 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 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. +---@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. gopher.install_deps = require("gopher.installer").install_deps gopher.impl = require("gopher.impl").impl

@@ -58,20 +58,9 @@ exported = tests.all_exported_tests,

all = tests.all_tests, } -gopher.get = function(...) - gocmd("get", ...) -end - -gopher.mod = function(...) - gocmd("mod", ...) -end - -gopher.generate = function(...) - gocmd("generate", ...) -end - -gopher.work = function(...) - gocmd("work", ...) -end +gopher.get = go.get +gopher.mod = go.mod +gopher.work = go.work +gopher.generate = go.generate return gopher
M lua/gopher/struct_tags.lua

@@ -1,15 +1,20 @@

---@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 tags to struct fields: +--- How to add/remove/clear 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 --- ---- To clear all tags from struct run: `:GoTagClear` +--- 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` +--- --- --- NOTE: if you dont specify the tag it will use `json` as default ---

@@ -39,7 +44,7 @@ local struct_tags = {}

---@dochide ---@class gopher.StructTagInput ----@field tags string[] User provided tags +---@field input string[] User provided tags ---@field range? gopher.StructTagRange (optional) ---@dochide

@@ -102,18 +107,52 @@ res["lines"]

) end +---@dochide +---@param option string +local function option_to_tag(option) + return option:match "^(.-)=" +end + +---@dochide ---@param args string[] ----@return 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 + end + return out +end + +---@dochide +---@class gopher.StructTagsArgs +---@field tags string +---@field options string + ---@dochide -local function handler_user_tags(args) - if #args == 0 then - return c.gotag.default_tag +---@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 table.concat(args, ",") + + 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 |gopher.nvim-struct-tags| +-- Adds tags to a struct under the cursor. See `:h gopher.nvim-struct-tags`. ---@param opts gopher.StructTagInput ---@dochide function struct_tags.add(opts)

@@ -122,12 +161,16 @@

local fpath = vim.fn.expand "%" local bufnr = vim.api.nvim_get_current_buf() - local user_tags = handler_user_tags(opts.tags) - handle_tags(fpath, bufnr, opts.range, { "-add-tags", user_tags }) + 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, + }) 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)

@@ -136,12 +179,17 @@

local fpath = vim.fn.expand "%" local bufnr = vim.api.nvim_get_current_buf() - local user_tags = handler_user_tags(opts.tags) - handle_tags(fpath, bufnr, opts.range, { "-remove-tags", user_tags }) + 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, + }) 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 "%"
M plugin/gopher.lua

@@ -48,7 +48,7 @@

-- :GoTag cmd("GoTagAdd", function(opts) require("gopher").tags.add { - tags = opts.fargs, + input = 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 { - tags = opts.fargs, + input = opts.fargs, range = (opts.count ~= -1) and { start = opts.line1, end_ = opts.line2,

@@ -98,5 +98,5 @@ require("gopher").get(opts.fargs)

end, "*") cmd("GoGenerate", function(opts) - require("gopher").generate(opts.fargs or "") + require("gopher").generate(opts.fargs or { "" }) end, "?")
M scripts/minimal_init.lua

@@ -20,7 +20,6 @@ :wait()

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
A spec/fixtures/comment/interface_many_method_input.go

@@ -0,0 +1,6 @@

+package main + +type Testinger interface { + Get(id string) int + Set(id string, val int) +}
A spec/fixtures/comment/interface_many_method_output.go

@@ -0,0 +1,7 @@

+package main + +type Testinger interface { + Get(id string) int + // Set + Set(id string, val int) +}
A spec/fixtures/comment/interface_method_input.go

@@ -0,0 +1,5 @@

+package main + +type Testinger interface { + Method(input string) error +}
A spec/fixtures/comment/interface_method_output.go

@@ -0,0 +1,6 @@

+package main + +type Testinger interface { + // Method + Method(input string) error +}
A spec/fixtures/comment/many_structs_fields_input.go

@@ -0,0 +1,18 @@

+package main + +type ( + TestOne struct { + Asdf string + ID int + } + + TestTwo struct { + Fesa int + A bool + } + + TestThree struct { + Asufj int + Fs string + } +)
A spec/fixtures/comment/many_structs_fields_output.go

@@ -0,0 +1,19 @@

+package main + +type ( + TestOne struct { + Asdf string + ID int + } + + TestTwo struct { + // Fesa + Fesa int + A bool + } + + TestThree struct { + Asufj int + Fs string + } +)
A spec/fixtures/comment/struct_fields_input.go

@@ -0,0 +1,7 @@

+package main + +type CommentStruct struct { + Name string + Address string + Aliases []string +}
A spec/fixtures/comment/struct_fields_output.go

@@ -0,0 +1,8 @@

+package main + +type CommentStruct struct { + Name string + // Address + Address string + Aliases []string +}
A spec/fixtures/comment/svar_input.go

@@ -0,0 +1,5 @@

+package main + +func varTest() { + s := "something" +}
A spec/fixtures/comment/svar_output.go

@@ -0,0 +1,6 @@

+package main + +func varTest() { + // s + s := "something" +}
A spec/fixtures/comment/var_input.go

@@ -0,0 +1,5 @@

+package main + +func test() { + var imAVar string +}
A spec/fixtures/comment/var_output.go

@@ -0,0 +1,6 @@

+package main + +func test() { + // imAVar + var imAVar string +}
A spec/fixtures/comment/var_struct_fields_input.go

@@ -0,0 +1,8 @@

+package main + +func main() { + var s struct { + API string + Key string + } +}
A spec/fixtures/comment/var_struct_fields_output.go

@@ -0,0 +1,9 @@

+package main + +func main() { + var s struct { + API string + // Key + Key string + } +}
A spec/fixtures/tags/overwrite_default_option_input.go

@@ -0,0 +1,8 @@

+package main + +type Test struct { + ID int + Another struct { + Second string + } +}
A spec/fixtures/tags/overwrite_default_option_output.go

@@ -0,0 +1,8 @@

+package main + +type Test struct { + ID int `xml:"id,otheroption"` + Another struct { + Second string `xml:"second,otheroption"` + } `xml:"another,otheroption"` +}
A spec/fixtures/tags/remove_with_option_input.go

@@ -0,0 +1,11 @@

+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"` +}
A spec/fixtures/tags/remove_with_option_output.go

@@ -0,0 +1,11 @@

+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"` +}
A spec/fixtures/tags/with_default_option_input.go

@@ -0,0 +1,8 @@

+package main + +type Test struct { + ID int + Another struct { + Second string + } +}
A spec/fixtures/tags/with_default_option_output.go

@@ -0,0 +1,8 @@

+package main + +type Test struct { + ID int `xml:"id,theoption"` + Another struct { + Second string `xml:"second,theoption"` + } `xml:"another,theoption"` +}
A spec/fixtures/tags/with_option_input.go

@@ -0,0 +1,11 @@

+package main + +type Test struct { + ID int + Name string + Num int64 + Another struct { + First int + Second string + } +}
A spec/fixtures/tags/with_option_output.go

@@ -0,0 +1,11 @@

+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"` +}
M spec/integration/comment_test.lua

@@ -18,6 +18,18 @@ 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

@@ -28,6 +40,22 @@ end

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()
M spec/integration/iferr_test.lua

@@ -14,7 +14,8 @@ 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"
M spec/integration/struct_tags_test.lua

@@ -96,4 +96,52 @@ t.eq(t.readfile(rs.tmp), rs.fixtures.output)

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
M spec/unit/config_test.lua

@@ -7,11 +7,14 @@ require("gopher").setup()

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, }
A spec/unit/struct_tag_test.lua

@@ -0,0 +1,68 @@

+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
M spec/unit/utils_test.lua

@@ -22,4 +22,38 @@ local u = require "gopher._utils"

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
M vhs/iferr.gif

Not showing binary file.

M vhs/iferr.go

@@ -1,6 +1,6 @@

package demos -func ifErr() { +func ifErr() error { out, err := doSomething() _ = out
M vhs/tags.gif

Not showing binary file.

M vhs/tags.tape

@@ -26,6 +26,6 @@ Type ":w" Enter

Sleep 1s Type@400ms "jVjj" -Type ":GoTagAdd xml" Sleep 500ms Enter +Type ":GoTagAdd json=omitempty" Sleep 500ms Enter Sleep 5s