Settings

This extension is highly configurable, and as such, offers a number of settings. These can be configured by modifying your User or Workspace Settings. To navigate to your settings, open the Command Palette (Ctrl+Shift+P) and search for “settings”. The simplest way to modify your settings is through “Preferences: Open Settings (UI)”.

NOTE: Many of these settings don't apply if you are using gopls. Learn more about gopls-specific settings in this documentation.

Latest changes

The settings described below are up-to-date as of June 2020. We do our best to keep documentation current, but if a setting is missing, you can always consult the full list in the Extensions view. Documentation for each setting should also be visible in the Settings UI.

To view the list of settings:

1. Navigate to the Extensions view (Ctrl+Shift+X).
2. Find the Go extension and click on it to open the Extension Editor.
3. Click on the Feature Contributions tab.
4. Scroll through the list under Settings.

Detailed list

A list of popular and notable settings can be found below.

• docsTool
• formatTool
• lintTool
• lintFlags

docsTool

One of "godoc", "gogetdoc", or "guru" (gogetdoc is the default). This is the tool used by the go to definition, signature help, and quick info on hover features. See more information about each of these tools in the Documentation section.

formatTool

One of "gofmt", "goimports", "goreturns", and "goformat" (goreturns is the default). This is the tool used by the formatting and import organization features. See more information about each of these tools in the Formatting section.

lintTool

One of "golint", "staticcheck", "golangci-lint", and "revive" (golint is the default). This is the tool used by the lint-on-save feature. See more information about each of these tools in the Diagnostics section.

lintFlags

This setting can be used to pass additional flags to your lint tool of choice.

Most linters can be configured via special configuration files, but you may still need to pass command-line flags. The configuration documentation for each supported linter is listed here:

• staticcheck
• golangci-lint
• revive

Examples

Enable all [golangci-lint] linters and only show errors in new code:

"go.lintFlags": ["--enable-all", "--new"]

Configure revive to exclude vendor directories and apply extra configuration with a config.toml file:

"go.lintFlags": [
    "-exclude=vendor/...",
    "-config=${workspaceFolder}/config.toml"
]