This document describes the LSP-level commands supported by gopls. They cannot be invoked directly by users, and all the details are subject to change, so nobody should rely on this information.
Identifier: gopls.add_dependency
Adds a dependency to the go.mod file for a module.
Args:
{
// The go.mod file URI.
"URI": string,
// Additional args to pass to the go command.
"GoCmdArgs": []string,
// Whether to add a require directive.
"AddRequire": bool,
}
Identifier: gopls.add_import
Ask the server to add an import path to a given Go file. The method will call applyEdit on the client so that clients don't have to apply the edit themselves.
Args:
{
// ImportPath is the target import path that should
// be added to the URI file
"ImportPath": string,
// URI is the file that the ImportPath should be
// added to
"URI": string,
}
Identifier: gopls.apply_fix
Applies a fix to a region of source code.
Args:
{
// The fix to apply.
"Fix": string,
// The file URI for the document to fix.
"URI": string,
// The document range to scan for fixes.
"Range": {
"start": {
"line": uint32,
"character": uint32,
},
"end": {
"line": uint32,
"character": uint32,
},
},
}
Identifier: gopls.check_upgrades
Checks for module upgrades.
Args:
{
// The go.mod file URI.
"URI": string,
// The modules to check.
"Modules": []string,
}
Identifier: gopls.edit_go_directive
Runs go mod edit -go=version for a module.
Args:
{
// Any document URI within the relevant module.
"URI": string,
// The version to pass to `go mod edit -go`.
"Version": string,
}
Identifier: gopls.fetch_vulncheck_result
Fetch the result of latest vulnerability check (govulncheck).
Args:
{
// The file URI.
"URI": string,
}
Result:
map[golang.org/x/tools/gopls/internal/lsp/protocol.DocumentURI]*golang.org/x/tools/gopls/internal/govulncheck.Result
Identifier: gopls.gc_details
Toggle the calculation of gc annotations.
Args:
string
Identifier: gopls.generate
Runs go generate for a given directory.
Args:
{
// URI for the directory to generate.
"Dir": string,
// Whether to generate recursively (go generate ./...)
"Recursive": bool,
}
Identifier: gopls.go_get_package
Runs go get to fetch a package.
Args:
{
// Any document URI within the relevant module.
"URI": string,
// The package to go get.
"Pkg": string,
"AddRequire": bool,
}
Identifier: gopls.list_imports
Retrieve a list of imports in the given Go file, and the package it belongs to.
Args:
{
// The file URI.
"URI": string,
}
Result:
{
// Imports is a list of imports in the requested file.
"Imports": []{
"Path": string,
"Name": string,
},
// PackageImports is a list of all imports in the requested file's package.
"PackageImports": []{
"Path": string,
},
}
Identifier: gopls.list_known_packages
Retrieve a list of packages that are importable from the given URI.
Args:
{
// The file URI.
"URI": string,
}
Result:
{
// Packages is a list of packages relative
// to the URIArg passed by the command request.
// In other words, it omits paths that are already
// imported or cannot be imported due to compiler
// restrictions.
"Packages": []string,
}
Identifier: gopls.mem_stats
Call runtime.GC multiple times and return memory statistics as reported by runtime.MemStats.
This command is used for benchmarking, and may change in the future.
Result:
{
"HeapAlloc": uint64,
"HeapInUse": uint64,
"TotalAlloc": uint64,
}
Identifier: gopls.regenerate_cgo
Regenerates cgo definitions.
Args:
{
// The file URI.
"URI": string,
}
Identifier: gopls.remove_dependency
Removes a dependency from the go.mod file of a module.
Args:
{
// The go.mod file URI.
"URI": string,
// The module path to remove.
"ModulePath": string,
// If the module is tidied apart from the one unused diagnostic, we can
// run `go get module@none`, and then run `go mod tidy`. Otherwise, we
// must make textual edits.
"OnlyDiagnostic": bool,
}
Identifier: gopls.reset_go_mod_diagnostics
Reset diagnostics in the go.mod file of a module.
Args:
{
"URIArg": {
"URI": string,
},
// Optional: source of the diagnostics to reset.
// If not set, all resettable go.mod diagnostics will be cleared.
"DiagnosticSource": string,
}
go work [args...], and apply the resulting go.workIdentifier: gopls.run_go_work_command
edits to the current go.work file.
Args:
{
"ViewID": string,
"InitFirst": bool,
"Args": []string,
}
Identifier: gopls.run_govulncheck
Run vulnerability check (govulncheck).
Args:
{
// Any document in the directory from which govulncheck will run.
"URI": string,
// Package pattern. E.g. "", ".", "./...".
"Pattern": string,
}
Result:
{
// Token holds the progress token for LSP workDone reporting of the vulncheck
// invocation.
"Token": interface{},
}
Identifier: gopls.run_tests
Runs go test for a specific set of test or benchmark functions.
Args:
{
// The test file containing the tests to run.
"URI": string,
// Specific test names to run, e.g. TestFoo.
"Tests": []string,
// Specific benchmarks to run, e.g. BenchmarkFoo.
"Benchmarks": []string,
}
Identifier: gopls.start_debugging
Start the gopls debug server if it isn't running, and return the debug address.
Args:
{
// Optional: the address (including port) for the debug server to listen on.
// If not provided, the debug server will bind to "localhost:0", and the
// full debug URL will be contained in the result.
//
// If there is more than one gopls instance along the serving path (i.e. you
// are using a daemon), each gopls instance will attempt to start debugging.
// If Addr specifies a port, only the daemon will be able to bind to that
// port, and each intermediate gopls instance will fail to start debugging.
// For this reason it is recommended not to specify a port (or equivalently,
// to specify ":0").
//
// If the server was already debugging this field has no effect, and the
// result will contain the previously configured debug URL(s).
"Addr": string,
}
Result:
{
// The URLs to use to access the debug servers, for all gopls instances in
// the serving path. For the common case of a single gopls instance (i.e. no
// daemon), this will be exactly one address.
//
// In the case of one or more gopls instances forwarding the LSP to a daemon,
// URLs will contain debug addresses for each server in the serving path, in
// serving order. The daemon debug address will be the last entry in the
// slice. If any intermediate gopls instance fails to start debugging, no
// error will be returned but the debug URL for that server in the URLs slice
// will be empty.
"URLs": []string,
}
Identifier: gopls.test
Runs go test for a specific set of test or benchmark functions.
Args:
string, []string, []string
Identifier: gopls.tidy
Runs go mod tidy for a module.
Args:
{
// The file URIs.
"URIs": []string,
}
Identifier: gopls.toggle_gc_details
Toggle the calculation of gc annotations.
Args:
{
// The file URI.
"URI": string,
}
Identifier: gopls.update_go_sum
Updates the go.sum file for a module.
Args:
{
// The file URIs.
"URIs": []string,
}
Identifier: gopls.upgrade_dependency
Upgrades a dependency in the go.mod file for a module.
Args:
{
// The go.mod file URI.
"URI": string,
// Additional args to pass to the go command.
"GoCmdArgs": []string,
// Whether to add a require directive.
"AddRequire": bool,
}
Identifier: gopls.vendor
Runs go mod vendor for a module.
Args:
{
// The file URI.
"URI": string,
}
Identifier: gopls.workspace_stats
Query statistics about workspace builds, modules, packages, and files.
This command is intended for internal use only, by the gopls stats command.
Result:
{
"Files": {
"Total": int,
"Largest": int,
"Errs": int,
},
"Views": []{
"GoCommandVersion": string,
"AllPackages": {
"Packages": int,
"LargestPackage": int,
"CompiledGoFiles": int,
"Modules": int,
},
"WorkspacePackages": {
"Packages": int,
"LargestPackage": int,
"CompiledGoFiles": int,
"Modules": int,
},
"Diagnostics": int,
},
}