neovim

commit c9c17fda80d843158d2785b047fca3a6dd78ea2f
parent 0083e03d6fa7586d0d6360b40b52b0cab0d2e7ba
Author: Justin M. Keyes <justinkz@gmail.com>
Date:   Thu, 17 Oct 2024 17:57:14 +0200

feat(deprecations): vim._defer_deprecated_module()

Diffstat:
M
runtime/lua/vim/shared.lua
 | 
26
++++++++++++++++++++++++++

1 file changed, 26 insertions(+), 0 deletions(-)
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
@@ -1164,6 +1164,32 @@ function vim._defer_require(root, mod)
   })
 end
 
+--- @private
+--- Creates a module alias/shim that lazy-loads a target module.
+---
+--- Unlike `vim.defaulttable()` this also:
+--- - implements __call
+--- - calls vim.deprecate()
+---
+--- @param old_name string Name of the deprecated module, which will be shimmed.
+--- @param new_name string Name of the new module, which will be loaded by require().
+function vim._defer_deprecated_module(old_name, new_name)
+  return setmetatable({}, {
+    ---@param _ table<string, any>
+    ---@param k string
+    __index = function(_, k)
+      vim.deprecate(old_name, new_name, '2.0.0', nil, false)
+      local target = require(new_name)
+      return target[k]
+    end,
+    __call = function(self)
+      vim.deprecate(old_name, new_name, '2.0.0', nil, false)
+      local target = require(new_name)
+      return target(self)
+    end,
+  })
+end
+
 --- @nodoc
 --- @class vim.context.mods
 --- @field bo? table<string, any>