refactor: create function for deferred loading

The benefit of this is that users only pay for what they use. If e.g.
only `vim.lsp.buf_get_clients()` is called then they don't need to load
all modules under `vim.lsp` which could lead to significant startuptime
saving.

Also `vim.lsp.module` is a bit nicer to user compared to
`require("vim.lsp.module")`.

This isn't used for some nested modules such as `filetype` as it breaks
tests with error messages such as "attempt to index field 'detect'".
It's not entirely certain the reason for this, but it is likely it is
due to filetype being precompiled which would imply deferred loading
isn't needed for performance reasons.

1 files changed, 20 insertions, 0 deletions

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index e76d148b1b..fa7690e41e 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -983,4 +983,24 @@ do
   end
 end
 
+--- @private
+--- @generic T
+--- @param root string
+--- @param mod T
+--- @return T
+function vim._defer_require(root, mod)
+  return setmetatable({}, {
+    ---@param t table<string, any>
+    ---@param k string
+    __index = function(t, k)
+      if not mod[k] then
+        return
+      end
+      local name = string.format('%s.%s', root, k)
+      t[k] = require(name)
+      return t[k]
+    end,
+  })
+end
+
 return vim