ardango.nvim

This plugin exposes utility functions to enhance coding Go in Neovim.

Exposed functions:

• RunCurrTest: Runs the test under the cursor and shows the results in a popup window by default. Takes an optional opts table ({ quickfix = true } or { telescope = true }) to show them in the quickfix list or a Telescope picker instead, or { verbose = true } to also list passing tests as a single green line each (instead of only showing failures) — see lua/ardango/ui.lua's show_results for the full set of opts. { dry_run = true } doesn't run anything — it just notifies the exact go test/go build command that would've run (also works on RunFileTests/RunPackageTests/RunCurrBenchmark/BuildCurrPackage, see below).
• RunFileTests: Runs every test declared in the current buffer. Same opts as RunCurrTest.
• RunPackageTests: Runs every test in the current package (whole directory, not just the current file). Same opts as RunCurrTest.
• RunCurrBenchmark: Runs the benchmark under the cursor (go test -bench '^Name$' -run '^$' -benchmem) and shows the results (ns/op, allocation stats) in a popup by default. Same opts as RunCurrTest, except opts.verbose is a no-op — go test has no verbose flag for benchmarks.
• BuildCurrPackage: Build the package in the current dir. Takes the same optional opts table as RunCurrTest.
• CopyLastCmd: Copies the most recently computed go test/go build command (from any Run*/BuildCurrPackage call above — a dry run or a real one, either counts) onto the system clipboard (the "+" register), so it can be pasted into a terminal and run manually.
• RunLastTest: Re-runs whatever Run*/BuildCurrPackage invocation was most recently computed (test, benchmark, or build — whatever it was), without needing to reposition the cursor. Takes an optional opts table merged over (and overriding) the opts used last time. Always actually runs, even if the last invocation was itself a { dry_run = true } preview — pass { dry_run = true } again if you want to re-preview instead.
• OrgBufImports: Update imports of the current buffer.
• SignatureInStatusLine: Shows the element under the cursor's signature info on hover. By default a one-line summary is shown via vim.notify (close to the statusline); pass { float = true } to instead open a floating window with the full hover content, via the same vim.lsp.util.open_floating_preview vim.lsp.buf.hover() itself uses.
• AddTagToField: Adds go tag element to the struct field under the cursor, can handle exisiting elements. Prompts for the tag name via a fuzzy-searchable Telescope picker of common names (json, yaml, db, validate, xml) — typing something that doesn't match any of them uses what you typed instead. Then a single combined prompt handles both the tag value and its common options: <Tab>-toggle any of omitempty/-/required (they stay selected as you type, even though typing filters the visible list), then type the value (empty defaults to the snake cased field name) and confirm with <CR>. Picking - wins over everything else, since a bare - means "skip this field" per Go tag convention. Falls back to plain vim.ui.input prompts (value,option1,option2) if telescope.nvim isn't installed. All struct-tag commands re-run the buffer through gofmt afterward (if it's on PATH) so the struct's columns stay aligned — splicing raw text in doesn't otherwise re-align them.
• AddTagsToStruct: Adds go tag element to all fields inside the struct under the cursor, can handle exisiting elements. Same prompts as AddTagToField. If no value is passed the snake cased field name will be the element value.
• RemoveTagFromField: Removes a tag element from the field under the cursor. Same prompts as AddTagToField.
• RemoveTagsFromStruct: Removes a tag element from all the fields inside the struct under the cursor. Same prompts as AddTagToField.
• AddTagToVisualFields: Adds a tag element to every field declared inside the last visual selection (within the struct under the cursor) — same prompts as AddTagToField, but scoped to the selected lines instead of every field or just one. Meant to be called from a Visual-mode keymap (see below) so the '</'> marks are set before it runs.
• RemoveTagFromVisualFields: Removes a tag element from every field declared inside the last visual selection. Same prompt as RemoveTagFromField.

Ex command

Every function above is also reachable from the cmdline via :Ardango <Command> [flag...], with tab completion for both the command name and any boolean flags (quickfix, telescope, verbose, dry_run, float) it accepts — handy if you don't want to set up keymaps for everything. OrgBufImports/SignatureInStatusLine take a milliseconds number instead of/alongside flags (defaults to 1000 if omitted). Examples:

:Ardango RunCurrTest
:Ardango RunCurrTest quickfix verbose
:Ardango RunCurrTest dry_run
:Ardango RunLastTest
:Ardango AddTagToField
:Ardango SignatureInStatusLine 500 float

Dependencies

• nvim-treesitter
• nvim-lspconfig
• nui.nvim
• telescope.nvim — optional: used for the tag name/value prompts (AddTagToField & co.), and for browsing test/build failures when you pass { telescope = true }. Falls back to plain vim.ui.input/the quickfix list if it isn't installed.
• gofmt — optional, ships with the Go toolchain (so present anywhere go is): used to re-align struct columns after a tag edit. Skipped silently if it isn't on PATH.

Run :checkhealth ardango to verify the go binary, the Go treesitter parser, and these dependencies are all in place. :help ardango covers every command and config option in more detail than this README.

Install

With the dependencies installed add to your favorite package manager:

use 'ardanlabs/ardango.nvim'

Plug 'ardanlabs/ardango.nvim'

How to use

Configuring the results popup:

require("ardango").setup({
  popup = {
    border = "single",    -- default: "rounded"
    size = "80%",         -- default: "50%"
    relative = "editor",  -- default: "cursor"
    position = "50%",     -- default: 0
  },
  -- Options offered (via <Tab>-toggle) in AddTagToField/AddTagsToStruct's
  -- value+options prompt. Replaces the default list entirely.
  tag_options = { "omitempty", "-", "required", "unique", "index" },
})

setup() is optional — everything works with its defaults if you skip it. Popup fields are passed straight through to nui.Popup (:h nui.popup), so any shape it accepts for size/position works here too.

Setting as an autocommand:

local ardango = require "ardango"

-- Update imports on save.
vim.api.nvim_create_autocmd("BufWritePre", {
  group = "my_augroup",
  pattern = "*.go",
  callback = function() ardango.OrgBufImports(1000) end,
})

Setting as a keymap:

local ardango = require "ardango"

local opts = { noremap = true, silent = true }
-- Set the keymap to test the package under the cursor.
vim.keymap.set('n', '<leader>gt', ardango.RunCurrTest, opts)
-- Same, but browse failures via the quickfix list instead of a popup.
vim.keymap.set('n', '<leader>gq', function() ardango.RunCurrTest({ quickfix = true }) end, opts)
-- Same, but browse failures via Telescope instead of a popup (needs
-- telescope.nvim installed).
vim.keymap.set('n', '<leader>gs', function() ardango.RunCurrTest({ telescope = true }) end, opts)
-- Set the keymap to run every test in the current file.
vim.keymap.set('n', '<leader>gf', ardango.RunFileTests, opts)
-- Set the keymap to run every test in the current package.
vim.keymap.set('n', '<leader>ga', ardango.RunPackageTests, opts)
-- Set the keymap to run the benchmark under the cursor.
vim.keymap.set('n', '<leader>gb', ardango.RunCurrBenchmark, opts)
-- Set the keymap to build the package under the cursor.
vim.keymap.set('n', '<leader>gp', ardango.BuildCurrPackage, opts)
-- Preview the test command under the cursor without running it.
vim.keymap.set('n', '<leader>gd', function() ardango.RunCurrTest({ dry_run = true }) end, opts)
-- Copy the last computed test/build command to the clipboard.
vim.keymap.set('n', '<leader>gc', ardango.CopyLastCmd, opts)
-- Re-run the last test/build invocation without moving the cursor back.
vim.keymap.set('n', '<leader>gr', ardango.RunLastTest, opts)
-- Adds tag element to the field under the cursor field.
vim.keymap.set('n', '<leader>taf', ardango.AddTagToField, { buffer = 0 })
-- Adds tag element to all fields of the struct under the cursor field.
vim.keymap.set('n', '<leader>tas', ardango.AddTagsToStruct, { buffer = 0 })
-- Removes tag element from the field under the cursor.
vim.keymap.set('n', '<leader>trf', ardango.RemoveTagFromField, { buffer = 0 })
-- Removes tag element from the all fields of the struct under the cursor.
vim.keymap.set('n', '<leader>trs', ardango.RemoveTagsFromStruct, { buffer = 0 })
-- Adds/removes a tag element to/from every field in a visual selection.
-- <Esc> first so leaving Visual mode sets the '</'> marks before the
-- function runs - mapping straight to the Lua function would call it
-- while still in Visual mode, before the marks are up to date.
vim.keymap.set('x', '<leader>tavf', "<Esc>:lua require('ardango').AddTagToVisualFields()<CR>", { buffer = 0 })
vim.keymap.set('x', '<leader>trvf', "<Esc>:lua require('ardango').RemoveTagFromVisualFields()<CR>", { buffer = 0 })
-- Shows the signature of the element under the cursor as a one-line
-- notification, or in a floating window instead.
vim.keymap.set('n', '<leader>gh', function() ardango.SignatureInStatusLine(1000) end, opts)
vim.keymap.set('n', '<leader>gH', function() ardango.SignatureInStatusLine(1000, { float = true }) end, opts)