Merge pull request neovim#13875 from smolck/vim_fn_error_on_api

bfredl · web-flow · commit e355cc8cc5c1 · 2021-03-09T23:12:23.000+01:00
vim.fn: throw error when trying to use API function
diff --git a/src/nvim/lua/vim.lua b/src/nvim/lua/vim.lua
@@ -263,8 +263,15 @@ end
 -- vim.fn.{func}(...)
 vim.fn = setmetatable({}, {
   __index = function(t, key)
-    local function _fn(...)
-      return vim.call(key, ...)
+    local _fn
+    if vim.api[key] ~= nil then
+      _fn = function()
+        error(string.format("Tried to call API function with vim.fn: use vim.api.%s instead", key))
+      end
+    else
+      _fn = function(...)
+        return vim.call(key, ...)
+      end
     end
     t[key] = _fn
     return _fn
diff --git a/test/functional/lua/vim_spec.lua b/test/functional/lua/vim_spec.lua
@@ -715,6 +715,11 @@ describe('lua stdlib', function()
     eq({false, 'Vim:E714: List required'}, exec_lua([[return {pcall(vim.fn.add, "aa", "bb")}]]))
   end)
 
+  it('vim.fn should error when calling API function', function()
+      eq('Error executing lua: vim.lua:0: Tried to call API function with vim.fn: use vim.api.nvim_get_current_line instead',
+          pcall_err(exec_lua, "vim.fn.nvim_get_current_line()"))
+  end)
+
   it('vim.rpcrequest and vim.rpcnotify', function()
     exec_lua([[
       chan = vim.fn.jobstart({'cat'}, {rpc=true})
