gosigns.nvim

Neovim plugin that visualizes some hints for Go.

✨ Features

• Visualizes signs for interfaces with implementations
• Visualizes signs for interface methods that have implementations
• Visualizes signs for structures that implement interfaces
• Visualizes signs for methods of structures that implement interface methods
• Visualizes signs for comments starting with go:. See https://go.dev/doc/comment#syntax
• Highly customizable plugin

📦 Installation

Install the plugin with your preferred package manager:

lazy.nvim

{
    "Yu-Leo/gosigns.nvim",
    ft = "go",
    cmd = {"GosignsEnable", "GosignsDisable", "GosignsToggle"},
    opts = {}, -- for default options. Refer to the configuration section for custom setup.
}

⚡️ Requirements

• LSP with the gopls server
• nvim-treesitter with the go parser installed

⚙️ Configuration

Setup

Default Settings

---@class gosigns.OptsSignsChar
---@field public char string
---@field public hl string
local OptsSignsChar = {}

---@class gosigns.OptsSigns
---@field public priority integer
---@field public chars table<string, gosigns.OptsSignsChar>
local OptsSigns = {}

---@class gosigns.Opts
---@field public signs gosigns.OptsSigns
local defaults = {
  -- Config for signs in left-hand column
  signs = {
    -- https://neovim.io/doc/user/sign.html#sign-priority
    priority = 10,
    -- Config for chars by object types.
    -- To turn off the type set `nil` value
    chars = {
      -- Interfaces with implementations
      interface = {
        char = "↓",
        hl = "Comment",
      },
      -- Interface methods that have implementations
      method_elem = {
        char = "↓",
        hl = "Comment",
      },
      -- Structures that implement interfaces
      struct = {
        char = "↑",
        hl = "Comment",
      },
      -- Structures methods that implement interface methods
      method_declaration = {
        char = "↑",
        hl = "Comment",
      },
      -- Comments starting with `go:`. See https://go.dev/doc/comment#syntax
      go_comment = {
        char = "⭘",
        hl = "Comment",
      },
    },
  },
}

🚀 Usage

Commands

• :GosignsEnable - Enable gosigns
• :GosignsDisable - Disable gosigns
• :GosignsToggle - Toggle gosigns

API

-- Enable gosigns
require("gosigns").enable()

-- Disable gosigns
require("gosigns").disable()

-- Toggle gosigns
require("gosigns").toggle()

-- Redraw gosigns for bufnr
require("gosigns").redraw(bufnr)

Check out my neovim configuration.

🤝 Contributing

PRs and Issues are always welcome.

Author: @Yu-Leo

🫶 Alternatives

maxandron/goplements.nvim

Visualizes Go struct and interface implementations to the right of the definition.

It was taken as the basis of my plugin. I express my gratitude to @maxandron.