Merge branch 'master' into fix/narrow

Author: sumneko

changelog.md

@@ -2,13 +2,18 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
-* `FIX` incorrect argument skip pattern for `--check_out_path=`, which incorrectly skips the next argument
+* `NEW` CLI: added `--help`.
 * `CHG` default path for `--doc_out_path` is the current directory
+* `FIX` incorrect argument skip pattern for `--check_out_path=`, which incorrectly skips the next argument
 * `FIX` incorrect error message for `--doc_update`.
 * `FIX` reimplement section `luals.config` in file doc.json
 * `FIX` incorrect file names in file doc.json
 * `FIX` remove extra `./` path prefix in the check report when using `--check=.`
 * `FIX` Narrowing of types with literal fields: [#3056](https://github.com/LuaLS/lua-language-server/issues/3056), [#3089](https://github.com/LuaLS/lua-language-server/issues/3089)
+* `FIX` correct lua version of `math.ult` and `math.type`
+* `FIX` incorrect links for `pattern` in `string` methods
+* `FIX` fix type annotations for bit module
+* `FIX` Another regression related to type narrow and generic param introduced since `v3.10.1` [#3087](https://github.com/LuaLS/lua-language-server/issues/3087)
 
 ## 3.13.6
 `2025-2-6`

locale/en-us/meta.lua

@@ -647,11 +647,13 @@ string.char                 =
 'Returns a string with length equal to the number of arguments, in which each character has the internal numeric code equal to its corresponding argument.'
 string.dump                 =
 'Returns a string containing a binary representation (a *binary chunk*) of the given function.'
-string.find                 =
+string.find['>5.2']         =
 'Looks for the first match of `pattern` (see §6.4.1) in the string.'
+string.find['=5.1']         =
+'Looks for the first match of `pattern` (see §5.4.1) in the string.'
 string.format               =
 'Returns a formatted version of its variable number of arguments following the description given in its first argument.'
-string.gmatch               =
+string.gmatch['>5.2']       =
 [[
 Returns an iterator function that, each time it is called, returns the next captures from `pattern` (see §6.4.1) over the string s.
 
@@ -664,17 +666,34 @@ As an example, the following loop will iterate over all the words from string s,
     end
 ```
 ]]
-string.gsub                 =
+string.gmatch['=5.1']       =
+[[
+Returns an iterator function that, each time it is called, returns the next captures from `pattern` (see §5.4.1) over the string s.
+
+As an example, the following loop will iterate over all the words from string s, printing one per line:
+```lua
+    s =
+"hello world from Lua"
+    for w in string.gmatch(s, "%a+") do
+        print(w)
+    end
+```
+]]
+string.gsub['>5.2']         =
 'Returns a copy of s in which all (or the first `n`, if given) occurrences of the `pattern` (see §6.4.1) have been replaced by a replacement string specified by `repl`.'
+string.gsub['=5.1']         =
+'Returns a copy of s in which all (or the first `n`, if given) occurrences of the `pattern` (see §5.4.1) have been replaced by a replacement string specified by `repl`.'
 string.len                  =
 'Returns its length.'
 string.lower                =
 'Returns a copy of this string with all uppercase letters changed to lowercase.'
-string.match                =
+string.match['>5.2']        =
 'Looks for the first match of `pattern` (see §6.4.1) in the string.'
-string.pack                 =
+string.match['=5.1']        =
+'Looks for the first match of `pattern` (see §5.4.1) in the string.'
+string.pack['>5.2']         =
 'Returns a binary string containing the values `v1`, `v2`, etc. packed (that is, serialized in binary form) according to the format string `fmt` (see §6.4.2) .'
-string.packsize             =
+string.packsize['>5.2']     =
 'Returns the size of a string resulting from `string.pack` with the given format string `fmt` (see §6.4.2) .'
 string.rep['>5.2']          =
 'Returns a string that is the concatenation of `n` copies of the string `s` separated by the string `sep`.'

meta/template/bit.lua

@@ -22,25 +22,22 @@ function bit.tohex(x, n) end
 function bit.bnot(x) end
 
 ---@param x   integer
----@param x2  integer
 ---@param ... integer
 ---@return integer y
 ---@nodiscard
-function bit.bor(x, x2, ...) end
+function bit.bor(x, ...) end
 
 ---@param x   integer
----@param x2  integer
 ---@param ... integer
 ---@return integer y
 ---@nodiscard
-function bit.band(x, x2, ...) end
+function bit.band(x, ...) end
 
 ---@param x   integer
----@param x2  integer
 ---@param ... integer
 ---@return integer y
 ---@nodiscard
-function bit.bxor(x, x2, ...) end
+function bit.bxor(x, ...) end
 
 ---@param x integer
 ---@param n integer

meta/template/math.lua

@@ -234,6 +234,7 @@ function math.tanh(x) end
 ---@nodiscard
 function math.tointeger(x) end
 
+---@version >5.3
 ---#DES 'math.type'
 ---@param x any
 ---@return
@@ -243,6 +244,7 @@ function math.tointeger(x) end
 ---@nodiscard
 function math.type(x) end
 
+---@version >5.3
 ---#DES 'math.ult'
 ---@param m integer
 ---@param n integer

script/cli/help.lua

@@ -0,0 +1,161 @@
+local util = require 'utility'
+
+--- @class cli.arg
+--- @field type? string|string[]
+--- @field description string Description of the argument in markdown format.
+--- @field example? string
+--- @field default? any
+
+--- @type table<string, cli.arg>
+local args = {
+    ['--help'] = {
+        description = [[
+            Print this message.
+        ]],
+    },
+    ['--check'] = {
+        type = 'string',
+        description = [[
+            Perform a "diagnosis report" where the results of the diagnosis are written to the logpath.
+        ]],
+        example = [[--check=C:\Users\Me\path\to\workspace]]
+    },
+    ['--checklevel'] = {
+        type = 'string',
+        description = [[
+            To be used with --check. The minimum level of diagnostic that should be logged.
+            Items with lower priority than the one listed here will not be written to the file.
+            Options include, in order of priority:
+
+                - Error
+                - Warning
+                - Information
+                - Hint
+        ]],
+        default = 'Warning',
+        example = [[--checklevel=Information]]
+    },
+    ['--check_format'] = {
+        type = { 'json',  'pretty' },
+        description = [[
+            Output format for the check results.
+            - 'pretty': results are displayed to stdout in a human-readable format.
+            - 'json': results are written to a file in JSON format. See --check_out_path
+        ]],
+        default = 'pretty'
+    },
+    ['--version'] = {
+        type = 'boolean',
+        description = [[
+            Get the version of the Lua language server.
+            This will print it to the command line and immediately exit.
+        ]],
+    },
+    ['--doc'] = {
+        type = 'string',
+        description = [[
+            Generate documentation from a workspace.
+            The files will be output in your log path.
+        ]],
+        example = [[--doc=C:/Users/Me/Documents/myLuaProject/]]
+    },
+    ['--doc_out_path'] = {
+        type = 'string',
+        description = [[
+            The path to output generated documentation at.
+            See --doc for more info.
+        ]],
+        example = [[--doc_out_path=C:/Users/Me/Documents/myLuaProjectDocumentation]]
+    },
+    ['--logpath'] = {
+        type = 'string',
+        description = [[
+            Where the log should be written to.
+        ]],
+        default = './log',
+        example = [[--logpath=D:/luaServer/logs]]
+    },
+    ['--loglevel'] = {
+        type = 'string',
+        description = [[
+            The minimum level of logging that should appear in the logfile.
+            Can be used to log more detailed info for debugging and error reporting.
+
+            Options:
+
+                - error
+                - warn
+                - info
+                - debug
+                - trace
+        ]],
+        example = [[--loglevel=trace]]
+    },
+    ['--metapath'] = {
+        type = 'string',
+        description = [[
+            Where the standard Lua library definition files should be generated to.
+        ]],
+        default = './meta',
+        example = [[--metapath=D:/sumnekoLua/metaDefintions]]
+    },
+    ['--locale'] = {
+        type = 'string',
+        description = [[
+            The language to use. Defaults to en-us.
+            Options can be found in locale/ .
+        ]],
+        example = [[--locale=zh-cn]]
+    },
+    ['--configpath'] = {
+        type = 'string',
+        description = [[
+            The location of the configuration file that will be loaded.
+            Can be relative to the workspace.
+            When provided, config files from elsewhere (such as from VS Code) will no longer be loaded.
+        ]],
+        example = [[--configpath=sumnekoLuaConfig.lua]]
+    },
+    ['--force-accept-workspace'] = {
+        type = 'boolean',
+        description = [[
+            Allows the use of root/home directory as the workspace.
+        ]]
+    },
+    ['--socket'] = {
+        type = 'number',
+        description = [[
+            Will communicate to a client over the specified TCP port instead of through stdio.
+        ]],
+        example = [[--socket=5050]]
+    },
+    ['--develop'] = {
+        type = 'boolean',
+        description = [[
+            Enables development mode. This allows plugins to write to the logpath.
+        ]]
+    }
+}
+
+for nm, attrs in util.sortPairs(args) do
+    if attrs.type == 'boolean' then
+        print(nm)
+    else
+        print(nm .. "=<value>")
+    end
+    if attrs.description then
+        local normalized_description = attrs.description:gsub("^%s+", ""):gsub("\n%s+", "\n"):gsub("%s+$", "")
+        print("\n    " .. normalized_description:gsub('\n', '\n    '))
+    end
+    local attr_type = attrs.type
+    if type(attr_type) == "table" then
+        print("\n    Values: " .. table.concat(attr_type, ', '))
+    end
+    if attrs.default then
+        print("\n    Default: " .. tostring(attrs.default))
+    end
+    if attrs.example then
+        print("\n    Example: " .. attrs.example)
+    end
+    print()
+end

script/cli/init.lua

@@ -1,3 +1,8 @@
+if _G['HELP'] then
+    require 'cli.help'
+    os.exit(0, true)
+end
+
 if _G['VERSION'] then
     require 'cli.version'
     os.exit(0, true)

script/global.d.lua

@@ -109,3 +109,5 @@ THREAD_ID = 1
 CHECK_WORKER = ''
 
 QUIET = false
+
+HELP = false

script/vm/compiler.lua

@@ -641,20 +641,11 @@ local function matchCall(source)
         newNode.originNode = myNode
         vm.setNode(source, newNode, true)
         if call.args then
-            -- clear existing node caches of args to allow recomputation with the type narrowed call
+            -- recompile existing node caches of args to allow recomputation with the type narrowed call
             for _, arg in ipairs(call.args) do
                 if vm.getNode(arg) then
-                    vm.setNode(arg, vm.createNode(), true)
-                end
-            end
-            for n in newNode:eachObject() do
-                if n.type == 'function'
-                or n.type == 'doc.type.function' then
-                    for i, arg in ipairs(call.args) do
-                        if vm.getNode(arg) and n.args[i] then
-                            vm.setNode(arg, vm.compileNode(n.args[i]))
-                        end
-                    end
+                    vm.removeNode(arg)
+                    vm.compileNode(arg)
                 end
             end
         end

test/type_inference/common.lua

@@ -4743,6 +4743,46 @@ local function f(v) end
 local <?r?> = f('')
 ]]
 
+TEST 'A' [[
+---@class A
+local A = {}
+
+---@generic T
+---@param self T
+---@param s string
+---@return T
+function A:f(s) end
+
+---@generic T
+---@param self T
+---@param i integer
+---@return T
+function A:f(i) end
+
+local <?r?> = A:f('')
+]]
+
+TEST 'B' [[
+---@class A
+local A = {}
+
+---@generic T
+---@param self T
+---@param s string
+---@return T
+function A:f(s) end
+
+---@generic T
+---@param self T
+---@param i integer
+---@return T
+function A:f(i) end
+
+---@class B: A
+local B = {}
+local <?r?> = B:f('')
+]]
+
 TEST 'integer' [[
 local function F(...)
     local t = {...}