Merge pull request #64 from armbrmaSICKAG/diagnostics-descriptions

Missing descriptions for diagnostics

Author: sumneko

package.nls.json

@@ -31,12 +31,29 @@
     "config.develop.enable": "Developer mode. Do not enable, performance will be affected.",
     "config.diagnostics.ambiguity": "* ambiguity-1\n* count-down-loop\n* different-requires\n* newfield-call\n* newline-call",
     "config.diagnostics.ambiguity-1": "Enable ambiguous operator precedence diagnostics. For example, the `num or 0 + 1` expression will be suggested `(num or 0) + 1` instead.",
+    "config.diagnostics.assign-type-mismatch": "Enable diagnostics for assignments in which the value's type does not match the type of the assigned variable.",
     "config.diagnostics.await": "* await-in-sync\n* not-yieldable",
+    "config.diagnostics.await-in-sync": "Enable diagnostics for calls of asynchronous functions within a synchronous function.",
+    "config.diagnostics.cast-local-type": "Enable diagnostics for casts of local variables where the target type does not match the defined type.",
+    "config.diagnostics.cast-type-mismatch": "Enable diagnostics for casts where the target type does not match the initial type.",
+    "config.diagnostics.circle-doc-class": "Enable diagnostics for two classes inheriting from each other introducing a circular relation.",
+    "config.diagnostics.close-non-object": "Enable diagnostics for attempts to close a variable with a non-object.",
+    "config.diagnostics.code-after-break": "Enable diagnostics for code placed after a break statement in a loop.",
     "config.diagnostics.codestyle": "* codestyle-check\n* spell-check",
+    "config.diagnostics.codestyle-check": "Enable diagnostics for incorrectly styled lines.",
+    "config.diagnostics.count-down-loop": "Enable diagnostics for `for` loops which will never reach their max/limit because the loop is incrementing instead of decrementing.",
+    "config.diagnostics.deprecated": "Enable diagnostics to highlight deprecated API.",
+    "config.diagnostics.different-requires": "Enable diagnostics for files which are required by two different paths.",
     "config.diagnostics.disable": "Disabled diagnostic (Use code in hover brackets).",
     "config.diagnostics.disableScheme": "Do not diagnose Lua files that use the following scheme.",
+    "config.diagnostics.discard-returns": "Enable diagnostics for calls of functions annotated with `---@nodiscard` where the return values are ignored.",
+    "config.diagnostics.doc-field-no-class": "Enable diagnostics to highlight a field annotation without a defining class annotation.",
     "config.diagnostics.duplicate": "* duplicate-index\n* duplicate-set-field",
+    "config.diagnostics.duplicate-doc-alias": "Enable diagnostics for a duplicated alias annotation name.",
+    "config.diagnostics.duplicate-doc-field": "Enable diagnostics for a duplicated field annotation name.",
+    "config.diagnostics.duplicate-doc-param": "Enable diagnostics for a duplicated param annotation name.",
     "config.diagnostics.duplicate-index": "Enable duplicate table index diagnostics.",
+    "config.diagnostics.duplicate-set-field": "Enable diagnostics for setting the same field in a class more than once.",
     "config.diagnostics.empty-block": "Enable empty code block diagnostics.",
     "config.diagnostics.enable": "Enable diagnostics.",
     "config.diagnostics.global": "* global-in-nil-env\n* lowercase-global\n* undefined-env-child\n* undefined-global",
@@ -54,21 +71,41 @@
     "config.diagnostics.libraryFiles.Opened": "Only when these files are opened will it be diagnosed.",
     "config.diagnostics.lowercase-global": "Enable lowercase global variable definition diagnostics.",
     "config.diagnostics.luadoc": "* circle-doc-class\n* doc-field-no-class\n* duplicate-doc-alias\n* duplicate-doc-field\n* duplicate-doc-param\n* undefined-doc-class\n* undefined-doc-name\n* undefined-doc-param\n* unknown-cast-variable\n* unknown-diag-code\n* unknown-operator",
