summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/en-us/config.md55
-rw-r--r--doc/pt-br/config.md55
-rw-r--r--doc/zh-cn/config.md52
-rw-r--r--doc/zh-tw/config.md59
4 files changed, 128 insertions, 93 deletions
diff --git a/doc/en-us/config.md b/doc/en-us/config.md
index cd085d84..629c2038 100644
--- a/doc/en-us/config.md
+++ b/doc/en-us/config.md
@@ -242,7 +242,15 @@ Array<string>
# diagnostics.groupFileStatus
-**Missing description!!**
+Modify the diagnostic needed file status in a group.
+
+* Opened: only diagnose opened files
+* Any: diagnose all files
+* None: disable this diagnostic
+
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.neededFileStatus` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -278,7 +286,10 @@ object<string, string>
# diagnostics.groupSeverity
-**Missing description!!**
+Modify the diagnostic severity in a group.
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.severity` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -361,7 +372,9 @@ string
* Opened: only diagnose opened files
* Any: diagnose all files
-* Disable: disable this diagnostic
+* None: disable this diagnostic
+
+End with `!` means override the group setting `diagnostics.groupFileStatus`.
## type
@@ -375,6 +388,9 @@ object<string, string>
* ``"Any"``
* ``"Opened"``
* ``"None"``
+* ``"Any!"``
+* ``"Opened!"``
+* ``"None!"``
## default
@@ -433,7 +449,10 @@ object<string, string>
# diagnostics.severity
-Modified diagnostic severity.
+Modify the diagnostic severity.
+
+End with `!` means override the group setting `diagnostics.groupSeverity`.
+
## type
@@ -447,6 +466,10 @@ object<string, string>
* ``"Warning"``
* ``"Information"``
* ``"Hint"``
+* ``"Error!"``
+* ``"Warning!"``
+* ``"Information!"``
+* ``"Hint!"``
## default
@@ -537,7 +560,9 @@ integer
# format.defaultConfig
-**Missing description!!**
+The default format configuration. Has a lower priority than `.editorconfig` file in the workspace.
+Read [formatter docs](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs) to learn usage.
+
## type
@@ -872,7 +897,7 @@ string
# runtime.meta
-**Missing description!!**
+Format of the directory name of the meta files.
## type
@@ -1114,7 +1139,7 @@ true
# spell.dict
-**Missing description!!**
+Custom words for spell checking.
## type
@@ -1145,22 +1170,6 @@ boolean | null
null
```
-# typeCheck.enable
-
-**Missing description!!**
-
-## type
-
-```ts
-boolean
-```
-
-## default
-
-```json
-true
-```
-
# window.progressBar
Show progress bar in status bar.
diff --git a/doc/pt-br/config.md b/doc/pt-br/config.md
index cd085d84..629c2038 100644
--- a/doc/pt-br/config.md
+++ b/doc/pt-br/config.md
@@ -242,7 +242,15 @@ Array<string>
# diagnostics.groupFileStatus
-**Missing description!!**
+Modify the diagnostic needed file status in a group.
+
+* Opened: only diagnose opened files
+* Any: diagnose all files
+* None: disable this diagnostic
+
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.neededFileStatus` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -278,7 +286,10 @@ object<string, string>
# diagnostics.groupSeverity
-**Missing description!!**
+Modify the diagnostic severity in a group.
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.severity` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -361,7 +372,9 @@ string
* Opened: only diagnose opened files
* Any: diagnose all files
-* Disable: disable this diagnostic
+* None: disable this diagnostic
+
+End with `!` means override the group setting `diagnostics.groupFileStatus`.
## type
@@ -375,6 +388,9 @@ object<string, string>
* ``"Any"``
* ``"Opened"``
* ``"None"``
+* ``"Any!"``
+* ``"Opened!"``
+* ``"None!"``
## default
@@ -433,7 +449,10 @@ object<string, string>
# diagnostics.severity
-Modified diagnostic severity.
+Modify the diagnostic severity.
+
+End with `!` means override the group setting `diagnostics.groupSeverity`.
+
## type
@@ -447,6 +466,10 @@ object<string, string>
* ``"Warning"``
* ``"Information"``
* ``"Hint"``
+* ``"Error!"``
+* ``"Warning!"``
+* ``"Information!"``
+* ``"Hint!"``
## default
@@ -537,7 +560,9 @@ integer
# format.defaultConfig
-**Missing description!!**
+The default format configuration. Has a lower priority than `.editorconfig` file in the workspace.
+Read [formatter docs](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs) to learn usage.
+
## type
@@ -872,7 +897,7 @@ string
# runtime.meta
-**Missing description!!**
+Format of the directory name of the meta files.
## type
@@ -1114,7 +1139,7 @@ true
# spell.dict
-**Missing description!!**
+Custom words for spell checking.
## type
@@ -1145,22 +1170,6 @@ boolean | null
null
```
-# typeCheck.enable
-
-**Missing description!!**
-
-## type
-
-```ts
-boolean
-```
-
-## default
-
-```json
-true
-```
-
# window.progressBar
Show progress bar in status bar.
diff --git a/doc/zh-cn/config.md b/doc/zh-cn/config.md
index 5f2dde49..fdfbac11 100644
--- a/doc/zh-cn/config.md
+++ b/doc/zh-cn/config.md
@@ -242,7 +242,15 @@ Array<string>
# diagnostics.groupFileStatus
-**Missing description!!**
+批量修改一个组中的文件状态。
+
+* Opened: 只诊断打开的文件
+* Any: 诊断任何文件
+* None: 禁用此诊断
+
+设置为 `Fallback` 意味着组中的诊断由 `diagnostics.neededFileStatus` 单独设置。
+其他设置将覆盖单独设置，但是不会覆盖以 `!` 结尾的设置。
+
## type
@@ -278,7 +286,10 @@ object<string, string>
# diagnostics.groupSeverity
-**Missing description!!**
+批量修改一个组中的诊断等级。
+设置为 `Fallback` 意味着组中的诊断由 `diagnostics.severity` 单独设置。
+其他设置将覆盖单独设置，但是不会覆盖以 `!` 结尾的设置。
+
## type
@@ -361,7 +372,9 @@ string
* Opened: 只诊断打开的文件
* Any: 诊断任何文件
-* Disable: 禁用此诊断
+* None: 禁用此诊断
+
+以 `!` 结尾的设置优先级高于组设置 `diagnostics.groupFileStatus`。
## type
@@ -375,6 +388,9 @@ object<string, string>
* ``"Any"``
* ``"Opened"``
* ``"None"``
+* ``"Any!"``
+* ``"Opened!"``
+* ``"None!"``
## default
@@ -434,6 +450,8 @@ object<string, string>
# diagnostics.severity
修改诊断等级。
+以 `!` 结尾的设置优先级高于组设置 `diagnostics.groupSeverity`。
+
## type
@@ -447,6 +465,10 @@ object<string, string>
* ``"Warning"``
* ``"Information"``
* ``"Hint"``
+* ``"Error!"``
+* ``"Warning!"``
+* ``"Information!"``
+* ``"Hint!"``
## default
@@ -537,7 +559,9 @@ integer
# format.defaultConfig
-**Missing description!!**
+默认的格式化配置，优先级低于工作区内的 `.editorconfig` 文件。
+请查阅[格式化文档](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs)了解用法。
+
## type
@@ -872,7 +896,7 @@ string
# runtime.meta
-**Missing description!!**
+meta文件的目录名称格式。
## type
@@ -1114,7 +1138,7 @@ true
# spell.dict
-**Missing description!!**
+拼写检查的自定义单词。
## type
@@ -1145,22 +1169,6 @@ boolean | null
null
```
-# typeCheck.enable
-
-**Missing description!!**
-
-## type
-
-```ts
-boolean
-```
-
-## default
-
-```json
-true
-```
-
# window.progressBar
在状态栏显示进度条。
diff --git a/doc/zh-tw/config.md b/doc/zh-tw/config.md
index aa9f85cc..e8ea18c5 100644
--- a/doc/zh-tw/config.md
+++ b/doc/zh-tw/config.md
@@ -242,7 +242,15 @@ Array<string>
# diagnostics.groupFileStatus
-**Missing description!!**
+Modify the diagnostic needed file status in a group.
+
+* Opened: only diagnose opened files
+* Any: diagnose all files
+* None: disable this diagnostic
+
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.neededFileStatus` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -278,7 +286,10 @@ object<string, string>
# diagnostics.groupSeverity
-**Missing description!!**
+Modify the diagnostic severity in a group.
+`Fallback` means that diagnostics in this group are controlled by `diagnostics.severity` separately.
+Other settings will override individual settings without end of `!`.
+
## type
@@ -359,9 +370,11 @@ string
# diagnostics.neededFileStatus
-* Opened: 只診斷打開的檔案
-* Any: 診斷任何檔案
-* Disable: 停用此診斷
+* Opened: only diagnose opened files
+* Any: diagnose all files
+* None: disable this diagnostic
+
+End with `!` means override the group setting `diagnostics.groupFileStatus`.
## type
@@ -375,6 +388,9 @@ object<string, string>
* ``"Any"``
* ``"Opened"``
* ``"None"``
+* ``"Any!"``
+* ``"Opened!"``
+* ``"None!"``
## default
@@ -433,7 +449,10 @@ object<string, string>
# diagnostics.severity
-修改診斷等級。
+Modify the diagnostic severity.
+
+End with `!` means override the group setting `diagnostics.groupSeverity`.
+
## type
@@ -447,6 +466,10 @@ object<string, string>
* ``"Warning"``
* ``"Information"``
* ``"Hint"``
+* ``"Error!"``
+* ``"Warning!"``
+* ``"Information!"``
+* ``"Hint!"``
## default
@@ -537,7 +560,9 @@ integer
# format.defaultConfig
-**Missing description!!**
+The default format configuration. Has a lower priority than `.editorconfig` file in the workspace.
+Read [formatter docs](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs) to learn usage.
+
## type
@@ -872,7 +897,7 @@ string
# runtime.meta
-**Missing description!!**
+Format of the directory name of the meta files.
## type
@@ -1114,7 +1139,7 @@ true
# spell.dict
-**Missing description!!**
+Custom words for spell checking.
## type
@@ -1145,22 +1170,6 @@ boolean | null
null
```
-# typeCheck.enable
-
-**Missing description!!**
-
-## type
-
-```ts
-boolean
-```
-
-## default
-
-```json
-true
-```
-
# window.progressBar
在狀態欄顯示進度條。
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 03:31:42 +0000