make doc with description of groups

1 files changed, 316 insertions, 68 deletions

diff --git a/doc/zh-cn/config.md b/doc/zh-cn/config.md
index fdfbac11..ac819e07 100644
--- a/doc/zh-cn/config.md
+++ b/doc/zh-cn/config.md
@@ -10,7 +10,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -32,7 +32,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Disable"
 ```
 
@@ -48,7 +48,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 0
 ```
 
@@ -64,7 +64,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -86,7 +86,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Replace"
 ```
 
@@ -102,7 +102,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "@"
 ```
 
@@ -118,7 +118,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "."
 ```
 
@@ -134,7 +134,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -156,7 +156,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Fallback"
 ```
 
@@ -172,7 +172,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -188,7 +188,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -204,7 +204,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 ["git"]
 ```
 
@@ -220,7 +220,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -236,7 +236,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -267,19 +267,92 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
+    /*
+    * ambiguity-1
+    * count-down-loop
+    * different-requires
+    * newfield-call
+    * newline-call
+    */
     "ambiguity": "Fallback",
+    /*
+    * await-in-sync
+    * not-yieldable
+    */
     "await": "Fallback",
+    /*
+    * codestyle-check
+    * spell-check
+    */
     "codestyle": "Fallback",
+    /*
+    * duplicate-index
+    * duplicate-set-field
+    */
     "duplicate": "Fallback",
+    /*
+    * global-in-nil-env
+    * lowercase-global
+    * undefined-env-child
+    * undefined-global
+    */
     "global": "Fallback",
+    /*
+    * cast-type-mismatch
+    * circle-doc-class
+    * doc-field-no-class
+    * duplicate-doc-alias
+    * duplicate-doc-field
+    * duplicate-doc-param
+    * undefined-doc-class
+    * undefined-doc-name
+    * undefined-doc-param
+    * unknown-cast-variable
+    * unknown-diag-code
+    */
     "luadoc": "Fallback",
-    "no-unknown": "Fallback",
+    /*
+    * redefined-local
+    */
     "redefined": "Fallback",
+    /*
+    * close-non-object
+    * deprecated
+    * discard-returns
+    */
     "strict": "Fallback",
+    /*
+    * no-unknown
+    */
+    "strong": "Fallback",
+    /*
+    * assign-type-mismatch
+    * cast-local-type
+    * cast-type-mismatch
+    * need-check-nil
+    * param-type-mismatch
+    * undefined-field
+    */
     "type-check": "Fallback",
+    /*
+    * missing-parameter
+    * redundant-parameter
+    * redundant-value
+    * unbalanced-assignments
+    */
     "unbalanced": "Fallback",
+    /*
+    * code-after-break
+    * empty-block
+    * redundant-return
+    * trailing-space
+    * unused-function
+    * unused-label
+    * unused-local
+    * unused-vararg
+    */
     "unused": "Fallback"
 }
 ```
@@ -307,19 +380,92 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
+    /*
+    * ambiguity-1
+    * count-down-loop
+    * different-requires
+    * newfield-call
+    * newline-call
+    */
     "ambiguity": "Fallback",
+    /*
+    * await-in-sync
+    * not-yieldable
+    */
     "await": "Fallback",
+    /*
+    * codestyle-check
+    * spell-check
+    */
     "codestyle": "Fallback",
+    /*
+    * duplicate-index
+    * duplicate-set-field
+    */
     "duplicate": "Fallback",
+    /*
+    * global-in-nil-env
+    * lowercase-global
+    * undefined-env-child
+    * undefined-global
+    */
     "global": "Fallback",
+    /*
+    * cast-type-mismatch
+    * circle-doc-class
+    * doc-field-no-class
+    * duplicate-doc-alias
+    * duplicate-doc-field
+    * duplicate-doc-param
+    * undefined-doc-class
+    * undefined-doc-name
+    * undefined-doc-param
+    * unknown-cast-variable
+    * unknown-diag-code
+    */
     "luadoc": "Fallback",
-    "no-unknown": "Fallback",
+    /*
+    * redefined-local
+    */
     "redefined": "Fallback",
+    /*
+    * close-non-object
+    * deprecated
+    * discard-returns
+    */
     "strict": "Fallback",
