coc-golang logo Logo concept by @xiyaowong, drawn with AI # coc-golang Go language support for [coc.nvim](https://github.com/neoclide/coc.nvim), powered by the official [gopls](https://go.dev/gopls/) language server and Go tools. [![coc.nvim](https://img.shields.io/badge/coc.nvim-extension-5b9bd5?style=flat-square)](https://github.com/neoclide/coc.nvim) [![Go](https://img.shields.io/badge/Go-tools-00ADD8?style=flat-square&logo=go&logoColor=white)](https://go.dev/) [![Node.js](https://img.shields.io/badge/Node.js-%3E%3D22.18-339933?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/) [Install](#installation) · [Features](#features) · [Commands](#commands) · [Configuration](#configuration) · [Development](#development)
## Overview `coc-golang` brings Go development features to Vim and Neovim through coc.nvim. It uses `gopls` for language intelligence and provides commands for testing, building, formatting, linting, vulnerability checks, and common Go project tasks. ## Installation ### Requirements - Vim or Neovim with [coc.nvim](https://github.com/neoclide/coc.nvim) `0.0.82` or newer - Node.js `22.18` or newer - [Go](https://go.dev/dl/) Install the extension from Vim or Neovim: ```vim :CocInstall coc-golang ``` Open a Go file to activate the extension. If `gopls` is not installed, coc-golang prompts you to install it. You can also install it at any time with: ```vim :CocCommand go.gopls.install ``` ## Features - **Language intelligence:** completion, hover, signature help, diagnostics, navigation, references, rename, code actions, and document symbols through `gopls`. - **Formatting and imports:** format Go code and add or organize imports. - **Build and checks:** build, run, vet, lint, and scan packages or workspaces for known vulnerabilities. - **Tests and benchmarks:** run tests at package, workspace, file, or cursor scope; repeat the previous run; collect coverage; and run benchmarks. - **Project workflows:** manage modules and workspaces, install Go tools, generate code or tests, edit struct tags, and generate interface implementations. - **Go environment:** inspect Go settings and configure environments for `gopls`, Go commands, and installed tools. `gopls` handles language features. `go run`, `go test`, benchmarks, `go doc`, `go get`, `go install` and `go mod init` run in a coc.nvim terminal named **Go**; other command output is shown in the **Go** output channel. ## Commands Run commands with `:CocCommand`, for example: ```vim :CocCommand go.test.package ``` ### Tests and benchmarks - `go.test.package` Run tests in the current package. - `go.test.workspace` Run tests across the workspace. - `go.test.file` Run tests and examples in the current file. - `go.test.cursor` Run the test, benchmark, or example at the cursor. - `go.subtest.cursor` Run the subtest at the cursor. - `go.test.explorer` Choose tests to run from a quick pick. - `go.test.cursorOrPrevious` Run the test at the cursor, or repeat the previous test. - `go.test.previous` Repeat the previous test command. - `go.test.coverage` Run package tests with coverage. - `go.test.cancel` Cancel the current test run. - `go.test.showOutput` Show the Go terminal. - `go.toggle.test.file` Open the corresponding test or source file. - `go.benchmark.package` Run benchmarks in the current package. - `go.benchmark.file` Run benchmarks in the current file. - `go.benchmark.cursor` Run the benchmark at the cursor. - `go.test.generate.file` Generate tests for functions in the current file. - `go.test.generate.package` Generate tests for functions in the current package. - `go.test.generate.function` Generate a test for the function at the cursor. Test generation requires `gotests`. The test explorer is a coc.nvim quick-pick selector; persistent VS Code test explorer UI is not included. ### Build, checks, and code - `go.build.package` Build the current package. - `go.build.workspace` Build packages across the workspace. - `go.run` Run a Go package or file. - `go.generate.package` Run `go generate` in the current package. - `go.vet.package` Run `go vet` on the current package. - `go.vet.workspace` Run `go vet` across the workspace. - `go.lint.package` Lint the current package. - `go.lint.workspace` Lint packages across the workspace. - `go.vulncheck.toggle` Toggle `gopls` vulnerability diagnostics. - `go.fmt.package` Format the current package with `gofmt`. - `go.import.organize` Organize imports in the current file. - `go.import.add` Add an import to the current file. - `go.mod.init` Initialize a Go module. - `go.mod.tidy` Tidy the current module dependencies. - `go.mod.vendor` Copy module dependencies into the vendor directory. - `go.work.sync` Sync workspace dependencies. - `go.get.package` Add or update a module or package dependency. - `go.install.package` Install a Go package. - `go.browse.packages` Browse Go packages. - `go.tags.add` Add struct tags. - `go.tags.remove` Remove struct tags. - `go.tags.clear` Clear struct tags. - `go.impl.cursor` Generate an interface implementation. `gomodifytags` is required for struct tags, and `impl` for interface implementation generation. Vulnerability analysis is provided by `gopls`. ### Go environment and tools Use `go.env`, `go.gopath`, `go.goroot`, `go.version`, and `go.environment.choose` to inspect or select the Go environment. Use `go.locate.tools` to locate installed tools, `go.tools.install` to choose tools to install, or `go.tools.install.` to install a specific tool. `go.gopls.install` installs `gopls`, and `go.languageserver.restart` restarts it. Optional tools include `dlv`, `goimports`, `staticcheck`, `gomodifytags`, `gotests`, `impl`, `golint`, `golangci-lint`, `golangci-lint-v2`, `revive`, `gofumpt`, and `goformat`. Delve can be used with external DAP clients; coc-golang does not provide a debug adapter UI. ## Configuration Add settings to `coc-settings.json`. For example: ```json { "go.useLanguageServer": true, "go.autoInstallGopls": true, "go.languageServerFlags": [], "go.goplsUseDaemon": true, "gopls": {}, "go.buildFlags": [], "go.buildTags": "", "go.formatTool": "default", "go.testTimeout": "30s", "go.testOnSave": false, "go.diagnostic.vulncheck": "Imports" } ``` Setting names, types, and defaults follow [vscode-go](https://github.com/golang/vscode-go). The `gopls` setting accepts gopls options (including dotted keys). Go-specific settings such as build flags, build tags, inlay hints, vulnerability checks, and code lenses are forwarded to gopls unless explicitly set there. Vulnerability analysis uses gopls' import-based diagnostics and built-in `govulncheck` code lens/quick fix; use `go.vulncheck.toggle` to enable or disable import-based diagnostics. Some settings to know: - **Go environment:** `go.goroot`, `go.gopath`, `go.toolsEnvVars`, `go.toolsGopath`, and `go.alternateTools` control the environment and executable paths used by Go commands, `gopls`, and tool installs. Set `go.terminal.activateEnvironment` to export the configured environment to Neovim. - **Formatting:** `go.formatTool` supports `gofmt`, `goimports`, `goformat`, `gofumpt`, and `custom`. With `go.useLanguageServer: false`, the default formatter uses `goimports`. - **Checks:** build and vet on save run when `go.useLanguageServer` is `false`. Lint on save runs when `go.lintTool` is configured. Available lint tools are `staticcheck`, `golint`, `golangci-lint`, `golangci-lint-v2`, and `revive`; diagnostics are reported by coc.nvim. - **Tests:** `go.testFlags` and `go.testTags` fall back to `go.buildFlags` and `go.buildTags`. `go.testTimeout` supplies the test timeout, and `go.testEnvFile` is loaded before `go.testEnvVars`. - **Language server:** set `go.useLanguageServer` to `false` to disable `gopls` and use Go commands and formatters directly. ## Development Install dependencies, then build and type-check: ```sh npm install npm run build npm run typecheck ``` The build writes the extension bundles to `lib/`. ### AI-assisted Most of the code is AI-generated. Direction was manual. ## Scope The persistent VS Code test explorer, Delve debug adapter UI, survey and telemetry, coverage overlays, and rich diagnostic visualization are not included. Update checks cover `gopls` only.