emmylua-ls thinks a required module could be the current file, generating false positive type-mismatch warnings

[haoming-li-ling]

Wezterm's config file could be just name wezterm.lua. In that file, you are supposed to require("wezterm"), which is provided by Wezterm's lua runtime, and it is not referring to the current file. But then emmylua-ls thinks that the type of require("wezterm") is the return type of the current file, likely equating the wezterm module with the current file.

-- file name is `wezterm.lua`
local wezterm = require("wezterm")  ---@type Wezterm
local config = wezterm.config_builder() ---@type Config

return config

emmylua-ls complains that W Cannot assign Config to Wezterm.

[CppCXY]

Related issue: DrKJeff16/wezterm-types#113

[CppCXY]

I suggest add wezterm to ---@meta like:

then we can get correct annotation and hint:

[haoming-li-ling]

Which file is it that you are adding ---@meta to? And could you explain why it works (it does work, thanks)? Also, something to consider is that LuaLS does not produce the type-mismatch warning out of the box.

[CppCXY]

Because the project contains module files with duplicate names and we perform type checking on ---@type, Lua itself doesn't provide a reliable mechanism to prevent loading a same-named module, so we must replicate that behavior ourselves.

[haoming-li-ling]

But can a file require itself as a module in Lua? I guess if there are multiple modules with the same name that are not itself, then what you say is certainly true.