docs/settings: include enum and enum descriptions
Enum and EnumDescriptions/MarkdownEnumDescriptions carry useful information, especially in gopls analysis and codelenses settings. This CL makes generate.go include the info in the settings.md.
Following Rebecca's suggestion from https://go-review.googlesource.com/c/vscode-go/+/283432 we now manually map map[string]interface{} to Property whenever possible, and use writeProperty for both the Detailed list section and the Gopls setting section.
And, this CL also improves the default value display when it has nested objects. For example, go.delveConfig property's default value.
gocommentToMarkdown is a hack to work around issues that occur when gopls' markdown-style strings are embedded inside tables.
Change-Id: I07434cd58c1b12778a5b980c69e3d4d083deaeb7
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/284936
Trust: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
diff --git a/docs/settings.md b/docs/settings.md
index d99bc74..46f9f43 100644
--- a/docs/settings.md
+++ b/docs/settings.md
@@ -28,514 +28,427 @@
### `go.addTags`
Tags 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.
-
| Properties | Description |
| --- | --- |
-| `options` | Comma separated tag=options pairs to be used by Go: Add Tags command |
-| `promptForTags` | If true, Go: Add Tags command will prompt the user to provide tags, options, transform values instead of using the configured values |
-| `tags` | Comma separated tags to be used by Go: Add Tags command |
-| `template` | Custom format used by Go: Add Tags command for the tag value to be applied |
-| `transform` | Transformation rule used by Go: Add Tags command to add tags |
-| | |
+| `options` | Comma separated tag=options pairs to be used by Go: Add Tags command <br/> Default: `"json=omitempty"` |
+| `promptForTags` | If true, Go: Add Tags command will prompt the user to provide tags, options, transform values instead of using the configured values <br/> Default: `false` |
+| `tags` | Comma separated tags to be used by Go: Add Tags command <br/> Default: `"json"` |
+| `template` | Custom format used by Go: Add Tags command for the tag value to be applied <br/> Default: `""` |
+| `transform` | Transformation rule used by Go: Add Tags command to add tags <br/> Allowed Options: `snakecase`, `camelcase`, `lispcase`, `pascalcase`, `keep` <br/> Default: `"snakecase"` |
-
-Default:{<br/>
- `"options": "json=omitempty"`,<br/>
- `"promptForTags": false`,<br/>
- `"tags": "json"`,<br/>
- `"template": ""`,<br/>
- `"transform": "snakecase"`,<br/>
- }
-
-
+Default:
+```
+{
+ "options" : "json=omitempty",
+ "promptForTags" : false,
+ "tags" : "json",
+ "template" : "",
+ "transform" : "snakecase",
+}
+```
### `go.alternateTools`
Alternate 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. When specified as a workspace setting, the setting is used only when the workspace is marked trusted with "Go: Toggle Workspace Trust Flag".
-
| Properties | Description |
| --- | --- |
-| `go` | Alternate tool to use instead of the go binary or alternate path to use for the go binary. |
-| `go-outline` | Alternate tool to use instead of the go-outline binary or alternate path to use for the go-outline binary. |
-| `gocode` | Alternate tool to use instead of the gocode binary or alternate path to use for the gocode binary. |
-| `gopkgs` | Alternate tool to use instead of the gopkgs binary or alternate path to use for the gopkgs binary. |
-| `gopls` | Alternate tool to use instead of the gopls binary or alternate path to use for the gopls binary. |
-| `guru` | Alternate tool to use instead of the guru binary or alternate path to use for the guru binary. |
-| | |
-
-
-
+| `go` | Alternate tool to use instead of the go binary or alternate path to use for the go binary. <br/> Default: `"go"` |
+| `go-outline` | Alternate tool to use instead of the go-outline binary or alternate path to use for the go-outline binary. <br/> Default: `"go-outline"` |
+| `gocode` | Alternate tool to use instead of the gocode binary or alternate path to use for the gocode binary. <br/> Default: `"gocode"` |
+| `gopkgs` | Alternate tool to use instead of the gopkgs binary or alternate path to use for the gopkgs binary. <br/> Default: `"gopkgs"` |
+| `gopls` | Alternate tool to use instead of the gopls binary or alternate path to use for the gopls binary. <br/> Default: `"gopls"` |
+| `guru` | Alternate tool to use instead of the guru binary or alternate path to use for the guru binary. <br/> Default: `"guru"` |
### `go.autocompleteUnimportedPackages`
Include unimported packages in auto-complete suggestions. Not applicable when using the language server.
Default: `false`
-
### `go.buildFlags`
Flags to `go build`/`go test` used during build-on-save or running tests. (e.g. ["-ldflags='-s'"]) This is propagated to the language server if `gopls.build.buildFlags` is not specified.
-
### `go.buildOnSave`
-Compiles code on file save using 'go build' or 'go test -c'. Options are 'workspace', 'package', or 'off'. Not applicable when using the language server's diagnostics is used. See 'go.languageServerExperimentalFeatures.diagnostics' setting.
+Compiles code on file save using 'go build' or 'go test -c'. Options are 'workspace', 'package', or 'off'. Not applicable when using the language server's diagnostics is used. See 'go.languageServerExperimentalFeatures.diagnostics' setting.<br/>
+Allowed Options: `package`, `workspace`, `off`
-Allowed Values:`[package workspace off]`
-
-Default: `package`
-
+Default: `"package"`
### `go.buildTags`
The 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. This is propagated to the language server if `gopls.build.buildFlags` is not specified.
-Default: ``
-
+Default: `""`
### `go.coverMode`
-When generating code coverage, the value for -covermode. 'default' is the default value chosen by the 'go test' command.
+When generating code coverage, the value for -covermode. 'default' is the default value chosen by the 'go test' command.<br/>
+Allowed Options: `default`, `set`, `count`, `atomic`
-Allowed Values:`[default set count atomic]`
-
-Default: `default`
-
+Default: `"default"`
### `go.coverOnSave`
If true, runs 'go test -coverprofile' on save and shows test coverage.
Default: `false`
-
### `go.coverOnSingleTest`
If true, shows test coverage when Go: Test Function at cursor command is run.
Default: `false`
-
### `go.coverOnSingleTestFile`
If true, shows test coverage when Go: Test Single File command is run.
Default: `false`
-
### `go.coverOnTestPackage`
If true, shows test coverage when Go: Test Package command is run.
Default: `true`
-
### `go.coverShowCounts`
When generating code coverage, should counts be shown as --374--
Default: `false`
-
### `go.coverageDecorator`
This 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.
-
| Properties | Description |
| --- | --- |
| `coveredBorderColor` | Color to use for the border of covered code. |
-| `coveredGutterStyle` | Gutter style to indicate covered code. |
+| `coveredGutterStyle` | Gutter style to indicate covered code. <br/> Allowed Options: `blockblue`, `blockred`, `blockgreen`, `blockyellow`, `slashred`, `slashgreen`, `slashblue`, `slashyellow`, `verticalred`, `verticalgreen`, `verticalblue`, `verticalyellow` |
| `coveredHighlightColor` | Color in the rgba format to use to highlight covered code. |
-| `type` | |
+| `type` | <br/> <br/> Allowed Options: `highlight`, `gutter` |
| `uncoveredBorderColor` | Color to use for the border of uncovered code. |
-| `uncoveredGutterStyle` | Gutter style to indicate covered code. |
+| `uncoveredGutterStyle` | Gutter style to indicate covered code. <br/> Allowed Options: `blockblue`, `blockred`, `blockgreen`, `blockyellow`, `slashred`, `slashgreen`, `slashblue`, `slashyellow`, `verticalred`, `verticalgreen`, `verticalblue`, `verticalyellow` |
| `uncoveredHighlightColor` | Color in the rgba format to use to highlight uncovered code. |
-| | |
-
-Default:{<br/>
- `"coveredBorderColor": "rgba(64,128,128,0.5)"`,<br/>
- `"coveredGutterStyle": "blockblue"`,<br/>
- `"coveredHighlightColor": "rgba(64,128,128,0.5)"`,<br/>
- `"type": "highlight"`,<br/>
- `"uncoveredBorderColor": "rgba(128,64,64,0.25)"`,<br/>
- `"uncoveredGutterStyle": "slashyellow"`,<br/>
- `"uncoveredHighlightColor": "rgba(128,64,64,0.25)"`,<br/>
- }
-
-
+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.coverageOptions`
-Use these options to control whether only covered or only uncovered code or both should be highlighted after running test coverage
+Use these options to control whether only covered or only uncovered code or both should be highlighted after running test coverage<br/>
+Allowed Options: `showCoveredCodeOnly`, `showUncoveredCodeOnly`, `showBothCoveredAndUncoveredCode`
-Allowed Values:`[showCoveredCodeOnly showUncoveredCodeOnly showBothCoveredAndUncoveredCode]`
-
-Default: `showBothCoveredAndUncoveredCode`
-
+Default: `"showBothCoveredAndUncoveredCode"`
### `go.delveConfig`
Delve settings that applies to all debugging sessions. Debug configuration in the launch.json file will override these values.
-
| Properties | Description |
| --- | --- |
-| `apiVersion` | Delve Api Version to use. Default value is 2. |
-| `dlvLoadConfig` | LoadConfig describes to delve, how to load values from target's memory |
-| `showGlobalVariables` | Boolean value to indicate whether global package variables should be shown in the variables pane or not. |
-| | |
+| `apiVersion` | Delve Api Version to use. Default value is 2. <br/> Allowed Options: `1`, `2` <br/> Default: `2` |
+| `dlvLoadConfig` | LoadConfig describes to delve, how to load values from target's memory <br/> Default: ``` { <pre>"followPointers" : true,<br/>"maxArrayValues" : 64,<br/>"maxStringLen" : 64,<br/>"maxStructFields" : -1,<br/>"maxVariableRecurse" : 1,</pre>} ``` |
+| `showGlobalVariables` | Boolean value to indicate whether global package variables should be shown in the variables pane or not. <br/> Default: `false` |
-
-Default:{<br/>
- `"apiVersion": 2`,<br/>
- `"dlvLoadConfig": map[followPointers:true maxArrayValues:64 maxStringLen:64 maxStructFields:-1 maxVariableRecurse:1]`,<br/>
- `"showGlobalVariables": false`,<br/>
- }
-
-
+Default:
+```
+{
+ "apiVersion" : 2,
+ "dlvLoadConfig" : {
+ "followPointers" : true,
+ "maxArrayValues" : 64,
+ "maxStringLen" : 64,
+ "maxStructFields" : -1,
+ "maxVariableRecurse" : 1,
+ },
+ "showGlobalVariables" : false,
+}
+```
### `go.docsTool`
-Pick 'godoc' or 'gogetdoc' to get documentation. Not applicable when using the language server.
+Pick 'godoc' or 'gogetdoc' to get documentation. Not applicable when using the language server.<br/>
+Allowed Options: `godoc`, `gogetdoc`, `guru`
-Allowed Values:`[godoc gogetdoc guru]`
-
-Default: `godoc`
-
+Default: `"godoc"`
### `go.editorContextMenuCommands`
Experimental Feature: Enable/Disable entries from the context menu in the editor.
-
| Properties | Description |
| --- | --- |
-| `addImport` | If true, adds command to import a package to the editor context menu |
-| `addTags` | If true, adds command to add configured tags from struct fields to the editor context menu |
-| `benchmarkAtCursor` | If true, adds command to benchmark the test under the cursor to the editor context menu |
-| `debugTestAtCursor` | If true, adds command to debug the test under the cursor to the editor context menu |
-| `fillStruct` | If true, adds command to fill struct literal with default values to the editor context menu |
-| `generateTestForFile` | If true, adds command to generate unit tests for current file to the editor context menu |
-| `generateTestForFunction` | If true, adds command to generate unit tests for function under the cursor to the editor context menu |
-| `generateTestForPackage` | If true, adds command to generate unit tests for currnt package to the editor context menu |
-| `playground` | If true, adds command to upload the current file or selection to the Go Playground |
-| `removeTags` | If true, adds command to remove configured tags from struct fields to the editor context menu |
-| `testAtCursor` | If true, adds command to run the test under the cursor to the editor context menu |
-| `testCoverage` | If true, adds command to run test coverage to the editor context menu |
-| `testFile` | If true, adds command to run all tests in the current file to the editor context menu |
-| `testPackage` | If true, adds command to run all tests in the current package to the editor context menu |
-| `toggleTestFile` | If true, adds command to toggle between a Go file and its test file to the editor context menu |
-| | |
+| `addImport` | If true, adds command to import a package to the editor context menu <br/> Default: `true` |
+| `addTags` | If true, adds command to add configured tags from struct fields to the editor context menu <br/> Default: `true` |
+| `benchmarkAtCursor` | If true, adds command to benchmark the test under the cursor to the editor context menu <br/> Default: `true` |
+| `debugTestAtCursor` | If true, adds command to debug the test under the cursor to the editor context menu <br/> Default: `true` |
+| `fillStruct` | If true, adds command to fill struct literal with default values to the editor context menu <br/> Default: `true` |
+| `generateTestForFile` | If true, adds command to generate unit tests for current file to the editor context menu <br/> Default: `true` |
+| `generateTestForFunction` | If true, adds command to generate unit tests for function under the cursor to the editor context menu <br/> Default: `true` |
+| `generateTestForPackage` | If true, adds command to generate unit tests for currnt package to the editor context menu <br/> Default: `true` |
+| `playground` | If true, adds command to upload the current file or selection to the Go Playground <br/> Default: `true` |
+| `removeTags` | If true, adds command to remove configured tags from struct fields to the editor context menu <br/> Default: `true` |
+| `testAtCursor` | If true, adds command to run the test under the cursor to the editor context menu <br/> Default: `true` |
+| `testCoverage` | If true, adds command to run test coverage to the editor context menu <br/> Default: `true` |
+| `testFile` | If true, adds command to run all tests in the current file to the editor context menu <br/> Default: `true` |
+| `testPackage` | If true, adds command to run all tests in the current package to the editor context menu <br/> Default: `true` |
+| `toggleTestFile` | If true, adds command to toggle between a Go file and its test file to the editor context menu <br/> Default: `true` |
-
-Default:{<br/>
- `"addImport": true`,<br/>
- `"addTags": true`,<br/>
- `"benchmarkAtCursor": false`,<br/>
- `"debugTestAtCursor": true`,<br/>
- `"fillStruct": false`,<br/>
- `"generateTestForFile": false`,<br/>
- `"generateTestForFunction": true`,<br/>
- `"generateTestForPackage": false`,<br/>
- `"playground": true`,<br/>
- `"removeTags": false`,<br/>
- `"testAtCursor": true`,<br/>
- `"testCoverage": true`,<br/>
- `"testFile": false`,<br/>
- `"testPackage": false`,<br/>
- `"toggleTestFile": true`,<br/>
- }
-
-
+Default:
+```
+{
+ "addImport" : true,
+ "addTags" : true,
+ "benchmarkAtCursor" : false,
+ "debugTestAtCursor" : true,
+ "fillStruct" : false,
+ "generateTestForFile" : false,
+ "generateTestForFunction" : true,
+ "generateTestForPackage" : false,
+ "playground" : true,
+ "removeTags" : false,
+ "testAtCursor" : true,
+ "testCoverage" : true,
+ "testFile" : false,
+ "testPackage" : false,
+ "toggleTestFile" : true,
+}
+```
### `go.enableCodeLens`
Feature level setting to enable/disable code lens for references and run/debug tests
-
| Properties | Description |
| --- | --- |
-| `references` | If true, enables the references code lens. Uses guru. Recalculates when there is change to the document followed by scrolling. Unnecessary when using the language server; use the call graph feature instead. |
-| `runtest` | If true, enables code lens for running and debugging tests |
-| | |
+| `references` | If true, enables the references code lens. Uses guru. Recalculates when there is change to the document followed by scrolling. Unnecessary when using the language server; use the call graph feature instead. <br/> Default: `false` |
+| `runtest` | If true, enables code lens for running and debugging tests <br/> Default: `true` |
-
-Default:{<br/>
- `"references": false`,<br/>
- `"runtest": true`,<br/>
- }
-
-
+Default:
+```
+{
+ "references" : false,
+ "runtest" : true,
+}
+```
### `go.formatFlags`
Flags to pass to format tool (e.g. ["-s"]). Not applicable when using the language server.
-
### `go.formatTool`
-Not applicable when using the language server. Choosing 'goimports', 'goreturns', or 'gofumports' will add missing imports and remove unused imports.
+Not applicable when using the language server. Choosing 'goimports', 'goreturns', or 'gofumports' will add missing imports and remove unused imports.<br/>
+Allowed Options: `gofmt`, `goimports`, `goreturns`, `goformat`, `gofumpt`, `gofumports`
-Allowed Values:`[gofmt goimports goreturns goformat gofumpt gofumports]`
-
-Default: `goreturns`
-
+Default: `"goreturns"`
### `go.generateTestsFlags`
Additional command line flags to pass to `gotests` for generating tests.
-
### `go.gocodeAutoBuild`
Enable gocode's autobuild feature. Not applicable when using the language server.
Default: `false`
-
### `go.gocodeFlags`
Additional flags to pass to gocode. Not applicable when using the language server.
Default: `[-builtin -ignore-case -unimported-packages]`
-
### `go.gocodePackageLookupMode`
-Used 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.
+Used 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.<br/>
+Allowed Options: `go`, `gb`, `bzl`
-Allowed Values:`[go gb bzl]`
-
-Default: `go`
-
+Default: `"go"`
### `go.gopath`
Specify 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. When specified as a workspace setting, the setting is used only when the workspace is marked trusted with "Go: Toggle Workspace Trust Flag".
-
-efault: `<nil>`
-
### `go.goroot`
Specifies the GOROOT to use when no environment variable is set. When specified as a workspace setting, the setting is used only when the workspace is marked trusted with "Go: Toggle Workspace Trust Flag".
-
-efault: `<nil>`
-
### `go.gotoSymbol.ignoreFolders`
Folder names (not paths) to ignore while using Go to Symbol in Workspace feature. Not applicable when using the language server.
-
### `go.gotoSymbol.includeGoroot`
If false, the standard library located at $GOROOT will be excluded while using the Go to Symbol in File feature. Not applicable when using the language server.
Default: `false`
-
### `go.gotoSymbol.includeImports`
If false, the import statements will be excluded while using the Go to Symbol in File feature. Not applicable when using the language server.
Default: `false`
-
### `go.inferGopath`
Infer GOPATH from the workspace root. This is ignored when using Go Modules. When specified as a workspace setting, the setting is used only when the workspace is marked trusted with "Go: Toggle Workspace Trust Flag".
Default: `false`
-
### `go.installDependenciesWhenBuilding`
If 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.languageServerExperimentalFeatures`
Temporary flag to enable/disable diagnostics from the language server. This setting will be deprecated soon. Please see and response to [Issue 50](https://github.com/golang/vscode-go/issues/50).
-
| Properties | Description |
| --- | --- |
-| `diagnostics` | If true, the language server will provide build, vet errors and the extension will ignore the `buildOnSave`, `vetOnSave` settings. |
-| | |
+| `diagnostics` | If true, the language server will provide build, vet errors and the extension will ignore the `buildOnSave`, `vetOnSave` settings. <br/> Default: `true` |
-
-Default:{<br/>
- `"diagnostics": true`,<br/>
- }
-
-
+Default:
+```
+{
+ "diagnostics" : true,
+}
+```
### `go.languageServerFlags`
Flags like -rpc.trace and -logfile to be used while running the language server.
-
### `go.lintFlags`
Flags to pass to Lint tool (e.g. ["-min_confidence=.8"])
-
### `go.lintOnSave`
-Lints code on file save using the configured Lint tool. Options are 'file', 'package', 'workspace' or 'off'.
+Lints code on file save using the configured Lint tool. Options are 'file', 'package', 'workspace' or 'off'.<br/>
+Allowed Options: `file`, `package`, `workspace`, `off`
-Allowed Values:`[file package workspace off]`
-
-Default: `package`
-
+Default: `"package"`
### `go.lintTool`
-Specifies Lint tool name.
+Specifies Lint tool name.<br/>
+Allowed Options: `golint`, `golangci-lint`, `revive`, `staticcheck`
-Allowed Values:`[golint golangci-lint revive staticcheck]`
-
-Default: `golint`
-
+Default: `"golint"`
### `go.liveErrors`
Use gotype on the file currently being edited and report any semantic or syntactic errors found after configured delay. Not applicable when using the language server.
-
| Properties | Description |
| --- | --- |
-| `delay` | The number of milliseconds to delay before execution. Resets with each keystroke. |
-| `enabled` | If true, runs gotype on the file currently being edited and reports any semantic or syntactic errors found. Disabled when the language server is enabled. |
-| | |
+| `delay` | The number of milliseconds to delay before execution. Resets with each keystroke. <br/> Default: `500` |
+| `enabled` | If true, runs gotype on the file currently being edited and reports any semantic or syntactic errors found. Disabled when the language server is enabled. <br/> Default: `false` |
-
-Default:{<br/>
- `"delay": 500`,<br/>
- `"enabled": false`,<br/>
- }
-
-
+Default:
+```
+{
+ "delay" : 500,
+ "enabled" : false,
+}
+```
### `go.logging.level`
-The logging level the extension logs at, defaults to 'error'
+The logging level the extension logs at, defaults to 'error'<br/>
+Allowed Options: `off`, `error`, `info`, `verbose`
-Allowed Values:`[off error info verbose]`
-
-Default: `error`
-
+Default: `"error"`
### `go.overwriteGoplsMiddleware (deprecated)`
This option is deprecated.
This 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.
-
| Properties | Description |
| --- | --- |
| `codelens` | |
| `default` | |
-| | |
-
-
-
### `go.playground`
The flags configured here will be passed through to command `goplay`
-
| Properties | Description |
| --- | --- |
-| `openbrowser` | Whether to open the created Go Playground in the default browser |
-| `run` | Whether to run the created Go Playground after creation |
-| `share` | Whether to make the created Go Playground shareable |
-| | |
+| `openbrowser` | Whether to open the created Go Playground in the default browser <br/> Default: `true` |
+| `run` | Whether to run the created Go Playground after creation <br/> Default: `true` |
+| `share` | Whether to make the created Go Playground shareable <br/> Default: `true` |
-
-Default:{<br/>
- `"openbrowser": true`,<br/>
- `"run": true`,<br/>
- `"share": true`,<br/>
- }
-
-
+Default:
+```
+{
+ "openbrowser" : true,
+ "run" : true,
+ "share" : true,
+}
+```
### `go.removeTags`
Tags 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.
-
| Properties | Description |
| --- | --- |
-| `options` | Comma separated tag=options pairs to be used by Go: Remove Tags command |
-| `promptForTags` | If true, Go: Remove Tags command will prompt the user to provide tags and options instead of using the configured values |
-| `tags` | Comma separated tags to be used by Go: Remove Tags command |
-| | |
+| `options` | Comma separated tag=options pairs to be used by Go: Remove Tags command <br/> Default: `"json=omitempty"` |
+| `promptForTags` | If true, Go: Remove Tags command will prompt the user to provide tags and options instead of using the configured values <br/> Default: `false` |
+| `tags` | Comma separated tags to be used by Go: Remove Tags command <br/> Default: `"json"` |
-
-Default:{<br/>
- `"options": ""`,<br/>
- `"promptForTags": false`,<br/>
- `"tags": ""`,<br/>
- }
-
-
+Default:
+```
+{
+ "options" : "",
+ "promptForTags" : false,
+ "tags" : "",
+}
+```
### `go.testEnvFile`
Absolute path to a file containing environment variables definitions. File contents should be of the form key=value.
-
-Default: `<nil>`
-
### `go.testEnvVars`
Environment variables that will be passed to the process that runs the Go tests
-
### `go.testFlags`
Flags to pass to `go test`. If null, then buildFlags will be used. This is not propagated to the language server.
-
-efault: `<nil>`
-
### `go.testOnSave`
Run '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.testTags`
The Go build tags to use for when running tests. If null, then buildTags will be used.
-
-efault: `<nil>`
-
### `go.testTimeout`
Specifies the timeout for go test in ParseDuration format.
-Default: `30s`
-
+Default: `"30s"`
### `go.toolsEnvVars`
Environment variables that will be passed to the tools that run the Go tools (e.g. CGO_CFLAGS)
-
### `go.toolsGopath`
Location to install the Go tools that the extension depends on if you don't want them in your GOPATH. When specified as a workspace setting, the setting is used only when the workspace is marked trusted with "Go: Toggle Workspace Trust Flag".
-
-efault: `<nil>`
-
### `go.toolsManagement.checkForUpdates`
-Specify whether to prompt about new versions of Go and the Go tools (currently, only `gopls`) the extension depends on
+Specify whether to prompt about new versions of Go and the Go tools (currently, only `gopls`) the extension depends on<br/>
+Allowed Options:
-Allowed Values:`[proxy local off]`
+* `proxy`: keeps notified of new releases by checking the Go module proxy (GOPROXY)
+* `local`: checks only the minimum tools versions required by the extension
+* `off`: completely disables version check (not recommended)
-Default: `proxy`
+Default: `"proxy"`
### `go.trace.server`
-Trace the communication between VS Code and the Go language server.
+Trace the communication between VS Code and the Go language server.<br/>
+Allowed Options: `off`, `messages`, `verbose`
-Allowed Values:`[off messages verbose]`
-
-Default: `off`
-
+Default: `"off"`
### `go.useCodeSnippetsOnFunctionSuggest`
Complete functions with their parameter signature, including the variable type. Not propagated to the language server.
Default: `false`
-
### `go.useCodeSnippetsOnFunctionSuggestWithoutType`
Complete functions with their parameter signature, excluding the variable types. Use `gopls.usePlaceholders` when using the language server.
Default: `false`
-
### `go.useGoProxyToCheckForToolUpdates (deprecated)`
Use `go.toolsManagement.checkForUpdates` instead.
When 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.useLanguageServer`
Use the Go language server "gopls" from Google for powering language features like code navigation, completion, refactoring, formatting & diagnostics.
Default: `false`
-
### `go.vetFlags`
Flags to pass to `go tool vet` (e.g. ["-all", "-shadow"])
-
### `go.vetOnSave`
-Vets code on file save using 'go tool vet'. Not applicable when using the language server's diagnostics is used. See 'go.languageServerExperimentalFeatures.diagnostics' setting.
+Vets code on file save using 'go tool vet'. Not applicable when using the language server's diagnostics is used. See 'go.languageServerExperimentalFeatures.diagnostics' setting.<br/>
+Allowed Options: `package`, `workspace`, `off`
-Allowed Values:`[package workspace off]`
-
-Default: `package`
-
+Default: `"package"`
### `gopls`
Customize `gopls` behavior by specifying the gopls' settings in this section. For example,
@@ -552,17 +465,22 @@
Configure the default Go language server ('gopls'). In most cases, configuring this section is unnecessary. See [the documentation](https://github.com/golang/tools/blob/master/gopls/doc/settings.md) for all available settings.
### `build.allowImplicitNetworkAccess`
+
(Experimental) allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module
downloads rather than requiring user action. This option will eventually
be removed.
+
Default: `false`
### `build.allowModfileModifications`
+
(Experimental) allowModfileModifications disables -mod=readonly, allowing imports from
out-of-scope modules. This option will eventually be removed.
+
Default: `false`
### `build.buildFlags`
+
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`.
@@ -570,6 +488,7 @@
If unspecified, values of `go.buildFlags, go.buildTags` will be propagated.
### `build.directoryFilters`
+
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
@@ -583,9 +502,11 @@
Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`
### `build.env`
+
env adds environment variables to external commands run by `gopls`, most notably `go list`.
### `build.expandWorkspaceToModule`
+
(Experimental) 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
@@ -593,8 +514,10 @@
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`
### `build.experimentalPackageCacheKey`
+
(Experimental) experimentalPackageCacheKey controls whether to use a coarser cache key
for package type information to increase cache hits. This setting removes
the user's environment, build flags, and working directory from the cache
@@ -603,24 +526,32 @@
by an experiment because caching behavior is subtle and difficult to
comprehensively test.
+
Default: `true`
### `build.experimentalWorkspaceModule`
+
(Experimental) experimentalWorkspaceModule opts a user into the experimental support
for multi-module workspaces.
+
Default: `false`
### `formatting.gofumpt`
+
gofumpt indicates if we should run gofumpt formatting.
+
Default: `false`
### `formatting.local`
+
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: ``
+
+Default: `""`
### `ui.codelenses`
+
codelenses overrides the enabled/disabled state of code lenses. See the
"Code Lenses" section of the
[Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md)
@@ -639,25 +570,42 @@
}
```
+| Properties | Description |
+| --- | --- |
+| `gc_details` | gc_details controls calculation of gc annotations. <br/> <br/> Default: `false` |
+| `generate` | generate runs `go generate` for a given directory. <br/> <br/> Default: `true` |
+| `regenerate_cgo` | regenerate_cgo regenerates cgo definitions. <br/> <br/> Default: `true` |
+| `test` | test runs `go test` for a specific test function. <br/> <br/> Default: `false` |
+| `tidy` | tidy runs `go mod tidy` for a module. <br/> <br/> Default: `true` |
+| `upgrade_dependency` | upgrade_dependency upgrades a dependency. <br/> <br/> Default: `true` |
+| `vendor` | vendor runs `go mod vendor` for a module. <br/> <br/> Default: `true` |
### `ui.completion.completionBudget`
+
(For Debugging) 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`
+
+Default: `"100ms"`
### `ui.completion.matcher`
+
(Advanced) matcher sets the algorithm that is used when calculating completion
candidates.
+<br/>
+Allowed Options: `CaseInsensitive`, `CaseSensitive`, `Fuzzy`
-Default: `Fuzzy`
+Default: `"Fuzzy"`
### `ui.completion.usePlaceholders`
+
placeholders enables placeholders for function parameters or struct
fields in completion responses.
+
Default: `false`
### `ui.diagnostic.analyses`
+
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
@@ -674,11 +622,60 @@
...
```
+| Properties | Description |
+| --- | --- |
+| `asmdecl` | report mismatches between assembly files and Go declarations <br/> Default: `true` |
+| `assign` | check for useless assignments <br/> This checker reports assignments of the form x = x or a[i] = a[i]. These are almost always useless, and even when they aren't they are usually a mistake. <br/> Default: `true` |
+| `atomic` | check for common mistakes using the sync/atomic package <br/> The atomic checker looks for assignment statements of the form: <br/> <pre>x = atomic.AddUint64(&x, 1)</pre><br/> which are not atomic. <br/> Default: `true` |
+| `atomicalign` | check for non-64-bits-aligned arguments to sync/atomic functions <br/> Default: `true` |
+| `bools` | check for common mistakes involving boolean operators <br/> Default: `true` |
+| `buildtag` | check that +build tags are well-formed and correctly located <br/> Default: `true` |
+| `cgocall` | detect some violations of the cgo pointer passing rules <br/> Check for invalid cgo pointer passing. This looks for code that uses cgo to call C code passing values whose types are almost always invalid according to the cgo pointer sharing rules. Specifically, it warns about attempts to pass a Go chan, map, func, or slice to C, either directly, or via a pointer, array, or struct. <br/> Default: `true` |
+| `composites` | check for unkeyed composite literals <br/> This analyzer reports a diagnostic for composite literals of struct types imported from another package that do not use the field-keyed syntax. Such literals are fragile because the addition of a new field (even if unexported) to the struct will cause compilation to fail. <br/> As an example, <br/> <pre>err = &net.DNSConfigError{err}</pre><br/> should be replaced by: <br/> <pre>err = &net.DNSConfigError{Err: err}</pre><br/> <br/> Default: `true` |
+| `copylocks` | check for locks erroneously passed by value <br/> Inadvertently copying a value containing a lock, such as sync.Mutex or sync.WaitGroup, may cause both copies to malfunction. Generally such values should be referred to through a pointer. <br/> Default: `true` |
+| `deepequalerrors` | check for calls of reflect.DeepEqual on error values <br/> The deepequalerrors checker looks for calls of the form: <br/> reflect.DeepEqual(err1, err2) <br/> where err1 and err2 are errors. Using reflect.DeepEqual to compare errors is discouraged. <br/> Default: `true` |
+| `errorsas` | report passing non-pointer or non-error values to errors.As <br/> The errorsas analysis reports calls to errors.As where the type of the second argument is not a pointer to a type implementing error. <br/> Default: `true` |
+| `fieldalignment` | find structs that would take less memory if their fields were sorted <br/> This analyzer find structs that can be rearranged to take less memory, and provides a suggested edit with the optimal order. <br/> <br/> Default: `false` |
+| `fillreturns` | suggested fixes for "wrong number of return values (want %d, got %d)" <br/> This checker provides suggested fixes for type errors of the type "wrong number of return values (want %d, got %d)". For example: <pre>func m() (int, string, *bool, error) {<br/> return<br/>}</pre>will turn into <pre>func m() (int, string, *bool, error) {<br/> return 0, "", nil, nil<br/>}</pre><br/> This functionality is similar to https://github.com/sqs/goreturns. <br/> <br/> Default: `true` |
+| `fillstruct` | note incomplete struct initializations <br/> This analyzer provides diagnostics for any struct literals that do not have any fields initialized. Because the suggested fix for this analysis is expensive to compute, callers should compute it separately, using the SuggestedFix function below. <br/> <br/> Default: `true` |
+| `httpresponse` | check for mistakes using HTTP responses <br/> A common mistake when using the net/http package is to defer a function call to close the http.Response Body before checking the error that determines whether the response is valid: <br/> <pre>resp, err := http.Head(url)<br/>defer resp.Body.Close()<br/>if err != nil {<br/> log.Fatal(err)<br/>}<br/>// (defer statement belongs here)</pre><br/> This checker helps uncover latent nil dereference bugs by reporting a diagnostic for such mistakes. <br/> Default: `true` |
+| `ifaceassert` | detect impossible interface-to-interface type assertions <br/> This checker flags type assertions v.(T) and corresponding type-switch cases in which the static type V of v is an interface that cannot possibly implement the target interface T. This occurs when V and T contain methods with the same name but different signatures. Example: <br/> <pre>var v interface {<br/> Read()<br/>}<br/>_ = v.(io.Reader)</pre><br/> The Read method in v has a different signature than the Read method in io.Reader, so this assertion cannot succeed. <br/> <br/> Default: `true` |
+| `loopclosure` | check references to loop variables from within nested functions <br/> This analyzer checks for references to loop variables from within a function literal inside the loop body. It checks only instances where the function literal is called in a defer or go statement that is the last statement in the loop body, as otherwise we would need whole program analysis. <br/> For example: <br/> <pre>for i, v := range s {<br/> go func() {<br/> println(i, v) // not what you might expect<br/> }()<br/>}</pre><br/> See: https://golang.org/doc/go_faq.html#closures_and_goroutines <br/> Default: `true` |
+| `lostcancel` | check cancel func returned by context.WithCancel is called <br/> The cancellation function returned by context.WithCancel, WithTimeout, and WithDeadline must be called or the new context will remain live until its parent context is cancelled. (The background context is never cancelled.) <br/> Default: `true` |
+| `nilfunc` | check for useless comparisons between functions and nil <br/> A useless comparison is one like f == nil as opposed to f() == nil. <br/> Default: `true` |
+| `nonewvars` | suggested fixes for "no new vars on left side of :=" <br/> This checker provides suggested fixes for type errors of the type "no new vars on left side of :=". For example: <pre>z := 1<br/>z := 2</pre>will turn into <pre>z := 1<br/>z = 2</pre><br/> <br/> Default: `true` |
+| `noresultvalues` | suggested fixes for "no result values expected" <br/> This checker provides suggested fixes for type errors of the type "no result values expected". For example: <pre>func z() { return nil }</pre>will turn into <pre>func z() { return }</pre><br/> <br/> Default: `true` |
+| `printf` | check consistency of Printf format strings and arguments <br/> The check applies to known functions (for example, those in package fmt) as well as any detected wrappers of known functions. <br/> A function that wants to avail itself of printf checking but is not found by this analyzer's heuristics (for example, due to use of dynamic calls) can insert a bogus call: <br/> <pre>if false {<br/> _ = fmt.Sprintf(format, args...) // enable printf checking<br/>}</pre><br/> The -funcs flag specifies a comma-separated list of names of additional known formatting functions or methods. If the name contains a period, it must denote a specific function using one of the following forms: <br/> <pre>dir/pkg.Function<br/>dir/pkg.Type.Method<br/>(*dir/pkg.Type).Method</pre><br/> Otherwise the name is interpreted as a case-insensitive unqualified identifier such as "errorf". Either way, if a listed name ends in f, the function is assumed to be Printf-like, taking a format string before the argument list. Otherwise it is assumed to be Print-like, taking a list of arguments with no format string. <br/> <br/> Default: `true` |
+| `shadow` | check for possible unintended shadowing of variables <br/> This analyzer check for shadowed variables. A shadowed variable is a variable declared in an inner scope with the same name and type as a variable in an outer scope, and where the outer variable is mentioned after the inner one is declared. <br/> (This definition can be refined; the module generates too many false positives and is not yet enabled by default.) <br/> For example: <br/> <pre>func BadRead(f *os.File, buf []byte) error {<br/> var err error<br/> for {<br/> n, err := f.Read(buf) // shadows the function variable 'err'<br/> if err != nil {<br/> break // causes return of wrong value<br/> }<br/> foo(buf)<br/> }<br/> return err<br/>}</pre><br/> <br/> Default: `false` |
+| `shift` | check for shifts that equal or exceed the width of the integer <br/> Default: `true` |
+| `simplifycompositelit` | check for composite literal simplifications <br/> An array, slice, or map composite literal of the form: <pre>[]T{T{}, T{}}</pre>will be simplified to: <pre>[]T{{}, {}}</pre><br/> This is one of the simplifications that "gofmt -s" applies. <br/> Default: `true` |
+| `simplifyrange` | check for range statement simplifications <br/> A range of the form: <pre>for x, _ = range v {...}</pre>will be simplified to: <pre>for x = range v {...}</pre><br/> A range of the form: <pre>for _ = range v {...}</pre>will be simplified to: <pre>for range v {...}</pre><br/> This is one of the simplifications that "gofmt -s" applies. <br/> Default: `true` |
+| `simplifyslice` | check for slice simplifications <br/> A slice expression of the form: <pre>s[a:len(s)]</pre>will be simplified to: <pre>s[a:]</pre><br/> This is one of the simplifications that "gofmt -s" applies. <br/> Default: `true` |
+| `sortslice` | check the argument type of sort.Slice <br/> sort.Slice requires an argument of a slice type. Check that the interface{} value passed to sort.Slice is actually a slice. <br/> Default: `true` |
+| `stdmethods` | check signature of methods of well-known interfaces <br/> Sometimes a type may be intended to satisfy an interface but may fail to do so because of a mistake in its method signature. For example, the result of this WriteTo method should be (int64, error), not error, to satisfy io.WriterTo: <br/> <pre>type myWriterTo struct{...}</pre> func (myWriterTo) WriteTo(w io.Writer) error { ... } <br/> This check ensures that each method whose name matches one of several well-known interface methods from the standard library has the correct signature for that interface. <br/> Checked method names include: <pre>Format GobEncode GobDecode MarshalJSON MarshalXML<br/>Peek ReadByte ReadFrom ReadRune Scan Seek<br/>UnmarshalJSON UnreadByte UnreadRune WriteByte<br/>WriteTo</pre><br/> <br/> Default: `true` |
+| `stringintconv` | check for string(int) conversions <br/> This checker flags conversions of the form string(x) where x is an integer (but not byte or rune) type. Such conversions are discouraged because they return the UTF-8 representation of the Unicode code point x, and not a decimal string representation of x as one might expect. Furthermore, if x denotes an invalid code point, the conversion cannot be statically rejected. <br/> For conversions that intend on using the code point, consider replacing them with string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the string representation of the value in the desired base. <br/> <br/> Default: `true` |
+| `structtag` | check that struct field tags conform to reflect.StructTag.Get <br/> Also report certain struct tags (json, xml) used with unexported fields. <br/> Default: `true` |
+| `testinggoroutine` | report calls to (*testing.T).Fatal from goroutines started by a test. <br/> Functions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and Skip{,f,Now} methods of *testing.T, must be called from the test goroutine itself. This checker detects calls to these functions that occur within a goroutine started by the test. For example: <br/> func TestFoo(t *testing.T) { go func() { t.Fatal("oops") // error: (*T).Fatal called from non-test goroutine }() } <br/> <br/> Default: `true` |
+| `tests` | check for common mistaken usages of tests and examples <br/> The tests checker walks Test, Benchmark and Example functions checking malformed names, wrong signatures and examples documenting non-existent identifiers. <br/> Please see the documentation for package testing in golang.org/pkg/testing for the conventions that are enforced for Tests, Benchmarks, and Examples. <br/> Default: `true` |
+| `undeclaredname` | suggested fixes for "undeclared name: <>" <br/> This checker provides suggested fixes for type errors of the type "undeclared name: <>". It will insert a new statement: "<> := ". <br/> Default: `true` |
+| `unmarshal` | report passing non-pointer or non-interface values to unmarshal <br/> The unmarshal analysis reports calls to functions such as json.Unmarshal in which the argument type is not a pointer or an interface. <br/> Default: `true` |
+| `unreachable` | check for unreachable code <br/> The unreachable analyzer finds statements that execution can never reach because they are preceded by an return statement, a call to panic, an infinite loop, or similar constructs. <br/> Default: `true` |
+| `unsafeptr` | check for invalid conversions of uintptr to unsafe.Pointer <br/> The unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer to convert integers to pointers. A conversion from uintptr to unsafe.Pointer is invalid if it implies that there is a uintptr-typed word in memory that holds a pointer value, because that word will be invisible to stack copying and to the garbage collector. <br/> Default: `true` |
+| `unusedparams` | check for unused parameters of functions <br/> The unusedparams analyzer checks functions to see if there are any parameters that are not being used. <br/> To reduce false positives it ignores: - methods - parameters that do not have a name or are underscored - functions in test files - functions with empty bodies or those with just a return stmt <br/> Default: `false` |
+| `unusedresult` | check for unused results of calls to some functions <br/> Some functions like fmt.Errorf return a result and have no side effects, so it is always a mistake to discard the result. This analyzer reports calls to certain functions in which the result of the call is ignored. <br/> The set of functions may be controlled using flags. <br/> Default: `true` |
### `ui.diagnostic.annotations`
+
(Experimental) annotations specifies the various kinds of optimization diagnostics
that should be reported by the gc_details command.
+| Properties | Description |
+| --- | --- |
+| `bounds` | `"bounds"` controls bounds checking diagnostics. <br/> <br/> Default: `true` |
+| `escape` | `"escape"` controls diagnostics about escape choices. <br/> <br/> Default: `true` |
+| `inline` | `"inline"` controls diagnostics about inlining choices. <br/> <br/> Default: `true` |
+| `nil` | `"nil"` controls nil checks. <br/> <br/> Default: `true` |
### `ui.diagnostic.experimentalDiagnosticsDelay`
+
(Experimental) experimentalDiagnosticsDelay 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
@@ -686,17 +683,33 @@
This option must be set to a valid duration string, for example `"250ms"`.
-Default: `250ms`
+
+Default: `"250ms"`
### `ui.diagnostic.staticcheck`
+
(Experimental) staticcheck enables additional analyses from staticcheck.io.
+
Default: `false`
### `ui.documentation.hoverKind`
+
hoverKind controls the information that appears in the hover text.
SingleLine and Structured are intended for use only by authors of editor plugins.
+<br/>
+Allowed Options:
-Default: `FullDocumentation`
+* `FullDocumentation`
+* `NoDocumentation`
+* `SingleLine`
+* `Structured`: `"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.<br/>This should only be used by clients that support this behavior.
+* `SynopsisDocumentation`
+
+
+Default: `"FullDocumentation"`
### `ui.documentation.linkTarget`
+
linkTarget controls where documentation links go.
It might be one of:
@@ -705,21 +718,31 @@
If company chooses to use its own `godoc.org`, its address can be used as well.
-Default: `pkg.go.dev`
+
+Default: `"pkg.go.dev"`
### `ui.documentation.linksInHover`
+
linksInHover toggles the presence of links to documentation in hover.
+
Default: `true`
### `ui.navigation.importShortcut`
+
importShortcut specifies whether import statements should link to
documentation or go to definitions.
+<br/>
+Allowed Options: `Both`, `Definition`, `Link`
-Default: `Both`
+Default: `"Both"`
### `ui.navigation.symbolMatcher`
-(Advanced) symbolMatcher sets the algorithm that is used when finding workspace symbols.
-Default: `Fuzzy`
+(Advanced) symbolMatcher sets the algorithm that is used when finding workspace symbols.
+<br/>
+Allowed Options: `CaseInsensitive`, `CaseSensitive`, `Fuzzy`
+
+Default: `"Fuzzy"`
### `ui.navigation.symbolStyle`
+
(Advanced) symbolStyle controls how symbols are qualified in symbol responses.
Example Usage:
@@ -731,15 +754,31 @@
...
}
```
+<br/>
+Allowed Options:
-Default: `Dynamic`
+* `Dynamic`: `"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`: `"Full"` is fully qualified symbols, i.e.
+"path/to/pkg.Foo.Field".
+* `Package`: `"Package"` is package qualified symbols i.e.
+"pkg.Foo.Field".
+
+
+Default: `"Dynamic"`
### `ui.semanticTokens`
+
(Experimental) semanticTokens controls whether the LSP server will send
semantic tokens to the client.
+
Default: `false`
### `verboseOutput`
+
(For Debugging) verboseOutput enables additional debug logging.
+
Default: `false`
diff --git a/tools/generate.go b/tools/generate.go
index 4897522..acaada5 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -50,11 +50,11 @@
MarkdownDeprecationMessage string `json:"markdownDeprecationMessage,omitempty"`
DeprecationMessage string `json:"deprecationMessage,omitempty"`
Type interface{} `json:"type,omitempty"`
- Enum []string `json:"enum,omitempty"`
+ Enum []interface{} `json:"enum,omitempty"`
+ EnumDescriptions []string `json:"enumDescriptions,omitempty"`
+ MarkdownEnumDescriptions []string `json:"markdownEnumDescriptions,omitempty"`
}
-const indent = " "
-
func main() {
flag.Parse()
@@ -109,9 +109,9 @@
os.Exit(1) // causes CI to break.
}
}
- var b bytes.Buffer
+ b := &bytes.Buffer{}
for i, c := range pkgJSON.Contributes.Commands {
- b.WriteString(fmt.Sprintf("### `%s`\n\n%s", c.Title, c.Description))
+ fmt.Fprintf(b, "### `%s`\n\n%s", c.Title, c.Description)
if i != len(pkgJSON.Contributes.Commands)-1 {
b.WriteString("\n\n")
}
@@ -135,90 +135,118 @@
return properties[i].name < properties[j].name
})
- for i, p := range properties {
+ for _, p := range properties {
if p.name == "gopls" {
desc := "Customize `gopls` behavior by specifying the gopls' settings in this section. " +
"For example, \n```\n\"gopls\" : {\n\t\"build.directoryFilters\": [\"-node_modules\"]\n\t...\n}\n```\n" +
"This section is directly read by `gopls`. See the [`gopls` section](#settings-for-gopls) section " +
"for the full list of `gopls` settings."
- b.WriteString(fmt.Sprintf("### `%s`\n\n%s", p.name, desc))
+ fmt.Fprintf(b, "### `%s`\n\n%s", p.name, desc)
b.WriteString("\n\n")
continue
}
- desc := p.Description
- if p.MarkdownDescription != "" {
- desc = p.MarkdownDescription
- }
- deprecation := p.DeprecationMessage
- if p.MarkdownDeprecationMessage != "" {
- deprecation = p.MarkdownDeprecationMessage
- }
-
- name := p.name
- if deprecation != "" {
- name += " (deprecated)"
- desc = deprecation + "\n" + desc
- }
-
- b.WriteString(fmt.Sprintf("### `%s`\n\n%s", name, desc))
-
- if p.Enum != nil {
- b.WriteString(fmt.Sprintf("\n\nAllowed Values:`%v`", p.Enum))
- }
- switch p.Type {
- case "object":
- writeSettingsObjectProperties(&b, p.Properties)
-
- x, ok := p.Default.(map[string]interface{})
- // do nothing if it is nil
- if ok && len(x) > 0 {
- keys := []string{}
- for k := range x {
- keys = append(keys, k)
- }
- sort.Strings(keys)
- b.WriteString("\nDefault:{<br/>\n")
- for _, k := range keys {
- v := x[k]
- output := fmt.Sprintf("%v", v)
- if str, ok := v.(string); ok {
- output = fmt.Sprintf("%q", str)
- }
- // if v is an empty string, nothing gets printed
- // if v is a map/object, it is printed on one line
- // this could be improved at the cost of more code
- b.WriteString(fmt.Sprintf("%s`\"%s\": %s`,<br/>\n", indent, k, output))
- }
- b.WriteString(" }\n")
- }
-
- case "boolean", "string", "number":
- b.WriteString(fmt.Sprintf("\n\nDefault: `%v`", p.Default))
- case "array":
- x := p.Default.([]interface{})
- if len(x) > 0 {
- b.WriteString(fmt.Sprintf("\n\nDefault: `%v`", p.Default))
- }
- default:
- if _, ok := p.Type.([]interface{}); ok {
- b.WriteString(fmt.Sprintf("\n\nefault: `%v`", p.Default))
- break
- }
- log.Fatalf("implement default when p.Type is %q in %#v %T", p.Type, p, p.Default)
- }
- if i != len(properties)-1 {
- b.WriteString("\n\n")
- }
+ writeProperty(b, "###", p)
+ b.WriteString("\n")
}
// Write gopls section.
b.WriteString("## Settings for `gopls`\n\n")
- writeGoplsSettingsSection(&b, goplsProperty)
+ writeGoplsSettingsSection(b, goplsProperty)
rewrite(filepath.Join(dir, "docs", "settings.md"), b.Bytes())
}
+func writeProperty(b *bytes.Buffer, heading string, p Property) {
+ desc := p.Description
+ if p.MarkdownDescription != "" {
+ desc = p.MarkdownDescription
+ }
+ deprecation := p.DeprecationMessage
+ if p.MarkdownDeprecationMessage != "" {
+ deprecation = p.MarkdownDeprecationMessage
+ }
+
+ name := p.name
+ if deprecation != "" {
+ name += " (deprecated)"
+ desc = deprecation + "\n" + desc
+ }
+
+ fmt.Fprintf(b, "%s `%s`\n\n%s", heading, name, desc)
+
+ if enums := enumDescriptionsSnippet(p); enums != "" {
+ fmt.Fprintf(b, "<br/>\n%s", enums)
+ }
+
+ if p.Type == "object" {
+ writeSettingsObjectProperties(b, p.Properties)
+ }
+
+ if defaults := defaultDescriptionSnippet(p); defaults != "" {
+ b.WriteString("\n\n")
+ if p.Type == "object" {
+ fmt.Fprintf(b, "Default:\n```\n%v\n```", defaults)
+ } else {
+ fmt.Fprintf(b, "Default: `%v`", defaults)
+ }
+ }
+}
+
+func defaultDescriptionSnippet(p Property) string {
+ if p.Default == nil {
+ return ""
+ }
+ b := &bytes.Buffer{}
+ switch p.Type {
+ case "object":
+ x, ok := p.Default.(map[string]interface{})
+ // do nothing if it is nil
+ if ok && len(x) > 0 {
+ writeMapObject(b, "", x)
+ }
+ case "string":
+ fmt.Fprintf(b, "%q", p.Default)
+ case "boolean", "number":
+ fmt.Fprintf(b, "%v", p.Default)
+ case "array":
+ if x, ok := p.Default.([]interface{}); ok && len(x) > 0 {
+ fmt.Fprintf(b, "%v", p.Default)
+ }
+ default:
+ if _, ok := p.Type.([]interface{}); ok {
+ fmt.Fprintf(b, "%v", p.Default)
+ break
+ }
+ log.Fatalf("implement default when p.Type is %q in %#v %T", p.Type, p, p.Default)
+ }
+ return b.String()
+}
+
+func writeMapObject(b *bytes.Buffer, indent string, obj map[string]interface{}) {
+ keys := []string{}
+ for k := range obj {
+ keys = append(keys, k)
+ }
+ sort.Strings(keys)
+ fmt.Fprintf(b, "%v{\n", indent)
+ for _, k := range keys {
+ fmt.Fprintf(b, "%v%q :\t", indent+"\t", k)
+
+ v := obj[k]
+ switch v := v.(type) {
+ case string:
+ fmt.Fprintf(b, "%q", v)
+ case map[string]interface{}:
+ writeMapObject(b, indent+"\t", v)
+ default:
+ fmt.Fprintf(b, "%v", v)
+ }
+ fmt.Fprint(b, ",\n")
+ }
+ fmt.Fprintf(b, "%v}", indent)
+}
+
func writeGoplsSettingsSection(b *bytes.Buffer, goplsProperty Property) {
desc := goplsProperty.MarkdownDescription
b.WriteString(desc)
@@ -232,71 +260,57 @@
sort.Strings(names)
for _, name := range names {
- p, ok := properties[name].(map[string]interface{})
+ pdata, ok := properties[name].(map[string]interface{})
if !ok {
- b.WriteString(fmt.Sprintf("### `%s`\n", name))
+ fmt.Fprintf(b, "### `%s`\n", name)
continue
}
-
- desc := ""
- if d := p["description"]; d != nil {
- desc = fmt.Sprintf("%v", d)
- }
- if d := p["markdownDescription"]; d != nil {
- desc = fmt.Sprintf("%v", d)
- }
- deprecation := ""
- if d := p["deprecationMessage"]; d != nil {
- deprecation = fmt.Sprintf("%v", d)
- }
- if d := p["markdownDeprecationMessage"]; d != nil {
- deprecation = fmt.Sprintf("%v", d)
- }
- if deprecation != "" {
- name += " (deprecated)"
- desc = deprecation + "\n" + desc
- }
- b.WriteString(fmt.Sprintf("### `%s`\n%s", name, desc))
-
- switch p["type"] {
- case "object":
- x, ok := p["default"].(map[string]interface{})
- // do nothing if it is nil
- if ok && len(x) > 0 {
- keys := []string{}
- for k := range x {
- keys = append(keys, k)
- }
- sort.Strings(keys)
- b.WriteString(fmt.Sprintf("\nDefault:{<br/>\n"))
- for _, k := range keys {
- v := x[k]
- output := fmt.Sprintf("%v", v)
- if str, ok := v.(string); ok {
- output = fmt.Sprintf("%q", str)
- }
- // if v is an empty string, nothing gets printed
- // if v is a map/object, it is printed on one line
- // this could be improved at the cost of more code
- b.WriteString(fmt.Sprintf("%s`\"%s\": %s`,<br/>\n", indent, k, output))
- }
- b.WriteString(" }\n")
- }
-
- case "boolean", "string", "number":
- b.WriteString(fmt.Sprintf("\nDefault: `%v`", p["default"]))
- case "array":
- x, ok := p["default"].([]interface{})
- if ok && len(x) > 0 {
- b.WriteString(fmt.Sprintf("\nDefault: `%v`", p["default"]))
- }
- default:
- b.WriteString(fmt.Sprintf("\nefault: `%v`", p["default"]))
- }
+ p := mapToProperty(name, pdata)
+ writeProperty(b, "###", p)
b.WriteString("\n")
}
}
+func mapToProperty(name string, pdata map[string]interface{}) Property {
+ p := Property{name: name}
+
+ if v, ok := pdata["properties"].(map[string]interface{}); ok {
+ p.Properties = v
+ }
+ if v, ok := pdata["markdownDescription"].(string); ok {
+ p.MarkdownDescription = v
+ }
+ if v, ok := pdata["description"].(string); ok {
+ p.Description = v
+ }
+ if v, ok := pdata["markdownDeprecationMessage"].(string); ok {
+ p.MarkdownDescription = v
+ }
+ if v, ok := pdata["deprecationMessage"].(string); ok {
+ p.DeprecationMessage = v
+ }
+ if v, ok := pdata["type"].(string); ok {
+ p.Type = v
+ }
+ if v, ok := pdata["enum"].([]interface{}); ok {
+ p.Enum = v
+ }
+ if v, ok := pdata["enumDescriptions"].([]interface{}); ok {
+ for _, d := range v {
+ p.EnumDescriptions = append(p.EnumDescriptions, d.(string))
+ }
+ }
+ if v, ok := pdata["markdownEnumDescriptions"].([]interface{}); ok {
+ for _, d := range v {
+ p.MarkdownEnumDescriptions = append(p.MarkdownEnumDescriptions, d.(string))
+ }
+ }
+ if v, ok := pdata["default"]; ok {
+ p.Default = v
+ }
+ return p
+}
+
func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]interface{}) {
if len(properties) == 0 {
return
@@ -307,37 +321,126 @@
names = append(names, name)
}
sort.Strings(names)
- b.WriteString("\n\n")
+ b.WriteString("\n")
b.WriteString("| Properties | Description |\n")
b.WriteString("| --- | --- |\n")
- for _, name := range names {
- p, ok := properties[name].(map[string]interface{})
+ ending := "\n"
+ for i, name := range names {
+ if i == len(names)-1 {
+ ending = ""
+ }
+ pdata, ok := properties[name].(map[string]interface{})
if !ok {
- b.WriteString(fmt.Sprintf("| `%s` | |\n", name))
+ fmt.Fprintf(b, "| `%s` | |%v", name, ending)
continue
}
+ p := mapToProperty(name, pdata)
- desc := ""
- if d := p["description"]; d != nil {
- desc = fmt.Sprintf("%v", d)
+ desc := p.Description
+ if p.MarkdownDescription != "" {
+ desc = p.MarkdownDescription
}
- if d := p["markdownDescription"]; d != nil {
- desc = fmt.Sprintf("%v", d)
+ deprecation := p.DeprecationMessage
+ if p.MarkdownDeprecationMessage != "" {
+ deprecation = p.MarkdownDeprecationMessage
}
- deprecation := ""
- if d := p["deprecationMessage"]; d != nil {
- deprecation = fmt.Sprintf("%v", d)
- }
- if d := p["markdownDeprecationMessage"]; d != nil {
- deprecation = fmt.Sprintf("%v", d)
- }
-
if deprecation != "" {
name += " (deprecated)"
desc = deprecation + "\n" + desc
}
- b.WriteString(fmt.Sprintf("| `%s` | %s |\n", name, desc))
+
+ if enum := enumDescriptionsSnippet(p); enum != "" {
+ desc += "\n\n" + enum
+ }
+
+ if defaults := defaultDescriptionSnippet(p); defaults != "" {
+ desc += "\n\n"
+ if p.Type == "object" {
+ desc += fmt.Sprintf("Default:\n```\n%v\n```", defaults)
+ } else {
+ desc += fmt.Sprintf("Default: `%v`", defaults)
+ }
+ }
+ desc = gocommentToMarkdown(desc)
+ fmt.Fprintf(b, "| `%s` | %s |%v", name, desc, ending)
}
- b.WriteString("| | |\n")
- b.WriteString("\n")
+}
+
+// enumDescriptionsSnippet returns the snippet for the allowed values.
+func enumDescriptionsSnippet(p Property) string {
+ b := &bytes.Buffer{}
+ if len(p.Enum) == 0 {
+ return ""
+ }
+ desc := p.EnumDescriptions
+ if len(p.MarkdownEnumDescriptions) != 0 {
+ desc = p.MarkdownEnumDescriptions
+ }
+
+ hasDesc := false
+ for _, d := range desc {
+ if d != "" {
+ hasDesc = true
+ break
+ }
+ }
+ b.WriteString("Allowed Options:")
+
+ if hasDesc && len(desc) == len(p.Enum) {
+ b.WriteString("\n\n")
+ for i, e := range p.Enum {
+ fmt.Fprintf(b, "* `%v`", e)
+ if d := desc[i]; d != "" {
+ fmt.Fprintf(b, ": %v", strings.TrimRight(strings.ReplaceAll(d, "\n\n", "<br/>"), "\n"))
+ }
+ b.WriteString("\n")
+ }
+ } else {
+ for i, e := range p.Enum {
+ fmt.Fprintf(b, " `%v`", e)
+ if i < len(p.Enum)-1 {
+ b.WriteString(",")
+ }
+ }
+ }
+ return b.String()
+}
+
+// gocommentToMarkdown converts the description string generated based on go comments
+// to more markdown-friendly style.
+// - treat indented lines as pre-formatted blocks (e.g. code snippets) like in go doc
+// - replace new lines with <br/>'s, so the new lines mess up formatting when embedded in tables
+// - preserve new lines inside preformatted sections, but replace them with <br/>'s
+// - skip unneeded new lines
+func gocommentToMarkdown(s string) string {
+ lines := strings.Split(s, "\n")
+ inPre := false
+ b := &bytes.Buffer{}
+ for i, l := range lines {
+ if strings.HasPrefix(l, "\t") { // indented
+ if !inPre { // beginning of the block
+ inPre = true
+ b.WriteString("<pre>")
+ } else { // preserve new lines in pre-formatted block
+ b.WriteString("<br/>")
+ }
+ l = l[1:] // remove one leading \t, in favor of <pre></pre> formatting.
+ } else { // not indented
+ if inPre {
+ inPre = false
+ b.WriteString("</pre>")
+ }
+ }
+ if l == "" && i != len(lines)-1 {
+ b.WriteString("<br/>") // add a new line.
+ } else {
+ b.WriteString(l) // just print l, no new line.
+ }
+ if i != len(lines)-1 {
+ if !inPre {
+ b.WriteString(" ")
+ }
+ }
+ }
+ return b.String()
}
