Class not recognized when not opening

[DragoonKiller]

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Type Checking

Expected Behaviour

AttachNode is recognized as global and class.

Actual Behaviour

20250424_011715.mp4

Reproduction steps

I've no idea, maybe this is relative to my project.

Additional Notes

vscode settings are set to

    "Lua.workspace.maxPreload": 500000,
    "Lua.workspace.preloadFileSize": 500000,

Log File

file_s%3A_Work_Projects_Project-H.log

[tomlau10]

From my own experience, this is usually due to the files being ignored😕
=> the classes defined within that file will only be processed when it is opened, and will disappear after closing that file

---

• The files in question are under the path Assets/Res/ship/build/*
• Judging from the log file, I found that you have add ["build/"] = true, in your files.exclude vscode settings
• By full searching LuaLS's code base, seems the server will utilize this settings to ignore those paths as well:
  

  lua-language-server/script/workspace/workspace.lua

  Lines 134 to 146 in 606ea70

  	--- 创建排除文件匹配器
  	---@param scp scope
  	function m.getNativeMatcher(scp)
  	if scp:get 'nativeMatcher' then
  	return scp:get 'nativeMatcher'
  	end
  	local pattern = {}
  	for path, ignore in pairs(config.get(scp.uri, 'files.exclude')) do
  	if ignore then
  	log.debug('Ignore by exclude:', path)
  	pattern[#pattern+1] = path
  	end

• I know that a build/ pattern should not match Assets/Res/ship/build/*, because the pattern isn't prefixed with a **/.
  But maybe the pattern matcher of LuaLS doesn't work this way, and it considers that a build/ will match Assets/Res/ship/build/* 🤦‍♂ 🐛

minimal reproduction env

• create the following file structure

test/
├─ lib/
│  ├─ build/
│  │  ├─ mylib.lua
├─ .vscode/
│  ├─ settings.json
main.lua

• .vscode/settings.json

{
    "files.exclude": {
        "build/": true
    }
}

• lib/build/mylib.lua

---@class mylib

• main.lua

---@type mylib # --> Undefined type or alias `mylib`.

• only if I open lib/build/mylib.lua or remove the files.exclude settings, the mylib class type will be defined

[tomlau10]

I have no idea how this can be fixed ...

• files.exclude uses glob pattern
• while .gitignore uses gitignore pattern
• one of the main differences is that a single build/ matches any folder prefix in gitignore style,
  while it only matches build/ under project root in glob style

---

Although LuaLS's glob library has both matcheres:

lua-language-server/script/glob/init.lua

Lines 1 to 4 in 606ea70

	return {
	glob = require 'glob.glob',
	gitignore = require 'glob.gitignore',
	}

It only uses 1 of the matcher types to process both files.excludes and .gitignore ...

lua-language-server/script/workspace/workspace.lua

Lines 189 to 196 in 606ea70

	local matcher = glob.gitignore(pattern, {
	root = scp.uri and furi.decode(scp.uri),
	ignoreCase = platform.os == 'windows',
	}, globInteferFace)
	scp:set('nativeMatcher', matcher)
	return matcher
	end

☹ ☹ ☹

[DragoonKiller]

@tomlau10 then it is a design mistake... The correct design could be:

• There's only one global matcher.
• The global matcher contains two sub-matcher: the gitignore matcher, and vscode config matcher. Sub-matchers are created from its own pattern. (so build/ won't be in gitignore matcher)
• for each input, test if it is excluded/included by the two sub-matcher.
• compose the result and return. (rule can be: exclude when any exclude, include when any include, and default to include)
  So typically we need to wrap it into a higher level matcher.

[tomlau10]

then it is a design mistake

You're right.

I am not maintainer of this project, just a contributor, and I am not very familiar with this part of the code base.
Hopefully they can be aware of this issue, and have a better implementation in v4.0 🙂
(they are doing a big refactor currently)

[DragoonKiller]

@tomlau10 wow they are doing refactor? Then I should wait and hear though.

[tomlau10]

yeah~ it's been a long time though 😂
related announcement: #2366

and there is a 4.0.0 branch under construction 👀
https://github.com/LuaLS/lua-language-server/tree/4.0.0