+    /*
+    * no-unknown
+    */
+    "strong": "Fallback",
+    /*
+    * assign-type-mismatch
+    * cast-local-type
+    * cast-type-mismatch
+    * need-check-nil
+    * param-type-mismatch
+    * undefined-field
+    */
     "type-check": "Fallback",
+    /*
+    * missing-parameter
+    * redundant-parameter
+    * redundant-value
+    * unbalanced-assignments
+    */
     "unbalanced": "Fallback",
+    /*
+    * code-after-break
+    * empty-block
+    * redundant-return
+    * trailing-space
+    * unused-function
+    * unused-label
+    * unused-local
+    * unused-vararg
+    */
     "unused": "Fallback"
 }
 ```
@@ -342,7 +488,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Opened"
 ```
 
@@ -364,7 +510,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Opened"
 ```
 
@@ -394,8 +540,11 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
+    /*
+    优先级歧义，如：`num or 0 + 1`，推测用户的实际期望为 `(num or 0) + 1` 
+    */
     "ambiguity-1": "Any",
     "assign-type-mismatch": "Opened",
     "await-in-sync": "None",
@@ -413,36 +562,84 @@ object<string, string>
     "duplicate-doc-alias": "Any",
     "duplicate-doc-field": "Any",
     "duplicate-doc-param": "Any",
+    /*
+    在字面量表中重复定义了索引
+    */
     "duplicate-index": "Any",
     "duplicate-set-field": "Any",
+    /*
+    空代码块
+    */
     "empty-block": "Opened",
+    /*
+    不能使用全局变量（ `_ENV` 被设置为了 `nil`）
+    */
     "global-in-nil-env": "Any",
+    /*
+    首字母小写的全局变量定义
+    */
     "lowercase-global": "Any",
     "missing-parameter": "Any",
     "need-check-nil": "Opened",
+    /*
+    在字面量表中，2行代码之间缺少分隔符，在语法上被解析为了一次索引操作
+    */
     "newfield-call": "Any",
+    /*
+    以 `(` 开始的新行，在语法上被解析为了上一行的函数调用
+    */
     "newline-call": "Any",
     "no-unknown": "None",
     "not-yieldable": "None",
     "param-type-mismatch": "Opened",
+    /*
+    重复定义的局部变量
+    */
     "redefined-local": "Opened",
+    /*
+    函数调用时，传入了多余的参数
+    */
     "redundant-parameter": "Any",
     "redundant-return": "Opened",
+    /*
+    赋值操作时，值的数量比被赋值的对象多
+    */
     "redundant-value": "Any",
     "spell-check": "None",
+    /*
+    后置空格
+    */
     "trailing-space": "Opened",
     "unbalanced-assignments": "Any",
     "undefined-doc-class": "Any",
     "undefined-doc-name": "Any",
     "undefined-doc-param": "Any",
+    /*
+    `_ENV` 被设置为了新的字面量表，但是试图获取的全局变量不再这张表中
+    */
     "undefined-env-child": "Any",
     "undefined-field": "Opened",
+    /*
+    未定义的全局变量
+    */
     "undefined-global": "Any",
     "unknown-cast-variable": "Any",
     "unknown-diag-code": "Any",
+    /*
+    未使用的函数
+    */
     "unused-function": "Opened",
+    /*
+    未使用的标签
+    */
     "unused-label": "Opened",
+    /*
+    未使用的局部变量
+    */
     "unused-local": "Opened",
+    /*
+    未使用的不定参数
+    */
     "unused-vararg": "Opened"
 }
 ```
@@ -472,8 +669,11 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
+    /*
+    优先级歧义，如：`num or 0 + 1`，推测用户的实际期望为 `(num or 0) + 1` 
+    */
     "ambiguity-1": "Warning",
     "assign-type-mismatch": "Warning",
     "await-in-sync": "Warning",
@@ -491,36 +691,84 @@ object<string, string>
     "duplicate-doc-alias": "Warning",
     "duplicate-doc-field": "Warning",
     "duplicate-doc-param": "Warning",
+    /*
+    在字面量表中重复定义了索引
+    */
     "duplicate-index": "Warning",
     "duplicate-set-field": "Warning",
+    /*
+    空代码块
+    */
     "empty-block": "Hint",
+    /*
+    不能使用全局变量（ `_ENV` 被设置为了 `nil`）
+    */
     "global-in-nil-env": "Warning",
+    /*
+    首字母小写的全局变量定义
+    */
     "lowercase-global": "Information",
     "missing-parameter": "Warning",
     "need-check-nil": "Warning",
+    /*
+    在字面量表中，2行代码之间缺少分隔符，在语法上被解析为了一次索引操作
+    */
     "newfield-call": "Warning",
+    /*
+    以 `(` 开始的新行，在语法上被解析为了上一行的函数调用
+    */
     "newline-call": "Warning",
     "no-unknown": "Warning",
     "not-yieldable": "Warning",
     "param-type-mismatch": "Warning",
+    /*
+    重复定义的局部变量
+    */
     "redefined-local": "Hint",
+    /*
+    函数调用时，传入了多余的参数
+    */
     "redundant-parameter": "Warning",
     "redundant-return": "Hint",
+    /*
+    赋值操作时，值的数量比被赋值的对象多
+    */
     "redundant-value": "Warning",
     "spell-check": "Information",
+    /*
+    后置空格
+    */
     "trailing-space": "Hint",
     "unbalanced-assignments": "Warning",
     "undefined-doc-class": "Warning",
     "undefined-doc-name": "Warning",
     "undefined-doc-param": "Warning",
+    /*
+    `_ENV` 被设置为了新的字面量表，但是试图获取的全局变量不再这张表中
+    */
     "undefined-env-child": "Information",
     "undefined-field": "Warning",
+    /*
+    未定义的全局变量
+    */
     "undefined-global": "Warning",
     "unknown-cast-variable": "Warning",
     "unknown-diag-code": "Warning",
+    /*
+    未使用的函数
+    */
     "unused-function": "Hint",
+    /*
+    未使用的标签
+    */
     "unused-label": "Hint",
+    /*
+    未使用的局部变量
+    */
     "unused-local": "Hint",
+    /*
+    未使用的不定参数
+    */
     "unused-vararg": "Hint"
 }
 ```
@@ -537,7 +785,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 3000
 ```
 
