mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-29 14:38:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(lua): add notify_once() (#16956)

Browse Source 
Like vim.notify(), but only displays the notification once.
This commit is contained in:
Gregory Anders
2022-01-06 11:10:56 -07:00
committed by GitHub
parent 2f779e3361
commit d78e46679d
5 changed files with 106 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
runtime/doc/lua.txt
View File

@@ -1240,19 +1240,32 @@ inspect({object}, {options}) *vim.inspect()*
https://github.com/kikito/inspect.lua https://github.com/kikito/inspect.lua
https://github.com/mpeterv/vinspect https://github.com/mpeterv/vinspect
notify({msg}, {log_level}, {opts}) *vim.notify()* notify({msg}, {level}, {opts}) *vim.notify()*
Notification provider Display a notification to the user.
Without a runtime, writes to :Messages This function can be overridden by plugins to display
notifications using a custom provider (such as the system
notification provider). By default, writes to |:messages|.
Parameters: ~ Parameters: ~
{msg} string Content of the notification to show to {msg} string Content of the notification to show to the
the user user.
{log_level} number|nil enum from vim.log.levels {level} number|nil One of the values from
{opts} table|nil additional options (timeout, etc) |vim.log.levels|.
{opts} table|nil Optional parameters. Unused by default.
See also: ~ notify_once({msg}, {level}, {opts}) *vim.notify_once()*
:help nvim_notify Display a notification only one time.
Like |vim.notify()|, but subsequent calls with the same
message will not display a notification.
Parameters: ~
{msg} string Content of the notification to show to the
user.
{level} number|nil One of the values from
|vim.log.levels|.
{opts} table|nil Optional parameters. Unused by default.
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

42
runtime/lua/vim/lsp/diagnostic.lua
View File

@@ -243,7 +243,7 @@ end
---@param client_id number ---@param client_id number
---@private ---@private
function M.save(diagnostics, bufnr, client_id) function M.save(diagnostics, bufnr, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.save is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.save is deprecated. See :h deprecated', vim.log.levels.WARN)
local namespace = M.get_namespace(client_id) local namespace = M.get_namespace(client_id)
vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)) vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id))
end end
@@ -257,7 +257,7 @@ end
--- If nil, diagnostics of all clients are included. --- If nil, diagnostics of all clients are included.
---@return table with diagnostics grouped by bufnr (bufnr: Diagnostic[]) ---@return table with diagnostics grouped by bufnr (bufnr: Diagnostic[])
function M.get_all(client_id) function M.get_all(client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_all is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_all is deprecated. See :h deprecated', vim.log.levels.WARN)
local result = {} local result = {}
local namespace local namespace
if client_id then if client_id then
@@ -279,7 +279,7 @@ end
--- Else, return just the diagnostics associated with the client_id. --- Else, return just the diagnostics associated with the client_id.
---@param predicate function|nil Optional function for filtering diagnostics ---@param predicate function|nil Optional function for filtering diagnostics
function M.get(bufnr, client_id, predicate) function M.get(bufnr, client_id, predicate)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get is deprecated. See :h deprecated', vim.log.levels.WARN)
predicate = predicate or function() return true end predicate = predicate or function() return true end
if client_id == nil then if client_id == nil then
local all_diagnostics = {} local all_diagnostics = {}
@@ -341,7 +341,7 @@ end
---@param severity DiagnosticSeverity ---@param severity DiagnosticSeverity
---@param client_id number the client id ---@param client_id number the client id
function M.get_count(bufnr, severity, client_id) function M.get_count(bufnr, severity, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_count is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_count is deprecated. See :h deprecated', vim.log.levels.WARN)
severity = severity_lsp_to_vim(severity) severity = severity_lsp_to_vim(severity)
local opts = { severity = severity } local opts = { severity = severity }
if client_id ~= nil then if client_id ~= nil then
@@ -358,7 +358,7 @@ end
---@param opts table See |vim.lsp.diagnostic.goto_next()| ---@param opts table See |vim.lsp.diagnostic.goto_next()|
---@return table Previous diagnostic ---@return table Previous diagnostic
function M.get_prev(opts) function M.get_prev(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_prev is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_prev is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -376,7 +376,7 @@ end
---@param opts table See |vim.lsp.diagnostic.goto_next()| ---@param opts table See |vim.lsp.diagnostic.goto_next()|
---@return table Previous diagnostic position ---@return table Previous diagnostic position
function M.get_prev_pos(opts) function M.get_prev_pos(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_prev_pos is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_prev_pos is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -393,7 +393,7 @@ end
--- ---
---@param opts table See |vim.lsp.diagnostic.goto_next()| ---@param opts table See |vim.lsp.diagnostic.goto_next()|
function M.goto_prev(opts) function M.goto_prev(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.goto_prev is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.goto_prev is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -411,7 +411,7 @@ end
---@param opts table See |vim.lsp.diagnostic.goto_next()| ---@param opts table See |vim.lsp.diagnostic.goto_next()|
---@return table Next diagnostic ---@return table Next diagnostic
function M.get_next(opts) function M.get_next(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_next is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_next is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -429,7 +429,7 @@ end
---@param opts table See |vim.lsp.diagnostic.goto_next()| ---@param opts table See |vim.lsp.diagnostic.goto_next()|
---@return table Next diagnostic position ---@return table Next diagnostic position
function M.get_next_pos(opts) function M.get_next_pos(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_next_pos is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_next_pos is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -444,7 +444,7 @@ end
--- ---
---@deprecated Prefer |vim.diagnostic.goto_next()| ---@deprecated Prefer |vim.diagnostic.goto_next()|
function M.goto_next(opts) function M.goto_next(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.goto_next is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.goto_next is deprecated. See :h deprecated', vim.log.levels.WARN)
if opts then if opts then
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -468,7 +468,7 @@ end
--- - severity_limit (DiagnosticSeverity): --- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid. --- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_signs(diagnostics, bufnr, client_id, _, opts) function M.set_signs(diagnostics, bufnr, client_id, _, opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.set_signs is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.set_signs is deprecated. See :h deprecated', vim.log.levels.WARN)
local namespace = M.get_namespace(client_id) local namespace = M.get_namespace(client_id)
if opts and not opts.severity and opts.severity_limit then if opts and not opts.severity and opts.severity_limit then
opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)} opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)}
@@ -489,7 +489,7 @@ end
--- - severity_limit (DiagnosticSeverity): --- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid. --- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_underline(diagnostics, bufnr, client_id, _, opts) function M.set_underline(diagnostics, bufnr, client_id, _, opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.set_underline is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.set_underline is deprecated. See :h deprecated', vim.log.levels.WARN)
local namespace = M.get_namespace(client_id) local namespace = M.get_namespace(client_id)
if opts and not opts.severity and opts.severity_limit then if opts and not opts.severity and opts.severity_limit then
opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)} opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)}
@@ -511,7 +511,7 @@ end
--- - severity_limit (DiagnosticSeverity): --- - severity_limit (DiagnosticSeverity):
--- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid. --- - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
function M.set_virtual_text(diagnostics, bufnr, client_id, _, opts) function M.set_virtual_text(diagnostics, bufnr, client_id, _, opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.set_virtual_text is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.set_virtual_text is deprecated. See :h deprecated', vim.log.levels.WARN)
local namespace = M.get_namespace(client_id) local namespace = M.get_namespace(client_id)
if opts and not opts.severity and opts.severity_limit then if opts and not opts.severity and opts.severity_limit then
opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)} opts.severity = {min=severity_lsp_to_vim(opts.severity_limit)}
@@ -530,7 +530,7 @@ end
---@return an array of [text, hl_group] arrays. This can be passed directly to ---@return an array of [text, hl_group] arrays. This can be passed directly to
--- the {virt_text} option of |nvim_buf_set_extmark()|. --- the {virt_text} option of |nvim_buf_set_extmark()|.
function M.get_virtual_text_chunks_for_line(bufnr, _, line_diags, opts) function M.get_virtual_text_chunks_for_line(bufnr, _, line_diags, opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.get_virtual_text_chunks_for_line is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.get_virtual_text_chunks_for_line is deprecated. See :h deprecated', vim.log.levels.WARN)
return vim.diagnostic._get_virt_text_chunks(diagnostic_lsp_to_vim(line_diags, bufnr), opts) return vim.diagnostic._get_virt_text_chunks(diagnostic_lsp_to_vim(line_diags, bufnr), opts)
end end
@@ -548,7 +548,7 @@ end
---@param position table|nil The (0,0)-indexed position ---@param position table|nil The (0,0)-indexed position
---@return table {popup_bufnr, win_id} ---@return table {popup_bufnr, win_id}
function M.show_position_diagnostics(opts, buf_nr, position) function M.show_position_diagnostics(opts, buf_nr, position)
vim.api.nvim_echo({{'vim.lsp.diagnostic.show_position_diagnostics is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.show_position_diagnostics is deprecated. See :h deprecated', vim.log.levels.WARN)
opts = opts or {} opts = opts or {}
opts.scope = "cursor" opts.scope = "cursor"
opts.pos = position opts.pos = position
@@ -572,7 +572,7 @@ end
---@param client_id number|nil the client id ---@param client_id number|nil the client id
---@return table {popup_bufnr, win_id} ---@return table {popup_bufnr, win_id}
function M.show_line_diagnostics(opts, buf_nr, line_nr, client_id) function M.show_line_diagnostics(opts, buf_nr, line_nr, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.show_line_diagnostics is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.show_line_diagnostics is deprecated. See :h deprecated', vim.log.levels.WARN)
opts = opts or {} opts = opts or {}
opts.scope = "line" opts.scope = "line"
opts.pos = line_nr opts.pos = line_nr
@@ -596,7 +596,7 @@ end
--- client. The default is to redraw diagnostics for all attached --- client. The default is to redraw diagnostics for all attached
--- clients. --- clients.
function M.redraw(bufnr, client_id) function M.redraw(bufnr, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.redraw is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.redraw is deprecated. See :h deprecated', vim.log.levels.WARN)
bufnr = get_bufnr(bufnr) bufnr = get_bufnr(bufnr)
if not client_id then if not client_id then
return vim.lsp.for_each_buffer_client(bufnr, function(client) return vim.lsp.for_each_buffer_client(bufnr, function(client)
@@ -624,7 +624,7 @@ end
--- - {workspace}: (boolean, default true) --- - {workspace}: (boolean, default true)
--- - Set the list with workspace diagnostics --- - Set the list with workspace diagnostics
function M.set_qflist(opts) function M.set_qflist(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.set_qflist is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.set_qflist is deprecated. See :h deprecated', vim.log.levels.WARN)
opts = opts or {} opts = opts or {}
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -656,7 +656,7 @@ end
--- - {workspace}: (boolean, default false) --- - {workspace}: (boolean, default false)
--- - Set the list with workspace diagnostics --- - Set the list with workspace diagnostics
function M.set_loclist(opts) function M.set_loclist(opts)
vim.api.nvim_echo({{'vim.lsp.diagnostic.set_loclist is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.set_loclist is deprecated. See :h deprecated', vim.log.levels.WARN)
opts = opts or {} opts = opts or {}
if opts.severity then if opts.severity then
opts.severity = severity_lsp_to_vim(opts.severity) opts.severity = severity_lsp_to_vim(opts.severity)
@@ -684,7 +684,7 @@ end
-- send diagnostic information and the client will still process it. The -- send diagnostic information and the client will still process it. The
-- diagnostics are simply not displayed to the user. -- diagnostics are simply not displayed to the user.
function M.disable(bufnr, client_id) function M.disable(bufnr, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.disable is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.disable is deprecated. See :h deprecated', vim.log.levels.WARN)
if not client_id then if not client_id then
return vim.lsp.for_each_buffer_client(bufnr, function(client) return vim.lsp.for_each_buffer_client(bufnr, function(client)
M.disable(bufnr, client.id) M.disable(bufnr, client.id)
@@ -705,7 +705,7 @@ end
--- client. The default is to enable diagnostics for all attached --- client. The default is to enable diagnostics for all attached
--- clients. --- clients.
function M.enable(bufnr, client_id) function M.enable(bufnr, client_id)
vim.api.nvim_echo({{'vim.lsp.diagnostic.enable is deprecated. See :h deprecated', 'WarningMsg'}}, true, {}) vim.notify_once('vim.lsp.diagnostic.enable is deprecated. See :h deprecated', vim.log.levels.WARN)
if not client_id then if not client_id then
return vim.lsp.for_each_buffer_client(bufnr, function(client) return vim.lsp.for_each_buffer_client(bufnr, function(client)
M.enable(bufnr, client.id) M.enable(bufnr, client.id)

9
runtime/lua/vim/lsp/util.lua
View File

@@ -10,14 +10,6 @@ local uv = vim.loop
local npcall = vim.F.npcall local npcall = vim.F.npcall
local split = vim.split local split = vim.split
local _warned = {}
local warn_once = function(message)
if not _warned[message] then
vim.api.nvim_err_writeln(message)
_warned[message] = true
end
end
local M = {} local M = {}
local default_border = { local default_border = {
@@ -1928,7 +1920,6 @@ function M.lookup_section(settings, section)
end end
M._get_line_byte_from_position = get_line_byte_from_position M._get_line_byte_from_position = get_line_byte_from_position
M._warn_once = warn_once
M.buf_versions = {} M.buf_versions = {}

38
src/nvim/lua/vim.lua
View File

@@ -425,23 +425,43 @@ function vim.defer_fn(fn, timeout)
end end
--- Notification provider --- Display a notification to the user.
--- ---
--- Without a runtime, writes to :Messages --- This function can be overridden by plugins to display notifications using a
---@see :help nvim_notify --- custom provider (such as the system notification provider). By default,
---@param msg string Content of the notification to show to the user --- writes to |:messages|.
---@param log_level number|nil enum from |vim.log.levels| ---
---@param opts table|nil additional options (timeout, etc) ---@param msg string Content of the notification to show to the user.
function vim.notify(msg, log_level, opts) -- luacheck: no unused ---@param level number|nil One of the values from |vim.log.levels|.
if log_level == vim.log.levels.ERROR then ---@param opts table|nil Optional parameters. Unused by default.
function vim.notify(msg, level, opts) -- luacheck: no unused args
if level == vim.log.levels.ERROR then
vim.api.nvim_err_writeln(msg) vim.api.nvim_err_writeln(msg)
elseif log_level == vim.log.levels.WARN then elseif level == vim.log.levels.WARN then
vim.api.nvim_echo({{msg, 'WarningMsg'}}, true, {}) vim.api.nvim_echo({{msg, 'WarningMsg'}}, true, {})
else else
vim.api.nvim_echo({{msg}}, true, {}) vim.api.nvim_echo({{msg}}, true, {})
end end
end end
do
local notified = {}
--- Display a notification only one time.
---
--- Like |vim.notify()|, but subsequent calls with the same message will not
--- display a notification.
---
---@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 opts table|nil Optional parameters. Unused by default.
function vim.notify_once(msg, level, opts) -- luacheck: no unused args
if not notified[msg] then
vim.notify(msg, level, opts)
notified[msg] = true
end
end
end
---@private ---@private
function vim.register_keystroke_callback() function vim.register_keystroke_callback()

34
test/functional/lua/vim_spec.lua
View File

@@ -2203,6 +2203,40 @@ describe('lua stdlib', function()
end) end)
end) end)
it('vim.notify_once', function()
local screen = Screen.new(60,5)
screen:set_default_attr_ids({
[0] = {bold=true, foreground=Screen.colors.Blue},
[1] = {foreground=Screen.colors.Red},
})
screen:attach()
screen:expect{grid=[[
^ |
{0:~ }|
{0:~ }|
{0:~ }|
|
]]}
exec_lua [[vim.notify_once("I'll only tell you this once...", vim.log.levels.WARN)]]
screen:expect{grid=[[
^ |
{0:~ }|
{0:~ }|
{0:~ }|
{1:I'll only tell you this once...} |
]]}
feed('<C-l>')
screen:expect{grid=[[
^ |
{0:~ }|
{0:~ }|
{0:~ }|
|
]]}
exec_lua [[vim.notify_once("I'll only tell you this once...")]]
screen:expect_unchanged()
end)
describe('vim.schedule_wrap', function() describe('vim.schedule_wrap', function()
it('preserves argument lists', function() it('preserves argument lists', function()
exec_lua [[ exec_lua [[