IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat(lua): add traceback to vim.deprecate #18575

Browse Source
This commit is contained in:
ii14 2022-05-16 03:07:36 +02:00 committed by GitHub
parent b2799518c7
commit e501e4ed4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/doc/lua.txt
View File

@ -1331,7 +1331,8 @@ defer_fn({fn}, {timeout}) *vim.defer_fn()*
Return: ~ Return: ~
timer luv timer object timer luv timer object
deprecate({name}, {alternative}, {version}, {plugin}) *vim.deprecate()* *vim.deprecate()*
deprecate({name}, {alternative}, {version}, {plugin}, {backtrace})
Display a deprecation notification to the user. Display a deprecation notification to the user.
Parameters: ~ Parameters: ~
@ -1342,6 +1343,8 @@ deprecate({name}, {alternative}, {version}, {plugin}) *vim.deprecate()*
function will be removed. function will be removed.
{plugin} string|nil Plugin name that the function {plugin} string|nil Plugin name that the function
will be removed from. Defaults to "Nvim". will be removed from. Defaults to "Nvim".
{backtrace} boolean|nil Prints backtrace. Defaults to
true.
inspect({object}, {options}) *vim.inspect()* inspect({object}, {options}) *vim.inspect()*
Return a human-readable representation of the given object. Return a human-readable representation of the given object.
@ -1379,6 +1382,9 @@ notify_once({msg}, {level}, {opts}) *vim.notify_once()*
{opts} (table|nil) Optional parameters. Unused by {opts} (table|nil) Optional parameters. Unused by
default. default.
Return: ~
(boolean) true if message was displayed, else false
on_key({fn}, {ns_id}) *vim.on_key()* on_key({fn}, {ns_id}) *vim.on_key()*
Adds Lua function {fn} with namespace id {ns_id} as a listener Adds Lua function {fn} with namespace id {ns_id} as a listener
to every, yes every, input key. to every, yes every, input key.

12
runtime/lua/vim/_editor.lua
View File

@ -446,11 +446,14 @@ do
---@param msg string Content of the notification to show to the user. ---@param msg string Content of the notification to show to the user.
---@param level number|nil One of the values from |vim.log.levels|. ---@param level number|nil One of the values from |vim.log.levels|.
---@param opts table|nil Optional parameters. Unused by default. ---@param opts table|nil Optional parameters. Unused by default.
function vim.notify_once(msg, level, opts) -- luacheck: no unused args ---@return boolean true if message was displayed, else false
function vim.notify_once(msg, level, opts)
if not notified[msg] then if not notified[msg] then
vim.notify(msg, level, opts) vim.notify(msg, level, opts)
notified[msg] = true notified[msg] = true
return true
end end
return false
end end
end end
@ -784,12 +787,15 @@ end
--- be removed. --- be removed.
---@param plugin string|nil Plugin name that the function will be removed ---@param plugin string|nil Plugin name that the function will be removed
--- from. Defaults to "Nvim". --- from. Defaults to "Nvim".
function vim.deprecate(name, alternative, version, plugin) ---@param backtrace boolean|nil Prints backtrace. Defaults to true.
function vim.deprecate(name, alternative, version, plugin, backtrace)
local message = name .. ' is deprecated' local message = name .. ' is deprecated'
plugin = plugin or 'Nvim' plugin = plugin or 'Nvim'
message = alternative and (message .. ', use ' .. alternative .. ' instead.') or message message = alternative and (message .. ', use ' .. alternative .. ' instead.') or message
message = message .. ' See :h deprecated\nThis function will be removed in ' .. plugin .. ' version ' .. version message = message .. ' See :h deprecated\nThis function will be removed in ' .. plugin .. ' version ' .. version
vim.notify_once(message, vim.log.levels.WARN) if vim.notify_once(message, vim.log.levels.WARN) and backtrace ~= false then
vim.notify(debug.traceback('', 2):sub(2), vim.log.levels.WARN)
end
end end
require('vim._meta') require('vim._meta')