3.3.0

Author: sumneko

changelog.md

@@ -1,5 +1,51 @@
 # changelog
 
+## 3.3.0
+`2022-6-15`
+* `NEW` `LuaDoc` supports `` `CODE` ``
+  ```lua
+  ---@type `CONST.X` | `CONST.Y`
+  local x
+
+  if x == -- suggest `CONST.X` and `CONST.Y` here
+  ```
+* `CHG` infer type by `error`
+  ```lua
+  ---@type integer|nil
+  local n
+
+  if not n then
+      error('n is nil')
+  end
+
+  print(n) -- `n` is `integer` here
+  ```
+* `CHG` infer type by `t and t.x`
+  ```lua
+  ---@type table|nil
+  local t
+
+  local s = t and t.x or 1 -- `t` in `t.x` is `table`
+  ```
+* `CHG` infer type by `type(x)`
+  ```lua
+  local x
+
+  if type(x) == 'string' then
+      print(x) -- `x` is `string` here
+  end
+
+  local tp = type(x)
+
+  if tp == 'boolean' then
+      print(x) -- `x` is `boolean` here
+  end
+  ```
+* `CHG` infer type by `>`/`<`/`>=`/`<=`
+* `FIX` with clients that support LSP 3.17 (VSCode), workspace diagnostics are triggered every time when opening a file.
+* `FIX` [#1204](https://github.com/sumneko/lua-language-server/issues/1204)
+* `FIX` [#1208](https://github.com/sumneko/lua-language-server/issues/1208)
+
 ## 3.2.5
 `2022-6-9`
 * `NEW` provide config docs in `LUA_LANGUAGE_SERVER/doc/`

package.json

@@ -1513,7 +1513,9 @@
 								"loadfile",
 								"pcall",
 								"xpcall",
-								"assert"
+								"assert",
+								"error",
+								"type"
 							],
 							"type": "string"
 						}
@@ -1842,5 +1844,5 @@
 		"type": "git",
 		"url": "https://github.com/sumneko/lua-language-server"
 	},
-	"version": "3.2.5"
+	"version": "3.3.0"
 }

package.nls.json

@@ -67,6 +67,7 @@
     "config.hint.arrayIndex.Auto": "Show hints only when the table is greater than 3 items, or the table is a mixed table.",
     "config.hint.arrayIndex.Disable": "Disable hints of array index.",
     "config.hint.arrayIndex.Enable": "Show hints in all tables.",
+    "config.hint.await": "If the called function is marked `---@async`, prompt `await` at the call.",
     "config.hint.enable": "Enable inlay hint.",
     "config.hint.paramName": "Show hints of parameter name at the function call.",
     "config.hint.paramName.All": "All types of parameters are shown.",
@@ -76,6 +77,7 @@
     "config.hint.setType": "Show hints of type at assignment operation.",
     "config.hover.enable": "Enable hover.",
     "config.hover.enumsLimit": "When the value corresponds to multiple types, limit the number of types displaying.",
+    "config.hover.expandAlias": "Whether to expand the alias. For example, expands `---@alias myType boolean|number` appears as `boolean|number`, otherwise it appears as `myType'.\n",
     "config.hover.fieldInfer": "When hovering to view a table, type infer will be performed for each field. When the accumulated time of type infer reaches the set value (MS), the type infer of subsequent fields will be skipped.",
     "config.hover.previewFields": "When hovering to view a table, limits the maximum number of previews for fields.",
     "config.hover.viewNumber": "Hover to view numeric content (only if literal is not decimal).",

package.nls.pt-br.json

@@ -67,6 +67,7 @@
     "config.hint.arrayIndex.Auto": "Show hints only when the table is greater than 3 items, or the table is a mixed table.",
     "config.hint.arrayIndex.Disable": "Disable hints of array index.",
     "config.hint.arrayIndex.Enable": "Show hints in all tables.",
+    "config.hint.await": "If the called function is marked `---@async`, prompt `await` at the call.",
     "config.hint.enable": "Enable inlay hint.",
     "config.hint.paramName": "Show hints of parameter name at the function call.",
     "config.hint.paramName.All": "All types of parameters are shown.",
@@ -76,6 +77,7 @@
     "config.hint.setType": "Show hints of type at assignment operation.",
     "config.hover.enable": "Enable hover.",
     "config.hover.enumsLimit": "When the value corresponds to multiple types, limit the number of types displaying.",
+    "config.hover.expandAlias": "Whether to expand the alias. For example, expands `---@alias myType boolean|number` appears as `boolean|number`, otherwise it appears as `myType'.\n",
     "config.hover.fieldInfer": "When hovering to view a table, type infer will be performed for each field. When the accumulated time of type infer reaches the set value (MS), the type infer of subsequent fields will be skipped.",
     "config.hover.previewFields": "When hovering to view a table, limits the maximum number of previews for fields.",
     "config.hover.viewNumber": "Hover to view numeric content (only if literal is not decimal).",

package.nls.zh-cn.json

