summaryrefslogtreecommitdiff
path: root/doc/en-us
diff options
context:
space:
mode:
author最萌小汐 <sumneko@hotmail.com>2023-07-19 16:42:03 +0800
committer最萌小汐 <sumneko@hotmail.com>2023-07-19 16:42:03 +0800
commita8ea07192788c26f13baf4391c84a2d703b56812 (patch)
treeeeab8ef7ebf7715988a432033cb3bfd85c5d6aaf /doc/en-us
parent04ab77081defa1d66598a4429ad5707f5ab6a06d (diff)
downloadlua-language-server-a8ea07192788c26f13baf4391c84a2d703b56812.zip
make 3rds
Diffstat (limited to 'doc/en-us')
-rw-r--r--doc/en-us/config.md71
1 files changed, 57 insertions, 14 deletions
diff --git a/doc/en-us/config.md b/doc/en-us/config.md
index 65d471c8..84a3e9d6 100644
--- a/doc/en-us/config.md
+++ b/doc/en-us/config.md
@@ -1,3 +1,19 @@
+# addonManager.enable
+
+Whether the addon manager is enabled or not.
+
+## type
+
+```ts
+boolean
+```
+
+## default
+
+```jsonc
+true
+```
+
# codeLens.enable
Enable code lens.
@@ -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",
@@ -1065,7 +1088,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",
/*
@@ -1077,11 +1100,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",
/*
@@ -1097,6 +1120,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",
@@ -1642,6 +1669,22 @@ Array<string>
[]
```
+# nameStyle.config
+
+Set name style config
+
+## type
+
+```ts
+Object<string, table: 0000029B6DB8EAE0>
+```
+
+## default
+
+```jsonc
+{}
+```
+
# runtime.builtin
Adjust the enabled state of the built-in library. You can disable (or redefine) the non-existent library according to the actual runtime environment.