summaryrefslogtreecommitdiff
path: root/doc/zh-cn
diff options
context:
space:
mode:
authorCppCXY <812125110@qq.com>2024-02-22 20:29:13 +0800
committerCppCXY <812125110@qq.com>2024-02-22 20:29:13 +0800
commit9b6df71d97a70ee7179949ef9f15368cbf29dcbd (patch)
treebf7a7e62ed7c164a12bdce437c17262a5235bcec /doc/zh-cn
parent483fe246b6ae8c25d433aa15e43f04f0e71a74d5 (diff)
parent3e6fd3ce1f2f0528336ded939d776a29bbfaf2eb (diff)
downloadlua-language-server-9b6df71d97a70ee7179949ef9f15368cbf29dcbd.zip
Merge branch 'master' of github.com:CppCXY/lua-language-server
Diffstat (limited to 'doc/zh-cn')
-rw-r--r--doc/zh-cn/config.md105
1 files changed, 89 insertions, 16 deletions
diff --git a/doc/zh-cn/config.md b/doc/zh-cn/config.md
index 9ddffb9e..ebb8325f 100644
--- a/doc/zh-cn/config.md
+++ b/doc/zh-cn/config.md
@@ -1,3 +1,19 @@
+# addonManager.enable
+
+Whether the addon manager is enabled or not.
+
+## type
+
+```ts
+boolean
+```
+
+## default
+
+```jsonc
+true
+```
+
# codeLens.enable
启用代码度量。
@@ -242,6 +258,7 @@ Array<string>
* ``"global-in-nil-env"``
* ``"incomplete-signature-doc"``
* ``"index-in-func-name"``
+* ``"inject-field"``
* ``"invisible"``
* ``"jump-local-scope"``
* ``"keyword"``
@@ -285,10 +302,13 @@ Array<string>
* ``"miss-sep-in-table"``
* ``"miss-space-between"``
* ``"miss-symbol"``
+* ``"missing-fields"``
* ``"missing-global-doc"``
+* ``"missing-local-export-doc"``
* ``"missing-parameter"``
* ``"missing-return"``
* ``"missing-return-value"``
+* ``"name-style-check"``
* ``"need-check-nil"``
* ``"need-paren"``
* ``"nesting-long-mark"``
@@ -430,10 +450,15 @@ object<string, string>
"await": "Fallback",
/*
* codestyle-check
+ * name-style-check
* spell-check
*/
"codestyle": "Fallback",
/*
+ * global-element
+ */
+ "conventions": "Fallback",
+ /*
* duplicate-index
* duplicate-set-field
*/
@@ -453,6 +478,7 @@ object<string, string>
* duplicate-doc-param
* incomplete-signature-doc
* missing-global-doc
+ * missing-local-export-doc
* undefined-doc-class
* undefined-doc-name
* undefined-doc-param
@@ -473,10 +499,6 @@ object<string, string>
*/
"strict": "Fallback",
/*
- * global-element
- */
- "conventions": "None",
- /*
* no-unknown
*/
"strong": "Fallback",
@@ -484,6 +506,7 @@ object<string, string>
* assign-type-mismatch
* cast-local-type
* cast-type-mismatch
+ * inject-field
* need-check-nil
* param-type-mismatch
* return-type-mismatch
@@ -491,6 +514,7 @@ object<string, string>
*/
"type-check": "Fallback",
/*
+ * missing-fields
* missing-parameter
* missing-return
* missing-return-value
@@ -555,10 +579,15 @@ object<string, string>
"await": "Fallback",
/*
* codestyle-check
+ * name-style-check
* spell-check
*/
"codestyle": "Fallback",
/*
+ * global-element
+ */
+ "conventions": "Fallback",
+ /*
* duplicate-index
* duplicate-set-field
*/
@@ -578,6 +607,7 @@ object<string, string>
* duplicate-doc-param
* incomplete-signature-doc
* missing-global-doc
+ * missing-local-export-doc
* undefined-doc-class
* undefined-doc-name
* undefined-doc-param
@@ -598,10 +628,6 @@ object<string, string>
*/
"strict": "Fallback",
/*
- * global-element
- */
- "conventions": "Fallback",
- /*
* no-unknown
*/
"strong": "Fallback",
@@ -609,6 +635,7 @@ object<string, string>
* assign-type-mismatch
* cast-local-type
* cast-type-mismatch
+ * inject-field
* need-check-nil
* param-type-mismatch
* return-type-mismatch
@@ -616,6 +643,7 @@ object<string, string>
*/
"type-check": "Fallback",
/*
+ * missing-fields
* missing-parameter
* missing-return
* missing-return-value
@@ -798,9 +826,10 @@ object<string, string>
*/
"global-in-nil-env": "Any",
/*
- Enable diagnostics for function definitions which are not fully annotated.
+ Incomplete @param or @return annotations for functions.
*/
"incomplete-signature-doc": "None",
+ "inject-field": "Opened",
/*
Enable diagnostics for accesses to fields which are invisible.
*/
@@ -809,11 +838,16 @@ object<string, string>
首字母小写的全局变量定义
*/
"lowercase-global": "Any",
+ "missing-fields": "Any",
/*
- Enable diagnostics for global function definitions which are not fully annotated.
+ Missing annotations for globals! Global functions must have a comment and annotations for all parameters and return values.
*/
"missing-global-doc": "None",
/*
+ Missing annotations for exported locals! Exported local functions must have a comment and annotations for all parameters and return values.
+ */
+ "missing-local-export-doc": "None",
+ /*
Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
*/
"missing-parameter": "Any",
@@ -826,6 +860,10 @@ object<string, string>
*/
"missing-return-value": "Any",
/*
+ Enable diagnostics for name style.
+ */
+ "name-style-check": "None",
+ /*
Enable diagnostics for variable usages if `nil` or an optional (potentially `nil`) value was assigned to the variable before.
*/
"need-check-nil": "Opened",
@@ -1057,9 +1095,10 @@ object<string, string>
*/
"global-in-nil-env": "Warning",
/*
- Enable diagnostics for function definitions which are not fully annotated.
+ Incomplete @param or @return annotations for functions.
*/
"incomplete-signature-doc": "Warning",
+ "inject-field": "Warning",
/*
Enable diagnostics for accesses to fields which are invisible.
*/
@@ -1068,11 +1107,16 @@ object<string, string>
首字母小写的全局变量定义
*/
"lowercase-global": "Information",
+ "missing-fields": "Warning",
/*
- Enable diagnostics for global function definitions which are not annotated.
+ Missing annotations for globals! Global functions must have a comment and annotations for all parameters and return values.
*/
"missing-global-doc": "Warning",
/*
+ Missing annotations for exported locals! Exported local functions must have a comment and annotations for all parameters and return values.
+ */
+ "missing-local-export-doc": "Warning",
+ /*
Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
*/
"missing-parameter": "Warning",
@@ -1085,6 +1129,10 @@ object<string, string>
*/
"missing-return-value": "Warning",
/*
+ Enable diagnostics for name style.
+ */
+ "name-style-check": "Warning",
+ /*
Enable diagnostics for variable usages if `nil` or an optional (potentially `nil`) value was assigned to the variable before.
*/
"need-check-nil": "Warning",
@@ -1616,7 +1664,7 @@ string
# misc.parameters
-VSCode中启动语言服务时的[命令行参数](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#arguments)。
+VSCode中启动语言服务时的[命令行参数](https://luals.github.io/wiki/usage#arguments)。
## type
@@ -1630,6 +1678,22 @@ Array<string>
[]
```
+# nameStyle.config
+
+设定命名风格检查的配置
+
+## type
+
+```ts
+Object<string, string | array>
+```
+
+## default
+
+```jsonc
+{}
+```
+
# runtime.builtin
调整内置库的启用状态,你可以根据实际运行环境禁用掉不存在的库(或重新定义)。
@@ -1664,6 +1728,8 @@ object<string, string>
"ffi": "default",
"io": "default",
"jit": "default",
+ "jit.profile": "default",
+ "jit.util": "default",
"math": "default",
"os": "default",
"package": "default",
@@ -1791,7 +1857,7 @@ false
# runtime.plugin
-插件路径,请查阅[文档](https://github.com/LuaLS/lua-language-server/wiki/Plugins)了解用法。
+插件路径,请查阅[文档](https://luals.github.io/wiki/plugins)了解用法。
## type
@@ -2110,13 +2176,20 @@ true
## type
```ts
-boolean
+string
```
+## enum
+
+* ``"Ask"``
+* ``"Apply"``
+* ``"ApplyInMemory"``
+* ``"Disable"``
+
## default
```jsonc
-true
+"Ask"
```
# workspace.ignoreDir