This document describes the global settings for gopls inside the editor. The settings block will be called "gopls" and contains a collection of controls for gopls that the editor is not expected to understand or control. These settings can also be configured differently per workspace folder.
In VSCode, this would be a section in your settings.json file that might look like this:
"gopls": { "ui.completion.usePlaceholders": true, ... },
Below is the list of settings that are officially supported for gopls.
Any settings that are experimental or for debugging purposes are marked as such.
To enable all experimental features, use allExperiments: true. You will still be able to independently override specific experimental features.
buildFlags is the set of flags passed on to the build system when invoked. It is applied to queries like go list, which is used when discovering files. The most common use is to set -tags.
Default: [].
env adds environment variables to external commands run by gopls, most notably go list.
Default: {}.
directoryFilters can be used to exclude unwanted directories from the workspace. By default, all directories are included. Filters are an operator, + to include and - to exclude, followed by a path prefix relative to the workspace folder. They are evaluated in order, and the last filter that applies to a path controls whether it is included. The path prefix can be empty, so an initial - excludes everything.
DirectoryFilters also supports the ** operator to match 0 or more directories.
Examples:
Exclude node_modules at current depth: -node_modules
Exclude node_modules at any depth: -**/node_modules
Include only project_a: - (exclude everything), +project_a
Include only project_a, but not node_modules inside it: -, +project_a, -project_a/node_modules
Default: ["-**/node_modules"].
templateExtensions gives the extensions of file names that are treateed as template files. (The extension is the part of the file name after the final dot.)
Default: [].
This setting is experimental and may be deleted.
obsolete, no effect
Default: "".
This setting is experimental and may be deleted.
expandWorkspaceToModule instructs gopls to adjust the scope of the workspace to find the best available module root. gopls first looks for a go.mod file in any parent directory of the workspace folder, expanding the scope to that directory if it exists. If no viable parent directory is found, gopls will check if there is exactly one child directory containing a go.mod file, narrowing the scope to that directory if it exists.
Default: true.
This setting is experimental and may be deleted.
allowModfileModifications disables -mod=readonly, allowing imports from out-of-scope modules. This option will eventually be removed.
Default: false.
This setting is experimental and may be deleted.
allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module downloads rather than requiring user action. This option will eventually be removed.
Default: false.
standaloneTags specifies a set of build constraints that identify individual Go source files that make up the entire main package of an executable.
A common example of standalone main files is the convention of using the directive //go:build ignore to denote files that are not intended to be included in any package, for example because they are invoked directly by the developer using go run.
Gopls considers a file to be a standalone main file if and only if it has package name “main” and has a build directive of the exact form “//go:build tag” or “// +build tag”, where tag is among the list of tags configured by this setting. Notably, if the build constraint is more complicated than a simple tag (such as the composite constraint //go:build tag && go1.18), the file is not considered to be a standalone main file.
This setting is only supported when gopls is built with Go 1.16 or later.
Default: ["ignore"].
local is the equivalent of the goimports -local flag, which puts imports beginning with this string after third-party packages. It should be the prefix of the import path whose imports should be grouped separately.
Default: "".
gofumpt indicates if we should run gofumpt formatting.
Default: false.
codelenses overrides the enabled/disabled state of code lenses. See the “Code Lenses” section of the Settings page for the list of supported lenses.
Example Usage:
"gopls": { ... "codelenses": { "generate": false, // Don't show the `go generate` lens. "gc_details": true // Show a code lens toggling the display of gc's choices. } ... }
Default: {"gc_details":false,"generate":true,"regenerate_cgo":true,"tidy":true,"upgrade_dependency":true,"vendor":true}.
This setting is experimental and may be deleted.
semanticTokens controls whether the LSP server will send semantic tokens to the client.
Default: false.
This setting is experimental and may be deleted.
noSemanticString turns off the sending of the semantic token ‘string’
Default: false.
This setting is experimental and may be deleted.
noSemanticNumber turns off the sending of the semantic token ‘number’
Default: false.
placeholders enables placeholders for function parameters or struct fields in completion responses.
Default: false.
This setting is for debugging purposes only.
completionBudget is the soft latency goal for completion requests. Most requests finish in a couple milliseconds, but in some cases deep completions can take much longer. As we use up our budget we dynamically reduce the search scope to ensure we return timely results. Zero means unlimited.
Default: "100ms".
This is an advanced setting and should not be configured by most gopls users.
matcher sets the algorithm that is used when calculating completion candidates.
Must be one of:
"CaseInsensitive""CaseSensitive""Fuzzy"Default: "Fuzzy".
This setting is experimental and may be deleted.
experimentalPostfixCompletions enables artificial method snippets such as “someSlice.sort!”.
Default: true.
completeFunctionCalls enables function call completion.
When completing a statement, or when a function return type matches the expected of the expression being completed, completion may suggest call expressions (i.e. may include parentheses).
Default: true.
analyses specify analyses that the user would like to enable or disable. A map of the names of analysis passes that should be enabled/disabled. A full list of analyzers that gopls uses can be found in analyzers.md.
Example Usage:
... "analyses": { "unreachable": false, // Disable the unreachable analyzer. "unusedparams": true // Enable the unusedparams analyzer. } ...
Default: {}.
This setting is experimental and may be deleted.
staticcheck enables additional analyses from staticcheck.io. These analyses are documented on Staticcheck's website.
Default: false.
This setting is experimental and may be deleted.
annotations specifies the various kinds of optimization diagnostics that should be reported by the gc_details command.
Can contain any of:
"bounds" controls bounds checking diagnostics."escape" controls diagnostics about escape choices."inline" controls diagnostics about inlining choices."nil" controls nil checks.Default: {"bounds":true,"escape":true,"inline":true,"nil":true}.
This setting is experimental and may be deleted.
vulncheck enables vulnerability scanning.
Must be one of:
"Imports": In Imports mode, gopls will report vulnerabilities that affect packages directly and indirectly used by the analyzed main module."Off": Disable vulnerability analysis.Default: "Off".
This is an advanced setting and should not be configured by most gopls users.
diagnosticsDelay controls the amount of time that gopls waits after the most recent file modification before computing deep diagnostics. Simple diagnostics (parsing and type-checking) are always run immediately on recently modified packages.
This option must be set to a valid duration string, for example "250ms".
Default: "1s".
This setting is experimental and may be deleted.
diagnosticsTrigger controls when to run diagnostics.
Must be one of:
"Edit": Trigger diagnostics on file edit and save. (default)"Save": Trigger diagnostics only on file save. Events like initial workspace load or configuration change will still trigger diagnostics.Default: "Edit".
analysisProgressReporting controls whether gopls sends progress notifications when construction of its index of analysis facts is taking a long time. Cancelling these notifications will cancel the indexing task, though it will restart after the next change in the workspace.
When a package is opened for the first time and heavyweight analyses such as staticcheck are enabled, it can take a while to construct the index of analysis facts for all its dependencies. The index is cached in the filesystem, so subsequent analysis should be faster.
Default: true.
hoverKind controls the information that appears in the hover text. SingleLine and Structured are intended for use only by authors of editor plugins.
Must be one of:
"FullDocumentation""NoDocumentation""SingleLine""Structured" is an experimental setting that returns a structured hover format. This format separates the signature from the documentation, so that the client can do more manipulation of these fields."SynopsisDocumentation"Default: "FullDocumentation".
linkTarget controls where documentation links go. It might be one of:
"godoc.org""pkg.go.dev"If company chooses to use its own godoc.org, its address can be used as well.
Modules matching the GOPRIVATE environment variable will not have documentation links in hover.
Default: "pkg.go.dev".
linksInHover toggles the presence of links to documentation in hover.
Default: true.
This setting is experimental and may be deleted.
hints specify inlay hints that users want to see. A full list of hints that gopls uses can be found in inlayHints.md.
Default: {}.
importShortcut specifies whether import statements should link to documentation or go to definitions.
Must be one of:
"Both""Definition""Link"Default: "Both".
This is an advanced setting and should not be configured by most gopls users.
symbolMatcher sets the algorithm that is used when finding workspace symbols.
Must be one of:
"CaseInsensitive""CaseSensitive""FastFuzzy""Fuzzy"Default: "FastFuzzy".
This is an advanced setting and should not be configured by most gopls users.
symbolStyle controls how symbols are qualified in symbol responses.
Example Usage:
"gopls": { ... "symbolStyle": "Dynamic", ... }
Must be one of:
"Dynamic" uses whichever qualifier results in the highest scoring match for the given symbol query. Here a “qualifier” is any “/” or “.” delimited suffix of the fully qualified symbol. i.e. “to/pkg.Foo.Field” or just “Foo.Field”."Full" is fully qualified symbols, i.e. “path/to/pkg.Foo.Field”."Package" is package qualified symbols i.e. “pkg.Foo.Field”.Default: "Dynamic".
symbolScope controls which packages are searched for workspace/symbol requests. The default value, “workspace”, searches only workspace packages. The legacy behavior, “all”, causes all loaded packages to be searched, including dependencies; this is more expensive and may return unwanted results.
Must be one of:
"all" matches symbols in any loaded package, including dependencies."workspace" matches symbols in workspace packages only.Default: "all".
This setting is for debugging purposes only.
verboseOutput enables additional debug logging.
Default: false.
newDiff enables the new diff implementation. If this is “both”, for now both diffs will be run and statistics will be generated in a file in $TMPDIR. This is a risky setting; help in trying it is appreciated. If it is “old” the old implementation is used, and if it is “new”, just the new implementation is used. This setting will eventually be deleted, once gopls has fully migrated to the new diff algorithm.
Default: ‘both’.
These are the code lenses that gopls currently supports. They can be enabled and disabled using the codelenses setting, documented above. Their names and features are subject to change.
Identifier: gc_details
Toggle the calculation of gc annotations.
Identifier: generate
Runs go generate for a given directory.
Identifier: regenerate_cgo
Regenerates cgo definitions.
Identifier: run_govulncheck
Run vulnerability check (govulncheck).
Identifier: test
Runs go test for a specific set of test or benchmark functions.
Identifier: tidy
Runs go mod tidy for a module.
Identifier: upgrade_dependency
Upgrades a dependency in the go.mod file for a module.
Identifier: vendor
Runs go mod vendor for a module.