Merge pull request #3293 from codrod/bug/2977-lua-autodoc-includes-global-table

Issue 2977: LuaLS autodoc is including global table in output md/json files

Author: sumneko

changelog.md

@@ -4,6 +4,7 @@
 <!-- Add all new changes here. They will be moved under a version at release -->
 * `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`

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/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[]