@@ -67,6 +67,7 @@
     "config.hint.arrayIndex.Auto": "只有表大于3项，或者表是混合类型时才进行提示。",
     "config.hint.arrayIndex.Disable": "禁用数组索引提示。",
     "config.hint.arrayIndex.Enable": "所有的表中都提示数组索引。",
+    "config.hint.await": "如果调用的函数被标记为了 `---@async` ，则在调用处提示 `await` 。",
     "config.hint.enable": "启用内联提示。",
     "config.hint.paramName": "在函数调用处提示参数名。",
     "config.hint.paramName.All": "所有类型的参数均进行提示。",
@@ -76,6 +77,7 @@
     "config.hint.setType": "在赋值操作位置提示类型。",
     "config.hover.enable": "启用悬停提示。",
     "config.hover.enumsLimit": "当值对应多个类型时，限制类型的显示数量。",
+    "config.hover.expandAlias": "是否展开别名。例如 `---@alias myType boolean|number` 展开后显示为 `boolean|number`，否则显示为 `myType`。\n",
     "config.hover.fieldInfer": "悬停提示查看表时，会对表的每个字段进行类型推测，当类型推测的用时累计达到该设定值（毫秒）时，将跳过后续字段的类型推测。",
     "config.hover.previewFields": "悬停提示查看表时，限制表内字段的最大预览数量。",
     "config.hover.viewNumber": "悬停提示查看数字内容（仅当字面量不是十进制时）。",

package.nls.zh-tw.json

@@ -67,6 +67,7 @@
     "config.hint.arrayIndex.Auto": "只有表大於3項，或者表是混合型別時才進行提示。",
     "config.hint.arrayIndex.Disable": "停用陣列索引提示。",
     "config.hint.arrayIndex.Enable": "所有的表中都提示陣列索引。",
+    "config.hint.await": "If the called function is marked `---@async`, prompt `await` at the call.",
     "config.hint.enable": "啟用內嵌提示。",
     "config.hint.paramName": "在函式呼叫處提示參數名。",
     "config.hint.paramName.All": "所有型別的參數均進行提示。",
@@ -76,6 +77,7 @@
     "config.hint.setType": "在賦值操作位置提示型別。",
     "config.hover.enable": "啟用懸浮提示。",
     "config.hover.enumsLimit": "當值對應多個型別時，限制型別的顯示數量。",
+    "config.hover.expandAlias": "Whether to expand the alias. For example, expands `---@alias myType boolean|number` appears as `boolean|number`, otherwise it appears as `myType'.\n",
     "config.hover.fieldInfer": "懸浮提示檢視表時，會對表的每個欄位進行型別推測，當型別推測的用時累計達到該設定值（毫秒）時，將跳過後續欄位的型別推測。",
     "config.hover.previewFields": "懸浮提示檢視表時，限制表內欄位的最大預覽數量。",
     "config.hover.viewNumber": "懸浮提示檢視數字內容（僅當字面常數不是十進制時）。",

package/build.lua

@@ -1,6 +1,6 @@
 local json = require 'json-beautify'
 
-local VERSION = "3.2.5"
+local VERSION = "3.3.0"
 
 local package = require 'package.package'
 local fsu     = require 'fs-utility'

server

@@ -1250,7 +1250,7 @@
         },
         "hint.await": {
             "default": true,
-            "markdownDescription": "%config.hint.await%",
+            "markdownDescription": "If the called function is marked `---@async`, prompt `await` at the call.",
             "scope": "resource",
             "type": "boolean"
         },
@@ -1327,7 +1327,7 @@
         },
         "hover.expandAlias": {
             "default": true,
-            "markdownDescription": "%config.hover.expandAlias%",
+            "markdownDescription": "Whether to expand the alias. For example, expands `---@alias myType boolean|number` appears as `boolean|number`, otherwise it appears as `myType'.\n",
             "scope": "resource",
             "type": "boolean"
         },
@@ -1652,7 +1652,9 @@
                         "loadfile",
                         "pcall",
                         "xpcall",
-                        "assert"
+                        "assert",
+                        "error",
+                        "type"
                     ],
                     "type": "string"
                 }

setting/schema-pt-br.json

@@ -1250,7 +1250,7 @@
         },
         "hint.await": {
             "default": true,
-            "markdownDescription": "%config.hint.await%",
+            "markdownDescription": "如果调用的函数被标记为了 `---@async` ，则在调用处提示 `await` 。",
             "scope": "resource",
             "type": "boolean"
         },
@@ -1327,7 +1327,7 @@
         },
         "hover.expandAlias": {
             "default": true,
-            "markdownDescription": "%config.hover.expandAlias%",
+            "markdownDescription": "是否展开别名。例如 `---@alias myType boolean|number` 展开后显示为 `boolean|number`，否则显示为 `myType`。\n",
             "scope": "resource",
             "type": "boolean"
         },
@@ -1652,7 +1652,9 @@
                         "loadfile",
                         "pcall",
                         "xpcall",
-                        "assert"
+                        "assert",
+                        "error",
+                        "type"
                     ],
                     "type": "string"
                 }