|
7 | 7 | "config.addonManager.enable": "Whether the addon manager is enabled or not.",
|
8 | 8 | "config.addonManager.repositoryBranch": "Specifies the git branch used by the addon manager.",
|
9 | 9 | "config.addonManager.repositoryPath": "Specifies the git path used by the addon manager.",
|
| 10 | + "config.addonRepositoryPath": "Specifies the addon repository path (not related to the addon manager).", |
10 | 11 | "config.codeLens.enable": "Enable code lens.",
|
11 | 12 | "config.color.mode": "Color mode.",
|
12 | 13 | "config.color.mode.Grammar": "Grammar color.",
|
|
93 | 94 | "config.diagnostics.need-check-nil": "Enable diagnostics for variable usages if `nil` or an optional (potentially `nil`) value was assigned to the variable before.",
|
94 | 95 | "config.diagnostics.neededFileStatus": "* Opened: only diagnose opened files\n* Any: diagnose all files\n* None: disable this diagnostic\n\nEnd with `!` means override the group setting `diagnostics.groupFileStatus`.\n",
|
95 | 96 | "config.diagnostics.newfield-call": "Enable newfield call diagnostics. It is raised when the parenthesis of a function call appear on the following line when defining a field in a table.",
|
96 |
| - "config.diagnostics.newline-call": "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.", |
| 97 | + "config.diagnostics.newline-call": "Enable newline call diagnostics. It's raised when a line starting with `(` is encountered, which is syntactically parsed as a function call on the previous line.", |
97 | 98 | "config.diagnostics.no-unknown": "Enable diagnostics for cases in which the type cannot be inferred.",
|
98 | 99 | "config.diagnostics.not-yieldable": "Enable diagnostics for calls to `coroutine.yield()` when it is not permitted.",
|
99 | 100 | "config.diagnostics.param-type-mismatch": "Enable diagnostics for function calls where the type of a provided parameter does not match the type of the annotated function definition.",
|
|
138 | 139 | "config.doc.packageName": "Treat specific field names as package, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are package, witch can only be accessed in the file where the definition is located.",
|
139 | 140 | "config.doc.privateName": "Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located.",
|
140 | 141 | "config.doc.protectedName": "Treat specific field names as protected, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are protected, witch can only be accessed in the class where the definition is located and its subclasses.",
|
141 |
| - "config.doc.regengine": "TODO: Needs documentation", |
142 |
| - "config.doc.regengine.glob": "TODO: Needs documentation", |
143 |
| - "config.doc.regengine.lua": "TODO: Needs documentation", |
144 |
| - "config.docScriptPath": "TODO: Needs documentation", |
| 142 | + "config.doc.regengine": "The regular expression engine used for matching documentation scope names.", |
| 143 | + "config.doc.regengine.glob": "The default lightweight pattern syntax.", |
| 144 | + "config.doc.regengine.lua": "Full Lua-style regular expressions.", |
| 145 | + "config.docScriptPath": "The regular expression engine used for matching documentation scope names.", |
145 | 146 | "config.format.defaultConfig": "The default format configuration. Has a lower priority than `.editorconfig` file in the workspace.\nRead [formatter docs](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs) to learn usage.\n",
|
146 | 147 | "config.format.enable": "Enable code formatter.",
|
147 | 148 | "config.hint.arrayIndex": "Show hints of array index when constructing a table.",
|
|
172 | 173 | "config.intelliSense.fastGlobal": "In the global variable completion, and view `_G` suspension prompt. This will slightly reduce the accuracy of type speculation, but it will have a significant performance improvement for projects that use a lot of global variables.",
|
173 | 174 | "config.intelliSense.searchDepth": "Set the search depth for IntelliSense. Increasing this value increases accuracy, but decreases performance. Different workspace have different tolerance for this setting. Please adjust it to the appropriate value.",
|
174 | 175 | "config.language.completeAnnotation": "(VSCode only) Automatically insert \"---@ \" after a line break following a annotation.",
|
175 |
| - "config.language.fixIndent": "(VSCode only) Fix incorrect auto-indentation, such as incorrect indentation when line breaks occur within a string containing the word \"function.\"", |
| 176 | + "config.language.fixIndent": "(VSCode only) Fix incorrect auto-indentation, such as incorrect indentation when line breaks occur within a string containing the word \"function\".", |
176 | 177 | "config.misc.executablePath": "Specify the executable path in VSCode.",
|
177 | 178 | "config.misc.parameters": "[Command line parameters](https://github.com/LuaLS/lua-telemetry-server/tree/master/method) when starting the language server in VSCode.",
|
178 |
| - "config.nameStyle.config": "Set name style config", |
| 179 | + "config.nameStyle.config": "Set name style config.\nRead [formatter docs](https://github.com/CppCXY/EmmyLuaCodeStyle/tree/master/docs) to learn usage.\n", |
179 | 180 | "config.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.\n\n* `default`: Indicates that the library will be enabled or disabled according to the runtime version\n* `enable`: always enable\n* `disable`: always disable\n",
|
180 | 181 | "config.runtime.builtin.basic": "TODO: Needs documentation",
|
181 | 182 | "config.runtime.builtin.bit": "TODO: Needs documentation",
|
|
226 | 227 | "config.type.castNumberToInteger": "Allowed to assign the `number` type to the `integer` type.",
|
227 | 228 | "config.type.checkTableShape": "Strictly check the shape of the table.\n",
|
228 | 229 | "config.type.inferParamType": "When a parameter type is not annotated, it is inferred from the function's call sites.\n\nWhen this setting is `false`, the type of the parameter is `any` when it is not annotated.\n",
|
229 |
| - "config.type.inferTableSize": "TODO: Needs documentation", |
| 230 | + "config.type.inferTableSize": "Maximum number of table fields analyzed during type inference.", |
| 231 | + "config.type.maxUnionVariants": "TODO: Needs documentation", |
230 | 232 | "config.type.weakNilCheck": "When checking the type of union type, ignore the `nil` in it.\n\nWhen this setting is `false`, the `number|nil` type cannot be assigned to the `number` type. It can be with `true`.\n",
|
231 | 233 | "config.type.weakUnionCheck": "Once one subtype of a union type meets the condition, the union type also meets the condition.\n\nWhen this setting is `false`, the `number|boolean` type cannot be assigned to the `number` type. It can be with `true`.\n",
|
232 | 234 | "config.typeFormat.config": "Configures the formatting behavior while typing Lua code.",
|
|
0 commit comments