tools/generate: move gopls settings to a dedicated section
And, for object type properties (except the `gopls`),
use tables to describe the properties.
Moved gopls settings details to a separate section because there are
so much info to be displayed in one table.
Change-Id: I15684631e1c23b3709788b1a09d6c2611203b1c4
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/283432
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 8b36611..b245d02 100644
--- a/docs/settings.md
+++ b/docs/settings.md
@@ -8,7 +8,7 @@
## 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.
+The settings described below are up-to-date as of January 2021. 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:
@@ -25,6 +25,16 @@
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 |
+| | |
+
+
Default:{<br/>
`"options": "json=omitempty"`,<br/>
`"promptForTags": false`,<br/>
@@ -34,42 +44,21 @@
}
-#### `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
-
### `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.
-#### `go`
-Alternate tool to use instead of the go binary or alternate path to use for the go binary.
+| 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-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.autocompleteUnimportedPackages`
@@ -137,6 +126,18 @@
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. |
+| `coveredHighlightColor` | Color in the rgba format to use to highlight covered code. |
+| `type` | |
+| `uncoveredBorderColor` | Color to use for the border of uncovered code. |
+| `uncoveredGutterStyle` | Gutter style to indicate covered code. |
+| `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/>
@@ -148,27 +149,6 @@
}
-#### `coveredBorderColor`
-Color to use for the border of covered code.
-
-#### `coveredGutterStyle`
-Gutter style to indicate covered code.
-
-#### `coveredHighlightColor`
-Color in the rgba format to use to highlight covered code.
-
-#### `type`
-
-
-#### `uncoveredBorderColor`
-Color to use for the border of uncovered code.
-
-#### `uncoveredGutterStyle`
-Gutter style to indicate covered code.
-
-#### `uncoveredHighlightColor`
-Color in the rgba format to use to highlight uncovered code.
-
### `go.coverageOptions`
Use these options to control whether only covered or only uncovered code or both should be highlighted after running test coverage
@@ -181,6 +161,14 @@
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. |
+| | |
+
+
Default:{<br/>
`"apiVersion": 2`,<br/>
`"dlvLoadConfig": map[followPointers:true maxArrayValues:64 maxStringLen:64 maxStructFields:-1 maxVariableRecurse:1]`,<br/>
@@ -188,15 +176,6 @@
}
-#### `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.
-
### `go.docsTool`
Pick 'godoc' or 'gogetdoc' to get documentation. Not applicable when using the language server.
@@ -209,6 +188,26 @@
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 |
+| | |
+
+
Default:{<br/>
`"addImport": true`,<br/>
`"addTags": true`,<br/>
@@ -228,67 +227,23 @@
}
-#### `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
-
### `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 |
+| | |
+
+
Default:{<br/>
`"references": false`,<br/>
`"runtest": true`,<br/>
}
-#### `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
-
### `go.formatFlags`
Flags to pass to format tool (e.g. ["-s"]). Not applicable when using the language server.
@@ -393,18 +348,19 @@
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. |
+| | |
+
+
Default:{<br/>
`"delay": 500`,<br/>
`"enabled": false`,<br/>
}
-#### `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.
-
### `go.logging.level`
The logging level the extension logs at, defaults to 'error'
@@ -418,16 +374,26 @@
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.
-#### `codelens`
+| Properties | Description |
+| --- | --- |
+| `codelens` | |
+| `default` | |
+| | |
-#### `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 |
+| | |
+
+
Default:{<br/>
`"openbrowser": true`,<br/>
`"run": true`,<br/>
@@ -435,19 +401,18 @@
}
-#### `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
-
### `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 |
+| | |
+
+
Default:{<br/>
`"options": ""`,<br/>
`"promptForTags": false`,<br/>
@@ -455,15 +420,6 @@
}
-#### `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
-
### `go.testEnvFile`
Absolute path to a file containing environment variables definitions. File contents should be of the form key=value.
@@ -472,7 +428,7 @@
### `go.testEnvVars`
-Environment variables that will passed to the process that runs the Go tests
+Environment variables that will be passed to the process that runs the Go tests
### `go.testFlags`
@@ -500,7 +456,7 @@
### `go.toolsEnvVars`
-Environment variables that will passed to the tools that run the Go tools (e.g. CGO_CFLAGS)
+Environment variables that will be passed to the tools that run the Go tools (e.g. CGO_CFLAGS)
### `go.toolsGopath`
@@ -563,28 +519,38 @@
### `gopls`
+Customize `gopls` behavior by specifying the gopls' settings in this section. For example,
+```
+"gopls" : {
+ "build.directoryFilters": ["-node_modules"]
+ ...
+}
+```
+This section is directly read by `gopls`. See the [`gopls` section](#settings-for-gopls) section for the full list of `gopls` settings.
+
+## Settings for `gopls`
+
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`
+### `build.allowImplicitNetworkAccess`
(Experimental) allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module
downloads rather than requiring user action. This option will eventually
be removed.
-
-#### `build.allowModfileModifications`
+Default: `false`
+### `build.allowModfileModifications`
(Experimental) allowModfileModifications disables -mod=readonly, allowing imports from
out-of-scope modules. This option will eventually be removed.
-
-#### `build.buildFlags`
+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`.
If unspecified, values of `go.buildFlags, go.buildTags` will be propagated.
-
-#### `build.directoryFilters`
+### `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
@@ -597,12 +563,10 @@
Include only project_a: `-` (exclude everything), `+project_a`
Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`
-
-#### `build.env`
+### `build.env`
env adds environment variables to external commands run by `gopls`, most notably `go list`.
-
-#### `build.expandWorkspaceToModule`
+### `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
@@ -610,8 +574,8 @@
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.
-
-#### `build.experimentalPackageCacheKey`
+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
@@ -620,24 +584,24 @@
by an experiment because caching behavior is subtle and difficult to
comprehensively test.
-
-#### `build.experimentalWorkspaceModule`
+Default: `true`
+### `build.experimentalWorkspaceModule`
(Experimental) experimentalWorkspaceModule opts a user into the experimental support
for multi-module workspaces.
-
-#### `formatting.gofumpt`
+Default: `false`
+### `formatting.gofumpt`
gofumpt indicates if we should run gofumpt formatting.
-
-#### `formatting.local`
+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.
-
-#### `ui.codelenses`
+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)
@@ -656,26 +620,25 @@
}
```
-
-#### `ui.completion.completionBudget`
+### `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.
-
-#### `ui.completion.matcher`
+Default: `100ms`
+### `ui.completion.matcher`
(Advanced) matcher sets the algorithm that is used when calculating completion
candidates.
-
-#### `ui.completion.usePlaceholders`
+Default: `Fuzzy`
+### `ui.completion.usePlaceholders`
placeholders enables placeholders for function parameters or struct
fields in completion responses.
-
-#### `ui.diagnostic.analyses`
+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
@@ -692,13 +655,11 @@
...
```
-
-#### `ui.diagnostic.annotations`
+### `ui.diagnostic.annotations`
(Experimental) annotations specifies the various kinds of optimization diagnostics
that should be reported by the gc_details command.
-
-#### `ui.diagnostic.experimentalDiagnosticsDelay`
+### `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
@@ -706,17 +667,17 @@
This option must be set to a valid duration string, for example `"250ms"`.
-
-#### `ui.diagnostic.staticcheck`
+Default: `250ms`
+### `ui.diagnostic.staticcheck`
(Experimental) staticcheck enables additional analyses from staticcheck.io.
-
-#### `ui.documentation.hoverKind`
+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.
-
-#### `ui.documentation.linkTarget`
+Default: `FullDocumentation`
+### `ui.documentation.linkTarget`
linkTarget controls where documentation links go.
It might be one of:
@@ -725,21 +686,21 @@
If company chooses to use its own `godoc.org`, its address can be used as well.
-
-#### `ui.documentation.linksInHover`
+Default: `pkg.go.dev`
+### `ui.documentation.linksInHover`
linksInHover toggles the presence of links to documentation in hover.
-
-#### `ui.navigation.importShortcut`
+Default: `true`
+### `ui.navigation.importShortcut`
importShortcut specifies whether import statements should link to
documentation or go to definitions.
-
-#### `ui.navigation.symbolMatcher`
+Default: `Both`
+### `ui.navigation.symbolMatcher`
(Advanced) symbolMatcher sets the algorithm that is used when finding workspace symbols.
-
-#### `ui.navigation.symbolStyle`
+Default: `Fuzzy`
+### `ui.navigation.symbolStyle`
(Advanced) symbolStyle controls how symbols are qualified in symbol responses.
Example Usage:
@@ -752,12 +713,14 @@
}
```
-
-#### `ui.semanticTokens`
+Default: `Dynamic`
+### `ui.semanticTokens`
(Experimental) semanticTokens controls whether the LSP server will send
semantic tokens to the client.
-
-#### `verboseOutput`
+Default: `false`
+### `verboseOutput`
(For Debugging) verboseOutput enables additional debug logging.
+Default: `false`
+
diff --git a/package.json b/package.json
index 5fd3fa2..659e345 100644
--- a/package.json
+++ b/package.json
@@ -1544,7 +1544,7 @@
"go.testEnvVars": {
"type": "object",
"default": {},
- "description": "Environment variables that will passed to the process that runs the Go tests",
+ "description": "Environment variables that will be passed to the process that runs the Go tests",
"scope": "resource"
},
"go.testEnvFile": {
@@ -1577,7 +1577,7 @@
"go.toolsEnvVars": {
"type": "object",
"default": {},
- "description": "Environment variables that will passed to the tools that run the Go tools (e.g. CGO_CFLAGS)",
+ "description": "Environment variables that will be passed to the tools that run the Go tools (e.g. CGO_CFLAGS)",
"scope": "resource"
},
"go.gocodeFlags": {
diff --git a/tools/generate.go b/tools/generate.go
index 3352f7c..4897522 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -53,6 +53,8 @@
Enum []string `json:"enum,omitempty"`
}
+const indent = " "
+
func main() {
flag.Parse()
@@ -120,15 +122,30 @@
b.Reset()
var properties []Property
+ var goplsProperty Property
for name, p := range pkgJSON.Contributes.Configuration.Properties {
p.name = name
+ if name == "gopls" {
+ goplsProperty = p
+ }
properties = append(properties, p)
}
+
sort.Slice(properties, func(i, j int) bool {
return properties[i].name < properties[j].name
})
- indent := " "
+
for i, 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))
+ b.WriteString("\n\n")
+ continue
+ }
+
desc := p.Description
if p.MarkdownDescription != "" {
desc = p.MarkdownDescription
@@ -151,6 +168,8 @@
}
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 {
@@ -159,7 +178,7 @@
keys = append(keys, k)
}
sort.Strings(keys)
- b.WriteString("\n\nDefault:{<br/>\n")
+ b.WriteString("\nDefault:{<br/>\n")
for _, k := range keys {
v := x[k]
output := fmt.Sprintf("%v", v)
@@ -173,7 +192,6 @@
}
b.WriteString(" }\n")
}
- writeSettingsObjectProperties(&b, "####", p.Properties)
case "boolean", "string", "number":
b.WriteString(fmt.Sprintf("\n\nDefault: `%v`", p.Default))
@@ -193,10 +211,20 @@
b.WriteString("\n\n")
}
}
+
+ // Write gopls section.
+ b.WriteString("## Settings for `gopls`\n\n")
+ writeGoplsSettingsSection(&b, goplsProperty)
+
rewrite(filepath.Join(dir, "docs", "settings.md"), b.Bytes())
}
-func writeSettingsObjectProperties(b *bytes.Buffer, heading string, properties map[string]interface{}) {
+func writeGoplsSettingsSection(b *bytes.Buffer, goplsProperty Property) {
+ desc := goplsProperty.MarkdownDescription
+ b.WriteString(desc)
+ b.WriteString("\n\n")
+
+ properties := goplsProperty.Properties
var names []string
for name := range properties {
names = append(names, name)
@@ -206,7 +234,86 @@
for _, name := range names {
p, ok := properties[name].(map[string]interface{})
if !ok {
- b.WriteString(fmt.Sprintf("\n\n\n%s %s\n", heading, name))
+ b.WriteString(fmt.Sprintf("### `%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"]))
+ }
+ b.WriteString("\n")
+ }
+}
+
+func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]interface{}) {
+ if len(properties) == 0 {
+ return
+ }
+
+ var names []string
+ for name := range properties {
+ names = append(names, name)
+ }
+ sort.Strings(names)
+ b.WriteString("\n\n")
+ b.WriteString("| Properties | Description |\n")
+ b.WriteString("| --- | --- |\n")
+ for _, name := range names {
+ p, ok := properties[name].(map[string]interface{})
+ if !ok {
+ b.WriteString(fmt.Sprintf("| `%s` | |\n", name))
continue
}
@@ -229,6 +336,8 @@
name += " (deprecated)"
desc = deprecation + "\n" + desc
}
- b.WriteString(fmt.Sprintf("\n\n%s `%s`\n%s", heading, name, desc))
+ b.WriteString(fmt.Sprintf("| `%s` | %s |\n", name, desc))
}
+ b.WriteString("| | |\n")
+ b.WriteString("\n")
}