+    "config.diagnostics.missing-parameter": "Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.",
+    "config.diagnostics.missing-return": "Enable diagnostics for functions with return annotations which have no return statement.",
+    "config.diagnostics.missing-return-value": "Enable diagnostics for return statements without values although the containing function declares returns.",
+    "config.diagnostics.need-check-nil": "Enable diagnostics for variable usages if `nil` or an optional (potentially `nil`) value was assigned to the variable before.",
     "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",
     "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.",
     "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.",
+    "config.diagnostics.no-unknown": "Enable diagnostics for cases in which the type cannot be inferred.",
+    "config.diagnostics.not-yieldable": "Enable diagnostics for calls to `coroutine.yield()` when it is not permitted.",
+    "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.",
     "config.diagnostics.redefined": "* redefined-local",
     "config.diagnostics.redefined-local": "Enable redefined local variable diagnostics.",
     "config.diagnostics.redundant-parameter": "Enable redundant function parameter diagnostics.",
+    "config.diagnostics.redundant-return": "Enable diagnostics for return statements which are not needed because the function would exit on its own.",
+    "config.diagnostics.redundant-return-value": "Enable diagnostics for return statements which return an extra value which is not specified by a return annotation.",
     "config.diagnostics.redundant-value": "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.",
+    "config.diagnostics.return-type-mismatch": "Enable diagnostics for return values whose type does not match the type declared in the corresponding return annotation.",
     "config.diagnostics.severity": "Modify the diagnostic severity.\n\nEnd with `!` means override the group setting `diagnostics.groupSeverity`.\n",
+    "config.diagnostics.spell-check": "Enable diagnostics for typos in strings.",
     "config.diagnostics.strict": "* close-non-object\n* deprecated\n* discard-returns",
     "config.diagnostics.strong": "* no-unknown",
     "config.diagnostics.trailing-space": "Enable trailing space diagnostics.",
     "config.diagnostics.type-check": "* assign-type-mismatch\n* cast-local-type\n* cast-type-mismatch\n* need-check-nil\n* param-type-mismatch\n* return-type-mismatch\n* undefined-field",
     "config.diagnostics.unbalanced": "* missing-parameter\n* missing-return\n* missing-return-value\n* redundant-parameter\n* redundant-return-value\n* redundant-value\n* unbalanced-assignments",
+    "config.diagnostics.unbalanced-assignments": "Enable diagnostics on multiple assignments if not all variables obtain a value (e.g., `local x,y = 1`).",
+    "config.diagnostics.undefined-doc-class": "Enable diagnostics for class annotations in which an undefined class is referenced.",
+    "config.diagnostics.undefined-doc-name": "Enable diagnostics for type annotations referencing an undefined type or alias.",
+    "config.diagnostics.undefined-doc-param": "Enable diagnostics for cases in which a parameter annotation is given without declaring the parameter in the function definition.",
     "config.diagnostics.undefined-env-child": "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.",
+    "config.diagnostics.undefined-field": "Enable diagnostics for cases in which an undefined field of a variable is read.",
     "config.diagnostics.undefined-global": "Enable undefined global variable diagnostics.",
+    "config.diagnostics.unknown-cast-variable": "Enable diagnostics for casts of undefined variables.",
+    "config.diagnostics.unknown-diag-code": "Enable diagnostics in cases in which an unknown diagnostics code is entered.",
+    "config.diagnostics.unknown-operator": "Enable diagnostics for unknown operators.",
+    "config.diagnostics.unreachable-code": "Enable diagnostics for unreachable code.",
     "config.diagnostics.unused": "* code-after-break\n* empty-block\n* redundant-return\n* trailing-space\n* unreachable-code\n* unused-function\n* unused-label\n* unused-local\n* unused-vararg",
     "config.diagnostics.unused-function": "Enable unused function diagnostics.",
     "config.diagnostics.unused-label": "Enable unused label diagnostics.",