summaryrefslogtreecommitdiff
path: root/doc/en-us
diff options
context:
space:
mode:
author最萌小汐 <sumneko@hotmail.com>2022-06-09 00:44:28 +0800
committer最萌小汐 <sumneko@hotmail.com>2022-06-09 00:44:28 +0800
commitc481991fee74022dd261fab3bd5f07f472b9f9ac (patch)
tree1b676b41e80be6922eda6fbadafaca5a3c1c21f9 /doc/en-us
parent38484bc7546869604751274f21de9f46ca8faf9a (diff)
downloadlua-language-server-c481991fee74022dd261fab3bd5f07f472b9f9ac.zip
update config
Diffstat (limited to 'doc/en-us')
-rw-r--r--doc/en-us/config/config.md285
1 files changed, 274 insertions, 11 deletions
diff --git a/doc/en-us/config/config.md b/doc/en-us/config/config.md
index c863d62f..5dc27eca 100644
--- a/doc/en-us/config/config.md
+++ b/doc/en-us/config/config.md
@@ -2,16 +2,26 @@
When the input looks like a file name, automatically `require` this file.
+## type
+`boolean`
+
## default
+
`true`
# completion.callSnippet
Shows function call snippets.
+## type
+`string`
+
## default
+
`"Disable"`
+
## enum
+
* `"Disable"`: Only shows `function name`.
* `"Both"`: Shows `function name` and `call snippet`.
* `"Replace"`: Only shows `call snippet.`
@@ -20,23 +30,37 @@ Shows function call snippets.
Previewing the relevant code snippet of the suggestion may help you understand the usage of the suggestion. The number set indicates the number of intercepted lines in the code fragment. If it is set to `0`, this feature can be disabled.
+## type
+`integer`
+
## default
+
`0`
# completion.enable
Enable completion.
+## type
+`boolean`
+
## default
+
`true`
# completion.keywordSnippet
Shows keyword syntax snippets.
+## type
+`string`
+
## default
+
`"Replace"`
+
## enum
+
* `"Disable"`: Only shows `keyword`.
* `"Both"`: Shows `keyword` and `syntax snippet`.
* `"Replace"`: Only shows `syntax snippet`.
@@ -45,30 +69,48 @@ Shows keyword syntax snippets.
The symbol used to trigger the postfix suggestion.
+## type
+`string`
+
## default
+
`"@"`
# completion.requireSeparator
The separator used when `require`.
+## type
+`string`
+
## default
+
`"."`
# completion.showParams
Display parameters in completion list. When the function has multiple definitions, they will be displayed separately.
+## type
+`boolean`
+
## default
+
`true`
# completion.showWord
Show contextual words in suggestions.
+## type
+`string`
+
## default
+
`"Fallback"`
+
## enum
+
* `"Enable"`: Always show context words in suggestions.
* `"Fallback"`: Contextual words are only displayed when suggestions based on semantics cannot be provided.
* `"Disable"`: Do not display context words.
@@ -77,44 +119,70 @@ Show contextual words in suggestions.
Whether the displayed context word contains the content of other files in the workspace.
+## type
+`boolean`
+
## default
+
`true`
# diagnostics.disable
Disabled diagnostic (Use code in hover brackets).
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# diagnostics.disableScheme
Do not diagnose Lua files that use the following scheme.
+## type
+`array<string>`
+
## default
-`{ "git" }`
+
+`[ "git" ]`
# diagnostics.enable
Enable diagnostics.
+## type
+`boolean`
+
## default
+
`true`
# diagnostics.globals
Defined global variables.
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# diagnostics.ignoredFiles
How to diagnose ignored files.
+## type
+`string`
+
## default
+
`"Opened"`
+
## enum
+
* `"Enable"`: Always diagnose these files.
* `"Opened"`: Only when these files are opened will it be diagnosed.
* `"Disable"`: These files are not diagnosed.
@@ -123,9 +191,15 @@ How to diagnose ignored files.
How to diagnose files loaded via `Lua.workspace.library`.
+## type
+`string`
+
## default
+
`"Opened"`
+
## enum
+
* `"Enable"`: Always diagnose these files.
* `"Opened"`: Only when these files are opened will it be diagnosed.
* `"Disable"`: These files are not diagnosed.
@@ -137,46 +211,73 @@ How to diagnose files loaded via `Lua.workspace.library`.
* Disable: disable this diagnostic
+## type
+`object`
# diagnostics.severity
Modified diagnostic severity.
+## type
+`object`
# diagnostics.workspaceDelay
Latency (milliseconds) for workspace diagnostics. When you start the workspace, or edit any file, the entire workspace will be re-diagnosed in the background. Set to negative to disable workspace diagnostics.
+## type
+`integer`
+
## default
+
`3000`
# diagnostics.workspaceRate
Workspace diagnostics run rate (%). Decreasing this value reduces CPU usage, but also reduces the speed of workspace diagnostics. The diagnosis of the file you are currently editing is always done at full speed and is not affected by this setting.
+## type
+`integer`
+
## default
+
`100`
# format.defaultConfig
**Missing description!!**
+
+## type
+`object`
+
## default
+
`{}`
# format.enable
Enable code formatter.
+## type
+`boolean`
+
## default
+
`true`
# hint.arrayIndex
Show hints of array index when constructing a table.
+## type
+`string`
+
## default
+
`"Auto"`
+
## enum
+
* `"Enable"`: Show hints in all tables.
* `"Auto"`: Show hints only when the table is greater than 3 items, or the table is a mixed table.
* `"Disable"`: Disable hints of array index.
@@ -184,21 +285,34 @@ Show hints of array index when constructing a table.
# hint.await
**Missing description!!**
+
+## type
+`boolean`
+
## default
+
`true`
# hint.enable
Enable inlay hint.
+## type
+`boolean`
# hint.paramName
Show hints of parameter name at the function call.
+## type
+`string`
+
## default
+
`"All"`
+
## enum
+
* `"All"`: All types of parameters are shown.
* `"Literal"`: Only literal type parameters are shown.
* `"Disable"`: Disable parameter hints.
@@ -207,68 +321,107 @@ Show hints of parameter name at the function call.
Show type hints at the parameter of the function.
+## type
+`boolean`
+
## default
+
`true`
# hint.setType
Show hints of type at assignment operation.
+## type
+`boolean`
# hover.enable
Enable hover.
+## type
+`boolean`
+
## default
+
`true`
# hover.enumsLimit
When the value corresponds to multiple types, limit the number of types displaying.
+## type
+`integer`
+
## default
+
`5`
# hover.expandAlias
**Missing description!!**
+
+## type
+`boolean`
+
## default
+
`true`
# hover.previewFields
When hovering to view a table, limits the maximum number of previews for fields.
+## type
+`integer`
+
## default
+
`20`
# hover.viewNumber
Hover to view numeric content (only if literal is not decimal).
+## type
+`boolean`
+
## default
+
`true`
# hover.viewString
Hover to view the contents of a string (only if the literal contains an escape character).
+## type
+`boolean`
+
## default
+
`true`
# hover.viewStringMax
The maximum length of a hover to view the contents of a string.
+## type
+`integer`
+
## default
+
`1000`
# misc.parameters
[Command line parameters](https://github.com/sumneko/lua-telemetry-server/tree/master/method) when starting the language service in VSCode.
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# runtime.builtin
@@ -279,14 +432,22 @@ Adjust the enabled state of the built-in library. You can disable (or redefine)
* `disable`: always disable
+## type
+`object`
# runtime.fileEncoding
File encoding. The `ansi` option is only available under the `Windows` platform.
+## type
+`string`
+
## default
+
`"utf8"`
+
## enum
+
* `"utf8"`
* `"ansi"`
* `"utf16le"`
@@ -295,15 +456,24 @@ File encoding. The `ansi` option is only available under the `Windows` platform.
# runtime.meta
**Missing description!!**
+
+## type
+`string`
+
## default
+
`"${version} ${language} ${encoding}"`
# runtime.nonstandardSymbol
Supports non-standard symbols. Make sure that your runtime environment supports these symbols.
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# runtime.path
@@ -313,19 +483,29 @@ if `runtime.pathStrict` is `false`, `${workspace}/**/myfile/init.lua` will also
If you want to load files outside the workspace, you need to set `Lua.workspace.library` first.
+## type
+`array<string>`
+
## default
-`{ "?.lua", "?/init.lua" }`
+
+`[ "?.lua", "?/init.lua" ]`
# runtime.pathStrict
When enabled, `runtime.path` will only search the first level of directories, see the description of `runtime.path`.
+## type
+`boolean`
# runtime.plugin
Plugin path. Please read [wiki](https://github.com/sumneko/lua-language-server/wiki/Plugin) to learn more.
+## type
+`string`
+
## default
+
`""`
# runtime.special
@@ -339,21 +519,33 @@ The following example shows that 'include' is treated as' require '.
```
+## type
+`object`
+
## default
+
`{}`
# runtime.unicodeName
Allows Unicode characters in name.
+## type
+`boolean`
# runtime.version
Lua runtime version.
+## type
+`string`
+
## default
+
`"Lua 5.4"`
+
## enum
+
* `"Lua 5.1"`
* `"Lua 5.2"`
* `"Lua 5.3"`
@@ -364,61 +556,96 @@ Lua runtime version.
Semantic coloring of type annotations.
+## type
+`boolean`
+
## default
+
`true`
# semantic.enable
Enable semantic color. You may need to set `editor.semanticHighlighting.enabled` to `true` to take effect.
+## type
+`boolean`
+
## default
+
`true`
# semantic.keyword
Semantic coloring of keywords/literals/operators. You only need to enable this feature if your editor cannot do syntax coloring.
+## type
+`boolean`
# semantic.variable
Semantic coloring of variables/fields/parameters.
+## type
+`boolean`
+
## default
+
`true`
# signatureHelp.enable
Enable signature help.
+## type
+`boolean`
+
## default
+
`true`
# spell.dict
**Missing description!!**
+
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# telemetry.enable
Enable telemetry to send your editor information and error logs over the network. Read our privacy policy [here](https://github.com/sumneko/lua-language-server/wiki/Privacy-Policy).
+## type
+`boolean | null`
+
## default
+
`nil`
# window.progressBar
Show progress bar in status bar.
+## type
+`boolean`
+
## default
+
`true`
# window.statusBar
Show extension status in status bar.
+## type
+`boolean`
+
## default
+
`true`
# workspace.checkThirdParty
@@ -433,61 +660,97 @@ Automatic detection and adaptation of third-party libraries, currently supported
* Jass
+## type
+`boolean`
+
## default
+
`true`
# workspace.ignoreDir
Ignored files and directories (Use `.gitignore` grammar).
+## type
+`array<string>`
+
## default
-`{ ".vscode" }`
+
+`[ ".vscode" ]`
# workspace.ignoreSubmodules
Ignore submodules.
+## type
+`boolean`
+
## default
+
`true`
# workspace.library
In addition to the current workspace, which directories will load files from. The files in these directories will be treated as externally provided code libraries, and some features (such as renaming fields) will not modify these files.
+## type
+`array<string>`
+
## default
-`{}`
+
+`[]`
# workspace.maxPreload
Max preloaded files.
+## type
+`integer`
+
## default
+
`5000`
# workspace.preloadFileSize
Skip files larger than this value (KB) when preloading.
+## type
+`integer`
+
## default
+
`500`
# workspace.supportScheme
Provide language server for the Lua files of the following scheme.
+## type
+`array<string>`
+
## default
-`{ "file", "untitled", "git" }`
+
+`[ "file", "untitled", "git" ]`
# workspace.useGitIgnore
Ignore files list in `.gitignore` .
+## type
+`boolean`
+
## default
+
`true`
# workspace.userThirdParty
Add private third-party library configuration file paths here, please refer to the built-in [configuration file path](https://github.com/sumneko/lua-language-server/tree/master/meta/3rd)
+## type
+`array<string>`
+
## default
-`{}` \ No newline at end of file
+
+`[]` \ No newline at end of file