Merge branch 'master' into max-fields-count

Author: sumneko

changelog.md

@@ -3,6 +3,9 @@
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
 * `NEW` Added `completion.maxFieldCount` which lets you increase the amount of fields to analyze before requiring more specific input
+* `New` Omit parameter hints when the argument name matches
+* `FIX` Fix a typo in `no-unknown` diagnostic message
+* `FIX` Autodoc generation so it does not include documentation for builtin Lua language features
 
 ## 3.16.1
 `2025-12-8`

locale/en-us/script.lua

@@ -89,7 +89,7 @@ DIAG_COSE_NON_OBJECT    =
 DIAG_COUNT_DOWN_LOOP    =
 'Do you mean `{}` ?'
 DIAG_UNKNOWN            =
-'Can not infer type.'
+'Cannot infer type.'
 DIAG_DEPRECATED         =
 'Deprecated.'
 DIAG_DIFFERENT_REQUIRES =

script/cli/doc/export.lua

@@ -274,12 +274,7 @@ end
 ---@async
 ---@return table globals
 function export.gatherGlobals()
-    local all_globals = vm.getAllGlobals()
-    local globals = {}
-    for _, g in pairs(all_globals) do
-        table.insert(globals, g)
-    end
-    return globals
+    return util.valuesOf(vm.getExportableGlobals())
 end
 
 ---builds a lua table of based on `globals` and their elements

script/core/hint.lua

@@ -145,7 +145,7 @@ local function paramName(uri, results, start, finish)
             and (paramConfig ~= 'Literal' or guide.isLiteral(arg)) then
                 mark[arg] = true
                 local param = params[i]
-                if param and param[1] then
+                if param and param[1] and param[1] ~= arg[1] then
                     results[#results+1] = {
                         text    = param[1] .. ':',
                         offset  = arg.start,

script/vm/global.lua

@@ -23,6 +23,7 @@ local globalSubs = util.multiTable(2)
 ---@field links table<uri, vm.global.link>
 ---@field setsCache? table<uri, parser.object[]>
 ---@field cate vm.global.cate
+---@field uri string
 local mt = {}
 mt.__index = mt
 mt.type = 'global'
@@ -155,10 +156,11 @@ end
 
 ---@param cate vm.global.cate
 ---@return vm.global
-local function createGlobal(name, cate)
+local function createGlobal(name, cate, uri)
     return setmetatable({
         name  = name,
         cate  = cate,
+        uri   = uri,
         links = util.multiTable(2, function ()
             return {
                 sets = {},
@@ -444,7 +446,7 @@ function vm.declareGlobal(cate, name, uri)
         globalSubs[uri][key] = true
     end
     if not allGlobals[key] then
-        allGlobals[key] = createGlobal(name, cate)
+        allGlobals[key] = createGlobal(name, cate, uri)
     end
     return allGlobals[key]
 end
@@ -510,6 +512,19 @@ function vm.getAllGlobals()
     return allGlobals
 end
 
+---@return table<string, vm.global>
+function vm.getExportableGlobals()
+    local exportableGlobals = {}
+    for key, global in pairs(allGlobals) do
+        --If the source uri for the global matches the global variable METAPATH
+        --then the global is a builtin Lua language feature and should not be exported
+        if global.uri and not string.find(global.uri, METAPATH, 1, true) then
+            exportableGlobals[key] = global
+        end
+    end
+    return exportableGlobals
+end
+
 ---@param suri uri
 ---@param cate   vm.global.cate
 ---@return parser.object[]

test.lua

@@ -76,6 +76,7 @@ local function testAll()
     test 'diagnostics'
     test 'crossfile'
     test 'highlight'
+    test 'inlay_hint'
     test 'rename'
     test 'signature'
     test 'command'

test/inlay_hint/init.lua

@@ -0,0 +1,150 @@
+local core   = require 'core.hint'
+local files  = require 'files'
+local catch  = require 'catch'
+local config = require 'config'
+local define = require 'proto.define'
+
+rawset(_G, 'TEST', true)
+
+---@diagnostic disable: await-in-sync
+local function TEST(script, expect, opts)
+    opts = opts or {}
+    local newScript, catched = catch(script, '!')
+
+    files.setText(TESTURI, newScript)
+    files.compileState(TESTURI)
+
+    local results = core(TESTURI, 0, math.huge)
+    table.sort(results, function (a, b)
+        if a.offset ~= b.offset then
+            return a.offset < b.offset
+        end
+        return a.text < b.text
+    end)
+
+    if #expect ~= #results then
+        print('Expect count:', #expect, 'Result count:', #results)
+        for i, res in ipairs(results) do
+            print(('  %d: text=%s kind=%s where=%s offset=%s'):format(
+                i,
+                tostring(res.text),
+                tostring(res.kind),
+                tostring(res.where),
+                tostring(res.offset)
+            ))
+        end
+    end
+
+    assert(#expect == #results)
+    for i, res in ipairs(results) do
+        local info = expect[i]
+        local pos = catched['!'][info.pos]
+        assert(pos)
+        local offset = info.useFinish and pos[2] or pos[1]
+        assert(res.text == info.text)
+        assert(res.kind == info.kind)
+        assert(res.where == info.where)
+        assert(res.offset == offset)
+    end
+
+    files.remove(TESTURI)
+end
+
+config.set(nil, 'Lua.hint.enable', true)
+
+config.set(nil, 'Lua.hint.setType', true)
+
+TEST([[
+---@return integer
+local function returnsInt()
+    return 1
+end
+
+local <!val!> = returnsInt()
+]], {
+    {
+        pos   = 1,
+        text  = ': integer',
+        kind  = define.InlayHintKind.Type,
+        where = 'right',
+        useFinish = true,
+    },
+})
+
+config.set(nil, 'Lua.hint.paramName', 'Literal')
+
+TEST([[
+local function foo(first, second)
+end
+
+foo(<!1!>, x)
+foo(<!1!>, <!2!>)
+]], {
+    {
+        pos   = 1,
+        text  = 'first:',
+        kind  = define.InlayHintKind.Parameter,
+        where = 'left',
+    },
+    {
+        pos   = 2,
+        text  = 'first:',
+        kind  = define.InlayHintKind.Parameter,
+        where = 'left',
+    },
+    {
+        pos   = 3,
+        text  = 'second:',
+        kind  = define.InlayHintKind.Parameter,
+        where = 'left',
+    },
+})
+
+config.set(nil, 'Lua.hint.paramName', 'All')
+
+TEST([[
+local function foo(first, second)
+end
+
+local first, second
+foo(<!first!>, <!second!>)
+]], {})
+
+
+config.set(nil, 'Lua.hint.arrayIndex', 'Enable')
+
+TEST([[
+local t = {
+    <!'first'!>,
+    <!'second'!>,
+    <!'third'!>,
+    <!'fourth'!>,
+}
+]], {
+    {
+        pos   = 1,
+        text  = '[1]',
+        kind  = define.InlayHintKind.Other,
+        where = 'left',
+    },
+    {
+        pos   = 2,
+        text  = '[2]',
+        kind  = define.InlayHintKind.Other,
+        where = 'left',
+    },
+    {
+        pos   = 3,
+        text  = '[3]',
+        kind  = define.InlayHintKind.Other,
+        where = 'left',
+    },
+    {
+        pos   = 4,
+        text  = '[4]',
+        kind  = define.InlayHintKind.Other,
+        where = 'left',
+    },
+})
+
+config.set(nil, 'Lua.hint.enable', false)