@@ -553,7 +801,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 100
 ```
 
@@ -571,7 +819,7 @@ Object<string, string>
 
 ## default
 
-```json
+```jsonc
 {}
 ```
 
@@ -587,7 +835,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -609,7 +857,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Auto"
 ```
 
@@ -625,7 +873,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -641,7 +889,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -663,7 +911,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "All"
 ```
 
@@ -679,7 +927,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -695,7 +943,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -711,7 +959,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -727,7 +975,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 5
 ```
 
@@ -744,7 +992,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -760,7 +1008,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 50
 ```
 
@@ -776,7 +1024,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -792,7 +1040,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -808,7 +1056,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 1000
 ```
 
@@ -824,7 +1072,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -851,7 +1099,7 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
     "basic": "default",
     "bit": "default",
@@ -890,7 +1138,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "utf8"
 ```
 
@@ -906,7 +1154,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "${version} ${language} ${encoding}"
 ```
 
@@ -937,7 +1185,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -957,7 +1205,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 ["?.lua","?/init.lua"]
 ```
 
@@ -973,7 +1221,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -989,7 +1237,7 @@ string
 
 ## default
 
-```json
+```jsonc
 ""
 ```
 
@@ -1012,7 +1260,7 @@ Object<string, string>
 
 ## default
 
-```json
+```jsonc
 {}
 ```
 
@@ -1028,7 +1276,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -1052,7 +1300,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Lua 5.4"
 ```
 
@@ -1068,7 +1316,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1084,7 +1332,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1100,7 +1348,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -1116,7 +1364,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1132,7 +1380,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1148,7 +1396,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -1165,7 +1413,7 @@ boolean | null
 
 ## default
 
-```json
+```jsonc
 null
 ```
 
@@ -1181,7 +1429,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1197,7 +1445,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1221,7 +1469,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1237,7 +1485,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 [".vscode"]
 ```
 
@@ -1253,7 +1501,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1269,7 +1517,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -1285,7 +1533,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 5000
 ```
 
@@ -1301,7 +1549,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 500
 ```
 
@@ -1317,7 +1565,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 ["file","untitled","git"]
 ```
 
@@ -1333,7 +1581,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1349,6 +1597,6 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
\ No newline at end of file