make doc with description of groups

1 files changed, 316 insertions, 68 deletions

diff --git a/doc/en-us/config.md b/doc/en-us/config.md
index 629c2038..11c51f05 100644
--- a/doc/en-us/config.md
+++ b/doc/en-us/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
 {
+    /*
+    Enable ambiguous operator precedence diagnostics. For example, the `num or 0 + 1` expression will be suggested `(num or 0) + 1` instead.
+    */
     "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",
+    /*
+    Enable duplicate table index diagnostics.
+    */
     "duplicate-index": "Any",
     "duplicate-set-field": "Any",
+    /*
+    Enable empty code block diagnostics.
+    */
     "empty-block": "Opened",
+    /*
+    Enable cannot use global variables （ `_ENV` is set to `nil`） diagnostics.
+    */
     "global-in-nil-env": "Any",
+    /*
+    Enable lowercase global variable definition diagnostics.
+    */
     "lowercase-global": "Any",
     "missing-parameter": "Any",
     "need-check-nil": "Opened",
+    /*
+    在字面量表中，2行代码之间缺少分隔符，在语法上被解析为了一次索引操作
+    */
     "newfield-call": "Any",
+    /*
+    Enable newline call diagnostics. Is's raised when a line starting with `(` is encountered, which is syntactically parsed as a function call on the previous line.
+    */
     "newline-call": "Any",
     "no-unknown": "None",
     "not-yieldable": "None",
     "param-type-mismatch": "Opened",
+    /*
+    Enable redefined local variable diagnostics.
+    */
     "redefined-local": "Opened",
+    /*
+    Enable redundant function parameter diagnostics.
+    */
     "redundant-parameter": "Any",
     "redundant-return": "Opened",
+    /*
+    Enable the redundant values assigned diagnostics. It's raised during assignment operation, when the number of values is higher than the number of objects being assigned.
+    */
     "redundant-value": "Any",
     "spell-check": "None",
+    /*
+    Enable trailing space diagnostics.
+    */
     "trailing-space": "Opened",
     "unbalanced-assignments": "Any",
     "undefined-doc-class": "Any",
     "undefined-doc-name": "Any",
     "undefined-doc-param": "Any",
+    /*
+    Enable undefined environment variable diagnostics. It's raised when `_ENV` table is set to a new literal table, but the used global variable is no longer present in the global environment.
+    */
     "undefined-env-child": "Any",
     "undefined-field": "Opened",
+    /*
+    Enable undefined global variable diagnostics.
+    */
     "undefined-global": "Any",
     "unknown-cast-variable": "Any",
     "unknown-diag-code": "Any",
+    /*
+    Enable unused function diagnostics.
+    */
     "unused-function": "Opened",
+    /*
+    Enable unused label diagnostics.
+    */
     "unused-label": "Opened",
+    /*
+    Enable unused local variable diagnostics.
+    */
     "unused-local": "Opened",
+    /*
+    Enable unused vararg diagnostics.
+    */
     "unused-vararg": "Opened"
 }
 ```
@@ -473,8 +670,11 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
+    /*
+    Enable ambiguous operator precedence diagnostics. For example, the `num or 0 + 1` expression will be suggested `(num or 0) + 1` instead.
+    */
     "ambiguity-1": "Warning",
     "assign-type-mismatch": "Warning",
     "await-in-sync": "Warning",
@@ -492,36 +692,84 @@ object<string, string>
     "duplicate-doc-alias": "Warning",
     "duplicate-doc-field": "Warning",
     "duplicate-doc-param": "Warning",
+    /*
+    Enable duplicate table index diagnostics.
+    */
     "duplicate-index": "Warning",
     "duplicate-set-field": "Warning",
+    /*
+    Enable empty code block diagnostics.
+    */
     "empty-block": "Hint",
+    /*
+    Enable cannot use global variables （ `_ENV` is set to `nil`） diagnostics.
+    */
     "global-in-nil-env": "Warning",
+    /*
+    Enable lowercase global variable definition diagnostics.
+    */
     "lowercase-global": "Information",
     "missing-parameter": "Warning",
     "need-check-nil": "Warning",
+    /*
+    在字面量表中，2行代码之间缺少分隔符，在语法上被解析为了一次索引操作
+    */
     "newfield-call": "Warning",
+    /*
+    Enable newline call diagnostics. Is's raised when a line starting with `(` is encountered, which is syntactically parsed as a function call on the previous line.
+    */
     "newline-call": "Warning",
     "no-unknown": "Warning",
     "not-yieldable": "Warning",
     "param-type-mismatch": "Warning",
+    /*
+    Enable redefined local variable diagnostics.
+    */
     "redefined-local": "Hint",
+    /*
+    Enable redundant function parameter diagnostics.
+    */
     "redundant-parameter": "Warning",
     "redundant-return": "Hint",
+    /*
+    Enable the redundant values assigned diagnostics. It's raised during assignment operation, when the number of values is higher than the number of objects being assigned.
+    */
     "redundant-value": "Warning",
     "spell-check": "Information",
+    /*
+    Enable trailing space diagnostics.
+    */
     "trailing-space": "Hint",
     "unbalanced-assignments": "Warning",
     "undefined-doc-class": "Warning",
     "undefined-doc-name": "Warning",
     "undefined-doc-param": "Warning",
+    /*
+    Enable undefined environment variable diagnostics. It's raised when `_ENV` table is set to a new literal table, but the used global variable is no longer present in the global environment.
+    */
     "undefined-env-child": "Information",
     "undefined-field": "Warning",
+    /*
+    Enable undefined global variable diagnostics.
+    */
     "undefined-global": "Warning",
     "unknown-cast-variable": "Warning",
     "unknown-diag-code": "Warning",
+    /*
+    Enable unused function diagnostics.
+    */
     "unused-function": "Hint",
+    /*
+    Enable unused label diagnostics.
+    */
     "unused-label": "Hint",
+    /*
+    Enable unused local variable diagnostics.
+    */
     "unused-local": "Hint",
+    /*
+    Enable unused vararg diagnostics.
+    */
     "unused-vararg": "Hint"
 }
 ```
@@ -538,7 +786,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 3000
 ```
 
@@ -554,7 +802,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 100
 ```
 
@@ -572,7 +820,7 @@ Object<string, string>
 
 ## default
 
-```json
+```jsonc
 {}
 ```
 
@@ -588,7 +836,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -610,7 +858,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Auto"
 ```
 
@@ -626,7 +874,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -642,7 +890,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -664,7 +912,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "All"
 ```
 
@@ -680,7 +928,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -696,7 +944,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -712,7 +960,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -728,7 +976,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 5
 ```
 
@@ -745,7 +993,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -761,7 +1009,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 50
 ```
 
@@ -777,7 +1025,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -793,7 +1041,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -809,7 +1057,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 1000
 ```
 
@@ -825,7 +1073,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -852,7 +1100,7 @@ object<string, string>
 
 ## default
 
-```json
+```jsonc
 {
     "basic": "default",
     "bit": "default",
@@ -891,7 +1139,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "utf8"
 ```
 
@@ -907,7 +1155,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "${version} ${language} ${encoding}"
 ```
 
@@ -938,7 +1186,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -958,7 +1206,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 ["?.lua","?/init.lua"]
 ```
 
@@ -974,7 +1222,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -990,7 +1238,7 @@ string
 
 ## default
 
-```json
+```jsonc
 ""
 ```
 
@@ -1013,7 +1261,7 @@ Object<string, string>
 
 ## default
 
-```json
+```jsonc
 {}
 ```
 
@@ -1029,7 +1277,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -1053,7 +1301,7 @@ string
 
 ## default
 
-```json
+```jsonc
 "Lua 5.4"
 ```
 
@@ -1069,7 +1317,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1085,7 +1333,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1101,7 +1349,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 false
 ```
 
@@ -1117,7 +1365,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1133,7 +1381,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1149,7 +1397,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -1166,7 +1414,7 @@ boolean | null
 
 ## default
 
-```json
+```jsonc
 null
 ```
 
@@ -1182,7 +1430,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1198,7 +1446,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1222,7 +1470,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1238,7 +1486,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 [".vscode"]
 ```
 
@@ -1254,7 +1502,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1270,7 +1518,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
 
@@ -1286,7 +1534,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 5000
 ```
 
@@ -1302,7 +1550,7 @@ integer
 
 ## default
 
-```json
+```jsonc
 500
 ```
 
@@ -1318,7 +1566,7 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 ["file","untitled","git"]
 ```
 
@@ -1334,7 +1582,7 @@ boolean
 
 ## default
 
-```json
+```jsonc
 true
 ```
 
@@ -1350,6 +1598,6 @@ Array<string>
 
 ## default
 
-```json
+```jsonc
 []
 ```
\ No newline at end of file