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.
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:
Feature Contributions tab.Settings.go.addTagsTags and options configured here will be used by the Add Tags command to add tags to struct fields. If promptForTags is true, then user will be prompted for tags and options. By default, json tags are added.
Default:{
"options": "json=omitempty",
"promptForTags": false,
"tags": "json",
"transform": "snakecase",
}
go.alternateToolsAlternate tools or alternate paths for the same tools used by the Go extension. Provide either absolute path or the name of the binary in GOPATH/bin, GOROOT/bin or PATH. Useful when you want to use wrapper script for the Go tools or versioned tools from https://gopkg.in.
go.autocompleteUnimportedPackagesInclude unimported packages in auto-complete suggestions.
Default: false
go.buildFlagsFlags to go build/go test used during build-on-save or running tests. (e.g. [“-ldflags=‘-s’”])
go.buildOnSaveCompiles code on file save using ‘go build -i’ or ‘go test -c -i’. Options are ‘workspace’, ‘package’, or ‘off’.
Allowed Values:[package workspace off]
Default: package
go.buildTagsThe Go build tags to use for all commands, that support a -tags '...' argument. When running tests, go.testTags will be used instead if it was set.
Default: ``
go.coverModeWhen generating code coverage, the value for -covermode. ‘default’ is the default value chosen by the ‘go test’ command.
Allowed Values:[default set count atomic]
Default: default
go.coverOnSaveIf true, runs ‘go test -coverprofile’ on save and shows test coverage.
Default: false
go.coverOnSingleTestIf true, shows test coverage when Go: Test Function at cursor command is run.
Default: false
go.coverOnSingleTestFileIf true, shows test coverage when Go: Test Single File command is run.
Default: false
go.coverOnTestPackageIf true, shows test coverage when Go: Test Package command is run.
Default: true
go.coverShowCountsWhen generating code coverage, should counts be shown as --374--
Default: false
go.coverageDecoratorThis option lets you choose the way to display code coverage. Choose either to highlight the complete line or to show a decorator in the gutter. You can customize the colors and borders for the former and the style for the latter.
Default:{
"coveredBorderColor": "rgba(64,128,128,0.5)",
"coveredGutterStyle": "blockblue",
"coveredHighlightColor": "rgba(64,128,128,0.5)",
"type": "highlight",
"uncoveredBorderColor": "rgba(128,64,64,0.25)",
"uncoveredGutterStyle": "slashyellow",
"uncoveredHighlightColor": "rgba(128,64,64,0.25)",
}
go.coverageOptionsUse these options to control whether only covered or only uncovered code or both should be highlighted after running test coverage
Allowed Values:[showCoveredCodeOnly showUncoveredCodeOnly showBothCoveredAndUncoveredCode]
Default: showBothCoveredAndUncoveredCode
go.delveConfigDelve settings that applies to all debugging sessions. Debug configuration in the launch.json file will override these values.
Default:{
"apiVersion": 2,
"dlvLoadConfig": map[followPointers:true maxArrayValues:64 maxStringLen:64 maxStructFields:-1 maxVariableRecurse:1],
"showGlobalVariables": false,
}
go.docsToolPick ‘godoc’ or ‘gogetdoc’ to get documentation. Not applicable when using the language server.
Allowed Values:[godoc gogetdoc guru]
Default: godoc
go.editorContextMenuCommandsExperimental Feature: Enable/Disable entries from the context menu in the editor.
Default:{
"addImport": true,
"addTags": true,
"debugTestAtCursor": true,
"generateTestForFile": false,
"generateTestForFunction": true,
"generateTestForPackage": false,
"playground": true,
"removeTags": false,
"testAtCursor": true,
"testCoverage": true,
"testFile": false,
"testPackage": false,
"toggleTestFile": true,
}
go.enableCodeLensFeature level setting to enable/disable code lens for references and run/debug tests
Default:{
"references": false,
"runtest": true,
}
go.formatFlagsFlags to pass to format tool (e.g. [“-s”])
go.formatToolNot applicable when using the language server. Choosing ‘goimports’, ‘goreturns’, or ‘gofumports’ will add missing imports and remove unused imports.
Allowed Values:[gofmt goimports goreturns goformat gofumpt gofumports]
Default: goreturns
go.generateTestsFlagsAdditional command line flags to pass to gotests for generating tests.
go.gocodeAutoBuildEnable gocode's autobuild feature. Not applicable when using the language server.
Default: false
go.gocodeFlagsAdditional flags to pass to gocode. Not applicable when using the language server.
Default: [-builtin -ignore-case -unimported-packages]
go.gocodePackageLookupModeUsed to determine the Go package lookup rules for completions by gocode. Only applies when using nsf/gocode. Latest versions of the Go extension uses mdempsky/gocode by default. Not applicable when using the language server.
Allowed Values:[go gb bzl]
Default: go
go.gopathSpecify GOPATH here to override the one that is set as environment variable. The inferred GOPATH from workspace root overrides this, if go.inferGopath is set to true.
efault: <nil>
go.gorootSpecifies the GOROOT to use when no environment variable is set.
efault: <nil>
go.gotoSymbol.ignoreFoldersFolder names (not paths) to ignore while using Go to Symbol in Workspace feature
go.gotoSymbol.includeGorootIf false, the standard library located at $GOROOT will be excluded while using the Go to Symbol in File feature
Default: false
go.gotoSymbol.includeImportsIf false, the import statements will be excluded while using the Go to Symbol in File feature
Default: false
go.inferGopathInfer GOPATH from the workspace root.
Default: false
go.installDependenciesWhenBuildingIf true, then -i flag will be passed to go build everytime the code is compiled. Since Go 1.10, setting this may be unnecessary unless you are in GOPATH mode and do not use the language server.
Default: false
go.languageServerExperimentalFeaturesUse this setting to enable/disable experimental features from the language server.
Default:{
"diagnostics": true,
"documentLink": true,
}
go.languageServerFlagsFlags like -rpc.trace and -logfile to be used while running the language server.
go.lintFlagsFlags to pass to Lint tool (e.g. [“-min_confidence=.8”])
go.lintOnSaveLints code on file save using the configured Lint tool. Options are ‘file’, ‘package’, ‘workspace’ or ‘off’.
Allowed Values:[file package workspace off]
Default: package
go.lintToolSpecifies Lint tool name.
Allowed Values:[golint golangci-lint revive staticcheck]
Default: golint
go.liveErrorsUse gotype on the file currently being edited and report any semantic or syntactic errors found after configured delay.
Default:{
"delay": 500,
"enabled": false,
}
go.logging.levelThe logging level the extension logs at, defaults to ‘error’
Allowed Values:[off error info verbose]
Default: error
go.overwriteGoplsMiddlewareThis option provides a set of flags which determine if vscode-go should intercept certain commands from gopls. These flags assume the gopls settings, which enable codelens from gopls, are also present.
go.playgroundThe flags configured here will be passed through to command goplay
Default:{
"openbrowser": true,
"run": true,
"share": true,
}
go.removeTagsTags and options configured here will be used by the Remove Tags command to remove tags to struct fields. If promptForTags is true, then user will be prompted for tags and options. By default, all tags and options will be removed.
Default:{
"options": "",
"promptForTags": false,
"tags": "",
}
go.testEnvFileAbsolute path to a file containing environment variables definitions. File contents should be of the form key=value.
Default: <nil>
go.testEnvVarsEnvironment variables that will passed to the process that runs the Go tests
go.testFlagsFlags to pass to go test. If null, then buildFlags will be used.
efault: <nil>
go.testOnSaveRun ‘go test’ on save for current package. It is not advised to set this to true when you have Auto Save enabled.
Default: false
go.testTagsThe Go build tags to use for when running tests. If null, then buildTags will be used.
efault: <nil>
go.testTimeoutSpecifies the timeout for go test in ParseDuration format.
Default: 30s
go.toolsEnvVarsEnvironment variables that will passed to the processes that run the Go tools (e.g. CGO_CFLAGS)
go.toolsGopathLocation to install the Go tools that the extension depends on if you don't want them in your GOPATH.
Default: ``
go.trace.serverTrace the communication between VS Code and the Go language server.
Allowed Values:[off messages verbose]
Default: off
go.useCodeSnippetsOnFunctionSuggestComplete functions with their parameter signature, including the variable types
Default: false
go.useCodeSnippetsOnFunctionSuggestWithoutTypeComplete functions with their parameter signature, excluding the variable types
Default: false
go.useGoProxyToCheckForToolUpdatesWhen enabled, the extension automatically checks the Go proxy if there are updates available for Go and the Go tools (at present, only gopls) it depends on and prompts the user accordingly
Default: true
go.useLanguageServerUse the Go language server “gopls” from Google for powering language features like code navigation, completion, formatting & diagnostics.
Default: false
go.vetFlagsFlags to pass to go tool vet (e.g. [“-all”, “-shadow”])
go.vetOnSaveVets code on file save using ‘go tool vet’.
Allowed Values:[package workspace off]
Default: package