Support for custom module resolution

[rhys-vdw]

We have a custom module loader that uses full file paths to resolve files.

local units = VFS.Include("luaui/configs/unit_buildmenu_config.lua")

To get proper type inference we need to add @module to every call.

---@module "unit_buildmenu_config"
local units = VFS.Include("luaui/configs/unit_buildmenu_config.lua")

It's possible to alias VFS.Include to act like require:

  "runtime.special": {
    "VFS.include": "require"
  },

But this won't work because VFS.Include accepts a path, and require accepts a module name. Is there any way to write a custom module resolver so that we can support VFS.Include project-wide?

[tomlau10]

It is possible to change completion.requireSeparator to use / as separator, and then add ? to runtime.path
=> to make LuaLS's require to accept full path name

{
    "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
    "completion.requireSeparator": "/",
    "runtime.path": [
        "?",
        "?.lua"
    ],
    "runtime.special": {
        "VFS.include": "require"
    }
}

Here is a similar question before (but in chinese): #2900 (comment)

---

However this affects standard require (or other specials that are of require type) as well 🤔
So with the above setting, you can't use . as separator in standard require:

require "lib.A" --> this equals to requiring a file named "lib.A" or "lib.A.lua", instead of "lib/A.lua"
require "lib/A" --> you have to use `/` if you want to require "lib/A"

[rhys-vdw]

Thanks you @tomlau10! That appears to be working. 🙏