feat: read LuaLS type files for exports and library globals

[loaf-scripts]

Changes

Three commits that let the server read type files written for LuaLS from the library setting. Such a folder only contributed its classes and aliases: the types it declares for exports, the extra signatures of repeated @fields and the globals it defines were ignored.

Types declared for exports

Type files describe the exports of a resource by typing its exports entry:

---@class PhoneExports
---@field GetConfig fun(self: PhoneExports): PhoneConfig

---@type PhoneExports
exports["phone"] = {}

exports["phone"] only listed the exports the resource registers with exports('Name', fn), so the exports of a resource that is escrowed or not in the workspace had no hover, completion or type. exports["res"] and exports.res now take the members of the declared type, followed by the registered exports.

• Precedence: where both name an export, the declared type wins.
• Where: declarations are found in any indexed file, across resources, as registered exports are. The file needs no manifest and no ---@meta.
• Completion: exports[' and resource-name arguments such as GetResourceState(' also list the resources these declarations name.
• fivem/unknown-export: unchanged. It still goes by what a readable resource registers, since a declaration doesn't make an export exist at runtime.

Repeated function @fields

Type files declare a function field once per way it can be called, such as an export that takes other parameters on the server:

---@field IsInCall fun(self: PhoneExports): boolean # client-side
---@field IsInCall fun(self: PhoneExports, source: number): boolean, number? # server-side

Every lookup used the first field, so server code got the client's parameters and return values. A function field that repeats the name of an unscoped one is now an overload of it, the way LuaLS reads it, and a call picks the signature its arguments fit: exports.phone:IsInCall(source) returns boolean, number?.

• Hover: shows the descriptions of both lines.
• Sides: a repeated field marked (server) or (client) gives its signature that side. Fields that are themselves scoped to a side stay separate, as before.
• Other fields: repeated fields that aren't functions are unchanged.

Globals of definition files outside resources

A file that belongs to no resource only shared its globals with other such files. With a folder of LuaLS definitions in library, a resource didn't see the globals it declares: MySQL.update had no type, and undefined-global reported the names it defines. Such a file now declares its globals for every resource when:

• it comes from a library folder, the way LuaLS reads its library, or
• it's a workspace file with ---@meta above its first statement.

Other workspace files outside resources keep their globals to themselves. Opening a whole server folder indexes artifacts/citizen/scripting/lua/scheduler.lua, which defines CreateThread, Wait and exports without types.

• fivem/import-not-declared: still reports a library global like MySQL when the manifest lacks the import that defines it, since a type file doesn't load it at runtime.
• Library inside the workspace: a library folder that is also part of the workspace is indexed as workspace files first, so its files need ---@meta.

Checks

• cargo fmt --all -- --check and cargo clippy --workspace --all-targets --locked: clean.
• cargo test --workspace --locked: passes at the head of the branch, and each commit passes on its own.
• New LSP tests declared_types_describe_the_exports_of_a_resource and definition_files_outside_resources_declare_globals_for_every_resource, on a declared_exports fixture with a workspace and a library folder, and a parser test repeated_function_fields_become_signatures.
• Diffed the published diagnostics before and after on four server trees (QBox, QBcore, ESX and a private one, about 3,000 diagnostics): no change, also on QBox with a folder of LuaLS type files as library.
• Checked hover, completion and types for exports["lb-phone"] and exports["lb-tablet"] against their LuaLS type files, with a release build of the server over stdio.
• Not run: a manual check in VS Code.

🤖 Generated with Claude Code