Workspace.Library is always part of diagnosis NO MATTER what

[Kein]

I have a meta libraries/descriptors inside <project_root>/common/stubs.lua that describes some of the globals. classes, etc:

---@meta
GlobalTable = { ..props }
function DoInternalThing() end

My working sources are in `<project_root>/src/whatever.

.luarc.json

"workspace.library": [
    "common/"
]

I get the semantic hints for each object defined in stubs.lua but no matter what workspace.library diagnostic option i choose, luals still diagnoses all 773 files. All I want is hints and definition from these libraries but I dont have to see 1238 warnings and errors from these.

Is there a better solution or are we here just to suffer?

[tomlau10]

Don't know why the "diagnostics.libraryFiles": "Disable" setting seems not working 😕
Maybe there are some bugs.

I found a workaround

The current workaround that I found is to also add that folder in workspace.ignoreDir.
You may also want to set "diagnostics.ignoredFiles": "Disable"

My test setup

• lib/lib.lua

---@class lib
local lib = {}

---@return string
function lib.func() end --< this line will throw `missing-return` if diagnostics are not ignored

return lib

• main.lua

local lib = require "lib"

print(lib.func)
print(lib.func_not_exist) --< this line should throw `undefined-field`

• .luarc.jsonc

{
    "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
    "workspace.library": [
        "lib/"
    ],
    "diagnostics.libraryFiles": "Disable",  // seems not working

    // and needs to uncomment the following to work
    /*
    "workspace.ignoreDir": ["lib/"],
    "diagnostics.ignoredFiles": "Disable"
    */
}

[Kein]

If I add ignoreDir I lose semantics hints and autocompletion. Basically what people call "intellisense"

[tomlau10]

It works in my test setup above

test/
├─ lib/
│  ├─ lib.lua
├─ .luarc.jsonc
├─ main.lua

• lib/lib.lua won't be diagnosed
• only main.lua has diagnostics
• and main.lua can have hint from the lib module

---

maybe I misunderstood your situation / what you want to achieve?

[tomlau10]

I just did some debugging:

• by full searching diagnostics.libraryFiles in the code base, I found the related checking logic is here:
  

  lua-language-server/script/provider/diagnostic.lua

  Lines 252 to 253 in 606ea70

  	if files.isLibrary(uri, true) then
  	local status = config.get(uri, 'Lua.diagnostics.libraryFiles')

• the function call files.isLibrary(uri, excludeFolder: true) is returning false even for the common/ path which is set in workspace.library 😕
  I then looked into the function files.isLibrary() to see what's going on with the excludeFolder param:
  

  lua-language-server/script/files.lua

  Lines 155 to 162 in 606ea70

  	function m.isLibrary(uri, excludeFolder)
  	if excludeFolder then
  	for _, scp in ipairs(scope.folders) do
  	if scp:isChildUri(uri) then
  	return false
  	end
  	end
  	end

  • when excludeFolder = true
  • this function will return false when the library path in under the root project path (means internal library ?)
• but I have no idea why the it needs to pass excludeFolder = true inside the logic of isValid() there 😕 😕 😕
  simply changing it to:

-    if files.isLibrary(uri, true) then
+    if files.isLibrary(uri) then
         local status = config.get(uri, 'Lua.diagnostics.libraryFiles')
         ...

then now the diagnostics.libraryFiles config works as expected 👀

---

Maybe you can create a PR for it after more testing 😄