diff options
author | 最萌小汐 <sumneko@hotmail.com> | 2023-07-19 16:42:03 +0800 |
---|---|---|
committer | 最萌小汐 <sumneko@hotmail.com> | 2023-07-19 16:42:03 +0800 |
commit | a8ea07192788c26f13baf4391c84a2d703b56812 (patch) | |
tree | eeab8ef7ebf7715988a432033cb3bfd85c5d6aaf /doc/zh-cn | |
parent | 04ab77081defa1d66598a4429ad5707f5ab6a06d (diff) | |
download | lua-language-server-a8ea07192788c26f13baf4391c84a2d703b56812.zip |
make 3rds
Diffstat (limited to 'doc/zh-cn')
-rw-r--r-- | doc/zh-cn/config.md | 71 |
1 files changed, 57 insertions, 14 deletions
diff --git a/doc/zh-cn/config.md b/doc/zh-cn/config.md index ef094599..54caf6c7 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 启用代码度量。 @@ -290,6 +306,7 @@ Array<string> * ``"missing-parameter"`` * ``"missing-return"`` * ``"missing-return-value"`` +* ``"name-style-check"`` * ``"need-check-nil"`` * ``"need-paren"`` * ``"nesting-long-mark"`` @@ -431,10 +448,15 @@ object<string, string> "await": "Fallback", /* * codestyle-check + * name-style-check * spell-check */ "codestyle": "Fallback", /* + * global-element + */ + "conventions": "Fallback", + /* * duplicate-index * duplicate-set-field */ @@ -475,10 +497,6 @@ object<string, string> */ "strict": "Fallback", /* - * global-element - */ - "conventions": "None", - /* * no-unknown */ "strong": "Fallback", @@ -557,10 +575,15 @@ object<string, string> "await": "Fallback", /* * codestyle-check + * name-style-check * spell-check */ "codestyle": "Fallback", /* + * global-element + */ + "conventions": "Fallback", + /* * duplicate-index * duplicate-set-field */ @@ -601,10 +624,6 @@ object<string, string> */ "strict": "Fallback", /* - * global-element - */ - "conventions": "Fallback", - /* * no-unknown */ "strong": "Fallback", @@ -801,7 +820,7 @@ 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", /* @@ -813,11 +832,11 @@ object<string, string> */ "lowercase-global": "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", /* - Enable diagnostics for exported local function definitions which are not fully annotated. + 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", /* @@ -833,6 +852,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", @@ -1064,7 +1087,7 @@ 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", /* @@ -1076,11 +1099,11 @@ object<string, string> */ "lowercase-global": "Information", /* - 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", /* - Enable diagnostics for exported local function definitions which are not annotated. + 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", /* @@ -1096,6 +1119,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", @@ -1641,6 +1668,22 @@ Array<string> [] ``` +# nameStyle.config + +设定命名风格检查的配置 + +## type + +```ts +Object<string, table: 0000029B6DB8EAE0> +``` + +## default + +```jsonc +{} +``` + # runtime.builtin 调整内置库的启用状态,你可以根据实际运行环境禁用掉不存在的库(或重新定义)。 |