Something went wrong. Try again.
Library of 45+ independent Lua modules improving Neovim experience with minimal effort nvim-mini.org/mini.nvim
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220local helpers = dofile('tests/helpers.lua')
local child = helpers.new_child_neovim()local expect, eq = helpers.expect, helpers.expect.equalitylocal new_set = MiniTest.new_set
-- Helpers with child processes--stylua: ignore startlocal load_module = function(config) child.mini_load('notify', config) endlocal unload_module = function() child.mini_unload('notify') endlocal sleep = function(ms) helpers.sleep(ms, child) end--stylua: ignore end
-- Common test helperslocal get_notif_win_id = function(tabpage_id) tabpage_id = tabpage_id or child.api.nvim_get_current_tabpage() local all_wins = child.api.nvim_tabpage_list_wins(tabpage_id) for _, win_id in ipairs(all_wins) do local win_buf = child.api.nvim_win_get_buf(win_id) local shows_notifications = child.api.nvim_buf_get_option(win_buf, 'filetype') == 'mininotify' if shows_notifications then return win_id end endend
local is_notif_window_shown = function(tabpage_id) return get_notif_win_id(tabpage_id) ~= nil end
-- Common test wrapperslocal forward_lua = function(fun_str) local lua_cmd = fun_str .. '(...)' return function(...) return child.lua_get(lua_cmd, { ... }) endend
local get = forward_lua('MiniNotify.get')local get_all = forward_lua('MiniNotify.get_all')
-- Common mockslocal ref_seconds, ref_microseconds = 1703680496, 0.123456local mock_gettimeofday = function() -- Ensure reproducibility of `vim.fn.strftime` child.loop.os_setenv('TZ', 'Etc/UTC') child.loop.os_setenv('_TZ', 'Etc/UTC') child.cmd('language time en_US.UTF-8')
local lua_cmd = string.format( [[local start, n = %d, -1 vim.loop.gettimeofday = function() n = n + 1 return start + n, %d end]], ref_seconds, 1000000 * ref_microseconds ) child.lua(lua_cmd)end
-- Time constantslocal default_duration_last = 1000local small_time = helpers.get_time_const(10)
-- Output test set ============================================================local T = new_set({ hooks = { pre_case = function() child.setup()
-- Load module load_module()
-- Make more comfortable screenshots child.set_size(7, 45) child.o.laststatus = 0 end, post_once = child.stop, }, n_retry = helpers.get_n_retry(2),})
-- Unit tests =================================================================T['setup()'] = new_set()
T['setup()']['creates side effects'] = function() -- Global variable eq(child.lua_get('type(_G.MiniNotify)'), 'table')
-- Autocommand group eq(child.fn.exists('#MiniNotify'), 1)
-- Highlight groups child.cmd('hi clear') load_module() local has_highlight = function(group, value) expect.match(child.cmd_capture('hi ' .. group), value) end
has_highlight('MiniNotifyBorder', 'links to FloatBorder') has_highlight('MiniNotifyLspProgress', 'links to MiniNotifyNormal') has_highlight('MiniNotifyNormal', 'links to NormalFloat') has_highlight('MiniNotifyTitle', 'links to FloatTitle')
-- `vim.notify` implementation child.lua('vim.notify("Hello", vim.log.levels.WARN)') eq(child.lua_get('#MiniNotify.get_all()'), 1)end
T['setup()']['creates `config` field'] = function() eq(child.lua_get('type(_G.MiniNotify.config)'), 'table')
-- Check default values local expect_config = function(field, value) eq(child.lua_get('MiniNotify.config.' .. field), value) end
expect_config('content.format', vim.NIL) expect_config('content.sort', vim.NIL)
expect_config('lsp_progress.enable', true) expect_config('lsp_progress.duration_last', 1000)
expect_config('window.config', {}) expect_config('window.max_width_share', 0.382) expect_config('window.winblend', 25)end
T['setup()']['respects `config` argument'] = function() unload_module() load_module({ window = { winblend = 0 } }) eq(child.lua_get('MiniNotify.config.window.winblend'), 0)end
T['setup()']['validates `config` argument'] = function() unload_module()
local expect_config_error = function(config, name, target_type) expect.error(function() load_module(config) end, vim.pesc(name) .. '.*' .. vim.pesc(target_type)) end
expect_config_error('a', 'config', 'table') expect_config_error({ content = 'a' }, 'content', 'table') expect_config_error({ content = { format = 'a' } }, 'content.format', 'function') expect_config_error({ content = { sort = 'a' } }, 'content.sort', 'function')
expect_config_error({ lsp_progress = 'a' }, 'lsp_progress', 'table') expect_config_error({ lsp_progress = { enable = 'a' } }, 'lsp_progress.enable', 'boolean') expect_config_error({ lsp_progress = { duration_last = 'a' } }, 'lsp_progress.duration_last', 'number')
expect_config_error({ window = 'a' }, 'window', 'table') expect_config_error({ window = { config = 'a' } }, 'window.config', 'table or callable') expect_config_error({ window = { max_width_share = 'a' } }, 'window.max_width_share', 'number') expect_config_error({ window = { winblend = 'a' } }, 'window.winblend', 'number')end
T['setup()']['ensures colors'] = function() child.cmd('colorscheme default') expect.match(child.cmd_capture('hi MiniNotifyBorder'), 'links to FloatBorder')end
T['setup()']['clears the history'] = function() child.lua([[ local id_1 = MiniNotify.add("Hello") local id_2 = MiniNotify.add("Hello") MiniNotify.remove(id_1) ]]) eq(#child.lua_get('MiniNotify.get_all()'), 2) eq(is_notif_window_shown(), true)
child.lua('MiniNotify.setup(MiniNotify.config)') -- Should also remove possibly visible notification window eq(#child.lua_get('MiniNotify.get_all()'), 0) eq(is_notif_window_shown(), false)end
T['make_notify()'] = new_set()
local notify = forward_lua('vim.notify')
T['make_notify()']['works'] = function() child.set_size(10, 45) mock_gettimeofday()
local test_duration = 5 * small_time child.lua('_G.dur = ' .. test_duration) child.lua([[ local level_opts = { ERROR = { duration = 6 * _G.dur }, WARN = { duration = 5 * _G.dur }, INFO = { duration = 4 * _G.dur }, DEBUG = { duration = 3 * _G.dur }, TRACE = { duration = 2 * _G.dur }, OFF = { duration = 1 * _G.dur }, } vim.notify = MiniNotify.make_notify(level_opts) ]])
local validate_active = function(ref) local active = vim.tbl_filter(function(notif) return notif.ts_remove == nil end, get_all()) eq(vim.tbl_map(function(notif) return notif.msg end, active), ref) end
local levels = child.lua_get('vim.log.levels')
notify('error', levels.ERROR) notify('warn', levels.WARN) notify('info', levels.INFO) notify('debug', levels.DEBUG) notify('trace', levels.TRACE) notify('off', levels.OFF)
child.expect_screenshot()
-- Should add all notifications to history with proper `level` and `hl_group` local history = vim.tbl_map( function(notif) return { msg = notif.msg, level = notif.level, hl_group = notif.hl_group, data = notif.data } end, get_all() ) --stylua: ignore eq(history, { { msg = 'error', level = 'ERROR', hl_group = 'DiagnosticError', data = { source = 'vim.notify' } }, { msg = 'warn', level = 'WARN', hl_group = 'DiagnosticWarn', data = { source = 'vim.notify' } }, { msg = 'info', level = 'INFO', hl_group = 'DiagnosticInfo', data = { source = 'vim.notify' } }, { msg = 'debug', level = 'DEBUG', hl_group = 'DiagnosticHint', data = { source = 'vim.notify' } }, { msg = 'trace', level = 'TRACE', hl_group = 'DiagnosticOk', data = { source = 'vim.notify' } }, { msg = 'off', level = 'OFF', hl_group = 'MiniNotifyNormal', data = { source = 'vim.notify' } }, })
-- Should make notifications disappear after configured duration validate_active({ 'error', 'warn', 'info', 'debug', 'trace', 'off' }) sleep(test_duration + small_time) validate_active({ 'error', 'warn', 'info', 'debug', 'trace' }) sleep(test_duration) validate_active({ 'error', 'warn', 'info', 'debug' }) sleep(test_duration) validate_active({ 'error', 'warn', 'info' }) sleep(test_duration) validate_active({ 'error', 'warn' }) sleep(test_duration) validate_active({ 'error' }) sleep(test_duration) validate_active({})end
T['make_notify()']['uses INFO level by default'] = function() child.lua([[vim.notify = MiniNotify.make_notify()]]) notify('Hello') local notif = get_all()[1] eq(notif.level, 'INFO') eq(notif.hl_group, 'DiagnosticInfo')end
T['make_notify()']['does not show some levels by default'] = function() child.lua('vim.notify = MiniNotify.make_notify()') notify('debug', child.lua_get('vim.log.levels.DEBUG')) notify('trace', child.lua_get('vim.log.levels.TRACE')) notify('off', child.lua_get('vim.log.levels.OFF')) eq(get_all(), {})end
T['make_notify()']['respects `opts.hl_group`'] = function() child.lua([[vim.notify = MiniNotify.make_notify({ ERROR = { hl_group = 'Comment' } })]]) notify('Hello', child.lua_get('vim.log.levels.ERROR')) eq(get_all()[1].hl_group, 'Comment')end
T['make_notify()']['validates arguments'] = function() local validate = function(opts, err_pattern) expect.error(function() child.lua('MiniNotify.make_notify(...)', { opts }) end, err_pattern) end
local validate_level = function(level) validate({ [level] = 1 }, 'Level data.*table') validate({ [level] = { duration = 'a' } }, '`duration`.*number') validate({ [level] = { hl_group = 1 } }, '`hl_group`.*string') end
validate({ error = {} }, 'Keys.*log level names')
validate_level('ERROR') validate_level('WARN') validate_level('INFO') validate_level('DEBUG') validate_level('TRACE') validate_level('OFF')end
T['make_notify()']['has output working in fast event'] = function() child.lua('_G.dur = ' .. small_time) child.lua([[ vim.notify = MiniNotify.make_notify() local timer = vim.loop.new_timer() timer:start(_G.dur, 0, function() vim.notify('Hello', vim.log.levels.INFO) end) ]]) sleep(small_time + small_time) eq(child.cmd_capture('messages'), '') eq(get_all()[1].msg, 'Hello')end
T['make_notify()']['has output working when completion is active'] = function() child.lua([[ vim.notify = MiniNotify.make_notify() _G.completefunc_notify = function() vim.notify("Hello", vim.log.levels.INFO) end ]]) child.o.completefunc = 'v:lua.completefunc_notify' child.type_keys('i', '<C-x><C-u>') sleep(small_time + small_time) eq(child.cmd_capture('messages'), '') eq(get_all()[1].msg, 'Hello')end
T['make_notify()']['has output validating arguments'] = function() child.lua('vim.notify = MiniNotify.make_notify()') child.lua([[vim.notify('Hello', 'ERROR')]]) sleep(small_time) expect.match(child.cmd_capture('messages'), 'valid values.*vim%.log%.levels')end
T['make_notify()']['allows non-positive `duration`'] = function() -- Should not show notification at all child.lua([[vim.notify = MiniNotify.make_notify({ ERROR = { duration = -100 }, WARN = { duration = 0 } })]]) notify('error', child.lua_get('vim.log.levels.ERROR')) notify('warn', child.lua_get('vim.log.levels.WARN')) eq(get_all(), {})end
T['add()'] = new_set()
local add = forward_lua('MiniNotify.add')
T['add()']['works'] = function() mock_gettimeofday()
local id = add('Hello')
-- Should return notification identifier number eq(type(id), 'number')
-- Should show notification in a floating window child.expect_screenshot()
-- Should add proper notification object to history local notif = get(id) local notif_fields = vim.tbl_keys(notif) table.sort(notif_fields) eq(notif_fields, { 'data', 'hl_group', 'level', 'msg', 'ts_add', 'ts_update' })
eq(notif.msg, 'Hello')
-- Non-message arguments should have defaults eq(notif.level, 'INFO') eq(notif.hl_group, 'MiniNotifyNormal') eq(notif.data, {})
-- Timestamp fields should use `vim.loop.gettimeofday()` eq(notif.ts_add, ref_seconds + ref_microseconds) eq(notif.ts_update, notif.ts_add)end
T['add()']['allows empty string message'] = function() mock_gettimeofday()
add('') child.expect_screenshot()end
T['add()']['respects arguments'] = function() local validate = function(level) local id = add('Hello', level, 'Comment', { a = 1, b = { bb = 2 } }) eq(get(id).level, level) eq(get(id).hl_group, 'Comment') eq(get(id).data, { a = 1, b = { bb = 2 } }) end
validate('ERROR') validate('WARN') validate('INFO') validate('DEBUG') validate('TRACE') validate('OFF')end
T['add()']['validates arguments'] = function() expect.error(function() add(1, 'ERROR', 'Comment') end, '`msg`.*string') expect.error(function() add('Hello', 1, 'Comment') end, '`level`.*key of `vim%.log%.levels`') expect.error(function() add('Hello', 'Error', 'Comment') end, '`level`.*key of `vim%.log%.levels`') expect.error(function() add('Hello', 'ERROR', 1) end, '`hl_group`.*string')end
T['update()'] = new_set()
local update = forward_lua('MiniNotify.update')
T['update()']['works'] = function() mock_gettimeofday() child.lua([[ MiniNotify.config.content.format = function(notif) return (notif.data.a > 10 and 'NEW' or 'OLD') .. ' ' .. notif.msg end ]])
local id = add('Hello', 'ERROR', 'Comment', { a = 1, b = true, c = 'c' }) child.expect_screenshot() local init_notif = get(id)
update(id, { msg = 'World', level = 'WARN', hl_group = 'String', data = { a = 11 } })
-- Should show updated notification in a floating window child.expect_screenshot()
-- Should properly update notification object in history local notif = get(id)
eq(notif.msg, 'World') eq(notif.level, 'WARN') eq(notif.hl_group, 'String')
-- Should assign non-nil `data` as is, without `vim.tbl_deep_extend` eq(notif.data, { a = 11 })
-- Add time should be untouched eq(notif.ts_add, init_notif.ts_add)
-- Update time should be increased eq(init_notif.ts_update < notif.ts_update, true)end
T['update()']['allows partial new content'] = function() local id = add('Hello', 'ERROR', 'Comment', { a = 1, b = true }) update(id, { msg = 'World', data = { b = false } }) local notif = get(id) eq(notif.msg, 'World') eq(notif.level, 'ERROR') eq(notif.hl_group, 'Comment') eq(notif.data, { b = false })
-- Empty table update(id, {}) eq(notif.msg, 'World') eq(notif.level, 'ERROR') eq(notif.hl_group, 'Comment') eq(notif.data, { b = false })end
T['update()']['can update only active notification'] = function() local id = child.lua([[ local id = MiniNotify.add('Hello') MiniNotify.remove(id) return id ]]) expect.error(function() update(id, { msg = 'World' }) end, '`id`.*not.*active')end
T['update()']['validates arguments'] = function() local id = add('Hello') expect.error(function() update('a', { msg = 'World' }) end, '`id`.*identifier') expect.error(function() update(id, 1) end, '`new`.*table') expect.error(function() update(id, { msg = 1 }) end, '`msg`.*string') expect.error(function() update(id, { level = 1 }) end, '`level`.*key of `vim%.log%.levels`') expect.error(function() update(id, { level = 'Error' }) end, '`level`.*key of `vim%.log%.levels`') expect.error(function() update(id, { hl_group = 1 }) end, '`hl_group`.*string') expect.error(function() update(id, { data = 1 }) end, '`data`.*table')end
T['remove()'] = new_set()
local remove = forward_lua('MiniNotify.remove')
T['remove()']['works'] = function() mock_gettimeofday()
local id = add('Hello', 'ERROR', 'Comment') child.expect_screenshot() local init_notif = get(id) eq(init_notif.ts_remove, nil)
remove(id)
-- Should update notification window (and remove it completely in this case) child.expect_screenshot()
-- Should only update `ts_remove` field local notif = get(id)
eq(notif.ts_remove, ref_seconds + 1 + ref_microseconds)
init_notif.ts_remove, notif.ts_remove = nil, nil eq(init_notif, notif)end
T['remove()']['works with several active notifications'] = function() mock_gettimeofday()
local id_1 = add('Hello', 'ERROR', 'Comment') local id_2 = add('World', 'ERROR', 'String') child.expect_screenshot()
remove(id_2) child.expect_screenshot()
eq(get(id_1).ts_remove, nil) eq(type(get(id_2).ts_remove), 'number')end
T['remove()']['does nothing on not proper input'] = function() local id = add('Hello', 'ERROR', 'Comment') local validate = function(...) local args = { ... } expect.no_error(function() remove(unpack(args)) end) end
validate(nil) validate(id + 1) validate('a')end
T['clear()'] = new_set()
local clear = forward_lua('MiniNotify.clear')
T['clear()']['works'] = function() mock_gettimeofday()
local id_1 = add('Hello', 'ERROR', 'Comment') local id_2 = add('World', 'ERROR', 'String') child.expect_screenshot()
clear() child.expect_screenshot()
eq(type(get(id_1).ts_remove), 'number') eq(type(get(id_2).ts_remove), 'number')end
T['clear()']['affects only active notifications'] = function() local id_1 = add('Hello', 'ERROR', 'Comment') local id_2 = add('World', 'ERROR', 'String') remove(id_1) local ts_remove_1 = get(id_1).ts_remove eq(type(ts_remove_1), 'number') eq(get(id_2).ts_remove, nil)
sleep(small_time) clear() eq(get(id_1).ts_remove, ts_remove_1) local ts_remove_2 = get(id_2).ts_remove eq(type(ts_remove_2), 'number') eq(ts_remove_1 < ts_remove_2, true)end
T['refresh()'] = new_set()
local refresh = forward_lua('MiniNotify.refresh')
-- Most tests are done in 'Window' set and tests for other functionsT['refresh()']['works'] = function() eq(child.lua_get('type(MiniNotify.refresh)'), 'function') end
T['refresh()']['handles manual buffer/window delete'] = function() add('Hello')
-- Window child.cmd('wincmd o') eq(is_notif_window_shown(), false) refresh() eq(is_notif_window_shown(), true)
-- Buffer child.cmd('%bw') eq(is_notif_window_shown(), false) refresh() eq(is_notif_window_shown(), true)end
T['refresh()']['can be used inside fast event'] = function() add('Hello') child.lua('_G.dur = ' .. small_time) child.lua([[ local timer = vim.loop.new_timer() timer:start(_G.dur, 0, function() MiniNotify.refresh() end) ]]) sleep(small_time + small_time) eq(child.cmd_capture('messages'), '')end
T['refresh()']['can be used when editor is locked'] = function() if child.fn.has('nvim-0.10') == 0 then MiniTest.skip('`SafeState` is present only on Neovim>=0.10') end
-- `:h :map-expression` lists things that are not allowed to be done when -- the mapping is still active. Editing another buffer (like the one used by -- 'mini.notify') is not allowed. child.lua([[ local notif_id = MiniNotify.add("Hello") local a = function() MiniNotify.refresh() MiniNotify.refresh() return "2l" end vim.keymap.set('o', '<C-a>', a, { expr = true })
local r = function() MiniNotify.remove(notif_id) return "2h" end vim.keymap.set('n', '<C-r>', r, { expr = true }) ]])
child.type_keys('y<C-a>') eq(child.cmd_capture('messages'), '') eq(is_notif_window_shown(), true)
child.type_keys('<C-r>') eq(child.cmd_capture('messages'), '') eq(is_notif_window_shown(), false)end
T['refresh()']['respects `vim.{g,b}.mininotify_disable`'] = new_set({ parametrize = { { 'g' }, { 'b' } } }, { test = function(var_type) mock_gettimeofday() add('Hello')
child[var_type].mininotify_disable = true child.expect_screenshot() refresh() child.expect_screenshot() child[var_type].mininotify_disable = false refresh() child.expect_screenshot() end,})
T['get()'] = new_set()
T['get()']['returns copy'] = function() local res = child.lua([[ local id = MiniNotify.add('Hello') local notif = MiniNotify.get(id) notif.msg = 'Should not change history' return MiniNotify.get(id).msg == 'Hello' ]]) eq(res, true)end
T['get_all()'] = new_set()
T['get_all()']['works'] = function() local id_1 = add('Hello') local id_2 = add('World') remove(id_2)
local history = get_all() eq(vim.tbl_count(history), 2)
eq(history[id_1].msg, 'Hello') eq(history[id_2].msg, 'World')end
T['get_all()']['returns copy'] = function() local res = child.lua([[ local id_1 = MiniNotify.add('Hello') local id_2 = MiniNotify.add('World') local history = MiniNotify.get_all() history[id_1].msg = 'Should not change history' history[id_2].msg = 'Nowhere'
local new_history = MiniNotify.get_all() return new_history[id_1].msg == 'Hello' and new_history[id_2].msg == 'World' ]]) eq(res, true)end
T['show_history()'] = new_set()
local show_history = forward_lua('MiniNotify.show_history')
T['show_history()']['works'] = function() mock_gettimeofday()
add('Hello') add('World', 'WARN', 'Comment') show_history() child.expect_screenshot()
-- Should set proper buffer name and filetype eq(child.api.nvim_buf_get_name(0), 'mininotify://' .. child.api.nvim_get_current_buf() .. '/history') eq(child.bo.filetype, 'mininotify-history')end
T['show_history()']['shows all notifications'] = function() mock_gettimeofday()
add('Hello') local id = add('World', 'WARN', 'Comment') add('Brave', 'INFO', 'String') remove(id) show_history() child.expect_screenshot()end
T['show_history()']['reuses history buffer'] = function() mock_gettimeofday()
add('Hello') show_history() local buf_id = child.api.nvim_get_current_buf() local n_bufs = #child.api.nvim_list_bufs()
add('World') show_history() child.expect_screenshot()
eq(child.api.nvim_get_current_buf(), buf_id) eq(#child.api.nvim_list_bufs(), n_bufs)end
T['show_history()']['respects `content.format`'] = function() mock_gettimeofday()
add('Hello') child.lua([[MiniNotify.config.content.format = function() return 'New message' end]]) show_history() child.expect_screenshot()end
T['show_history()']['sorts by update time'] = function() mock_gettimeofday()
add('Hello', 'ERROR', 'Comment') local id = add('World', 'WARN', 'Comment') add('Brave', 'ERROR', 'Comment')
update(id, { msg = 'WORLD' })
show_history() child.expect_screenshot()end
T['default_format()'] = new_set()
local default_format = forward_lua('MiniNotify.default_format')
T['default_format()']['works'] = function() mock_gettimeofday() eq(default_format({ msg = 'Hello', ts_update = ref_seconds + ref_microseconds }), '12:34:56 │ Hello')end
T['default_sort()'] = new_set()
local default_sort = forward_lua('MiniNotify.default_sort')
T['default_sort()']['works'] = function() --stylua: ignore -- First should sort by level and then by update time local notif_arr = { { msg = 'Thirteen', level = 'OFF', ts_add = ref_seconds + 1, ts_update = ref_seconds + 62 }, { msg = 'Twelve', level = 'OFF', ts_add = ref_seconds, ts_update = ref_seconds + 63 }, { msg = 'Eleven', level = 'TRACE', ts_add = ref_seconds + 1, ts_update = ref_seconds + 52 }, { msg = 'Ten', level = 'TRACE', ts_add = ref_seconds, ts_update = ref_seconds + 53 }, { msg = 'Nine', level = 'DEBUG', ts_add = ref_seconds + 1, ts_update = ref_seconds + 42 }, { msg = 'Eight', level = 'DEBUG', ts_add = ref_seconds, ts_update = ref_seconds + 43 }, { msg = 'Seven', level = 'INFO', ts_add = ref_seconds + 1, ts_update = ref_seconds + 32 }, { msg = 'Six', level = 'INFO', ts_add = ref_seconds, ts_update = ref_seconds + 33 }, { msg = 'Five', level = 'WARN', ts_add = ref_seconds + 1, ts_update = ref_seconds + 22 }, { msg = 'Four', level = 'WARN', ts_add = ref_seconds, ts_update = ref_seconds + 23 }, { msg = 'Three', level = 'ERROR', ts_add = ref_seconds + 1, ts_update = ref_seconds + 1, ts_remove = ref_seconds + 4 }, { msg = 'Two', level = 'ERROR', ts_add = ref_seconds + 1, ts_update = ref_seconds + 12 }, { msg = 'One', level = 'ERROR', ts_add = ref_seconds, ts_update = ref_seconds + 13 }, } local ref = {} for i = #notif_arr, 1, -1 do table.insert(ref, notif_arr[i]) end eq(default_sort(notif_arr), ref)end
T['default_sort()']['does not affect input'] = function() local lua_cmd = string.format( [[local notif_arr = { { msg = 'Hello', level = 'WARN', ts_update = %d }, { msg = 'World', level = 'ERROR', ts_update = %d }, } MiniNotify.default_sort(notif_arr) return notif_arr[1].msg == 'Hello']], ref_seconds, ref_seconds ) eq(child.lua(lua_cmd), true)end
-- Integration tests ----------------------------------------------------------T['Window'] = new_set({ hooks = { pre_case = function() mock_gettimeofday() child.set_size(12, 45) end,} })
T['Window']['uses notification `hl_group` to highlight its lines'] = function() add('Hello', 'ERROR', 'Comment') add('World', 'WARN', 'String') local ns_id = child.api.nvim_get_namespaces()['MiniNotifyHighlight'] local win_id = get_notif_win_id() local buf_id = child.api.nvim_win_get_buf(win_id) local extmarks = child.api.nvim_buf_get_extmarks(buf_id, ns_id, 0, -1, { details = true }) eq(#extmarks, 2) eq(extmarks[1][4].hl_group, 'Comment') eq(extmarks[2][4].hl_group, 'String')end
T['Window']['works with multiline messages'] = function() add('Hello\nBrave\nWorld') add('Hello\nAgain') child.expect_screenshot()end
T['Window']['computes default dimensions based on buffer content'] = function() add('a') child.expect_screenshot() add('aaa') child.expect_screenshot()end
T['Window']['wraps text'] = function() -- Should also correctly compute dimensions add('A very big notification message which should be wrapped') child.expect_screenshot() add('Another wrapped message') child.expect_screenshot()end
T['Window']['shows start of buffer if it does not fit whole'] = function() for i = 1, 20 do add('#' .. i) end child.expect_screenshot()end
T['Window']['uses proper buffer filetype and name'] = function() child.lua([[ local f = function(args) _G.is_correct = vim.api.nvim_buf_get_name(args.buf) == ('mininotify://') .. args.buf .. '/content' end vim.api.nvim_create_autocmd('FileType', { pattern = 'mininotify', callback = f }) ]]) add('Hello') eq(child.lua_get('_G.is_correct'), true)end
T['Window']['respects `content.format`'] = function() child.lua('MiniNotify.config.content.format = function(notif) return notif.msg end') add('Hello') child.expect_screenshot()end
T['Window']['respects `content.sort`'] = function() child.lua([[MiniNotify.config.content.sort = function(notif_arr) -- Show from earliest to latest table.sort(notif_arr, function(a, b) return a.ts_update < b.ts_update end) return notif_arr end]]) add('Hello') add('World') child.expect_screenshot()end
T['Window']['respects `window.config`'] = function() -- As table child.lua([[MiniNotify.config.window.config = { border = 'none', zindex = 100, width = 30, height = 1 }]]) add('Hello') add('World') child.expect_screenshot()
if child.fn.has('nvim-0.10') == 0 then MiniTest.skip('Neovim<0.10 has issues with displaying title in some cases') end
-- As callable child.lua([[MiniNotify.config.window.config = function(buf_id) _G.buffer_filetype = vim.bo[buf_id].filetype return { border = 'double', width = 25, height = 5, title = 'Custom title to check truncation' } end]]) refresh() child.expect_screenshot()
-- Should properly truncate title child.lua([[ local title = string.sub('abcdefgijklmnopqrstuvwxyzabcdefgijklmnopqrstuvwxyz', -vim.o.columns) MiniNotify.config.window.config = { width = vim.o.columns, title = title } ]]) refresh() child.expect_screenshot()end
T['Window']["respects 'winborder' option"] = function() if child.fn.has('nvim-0.11') == 0 then MiniTest.skip("'winborder' option is present on Neovim>=0.11") end
local validate = function(winborder) child.o.winborder = winborder add('Hello', 'ERROR', 'Comment') child.expect_screenshot() clear() end
validate('rounded')
-- Should prefer explicitly configured value over 'winborder' child.lua('MiniNotify.config.window.config.border = "double"') validate('rounded')
-- Should work with "string array" 'winborder' if child.fn.has('nvim-0.12') == 0 then MiniTest.skip("String array 'winborder' is present on Neovim>=0.12") end child.lua('MiniNotify.config.window.config.border = nil') validate('+,-,+,|,+,-,+,|')end
T['Window']['respects `window.max_width_share`'] = function() child.lua('MiniNotify.config.window.max_width_share = 0.75') add('A very-very-very-very-very long notification') child.expect_screenshot() child.lua('MiniNotify.config.window.max_width_share = 1') refresh() child.expect_screenshot()
-- Handles out of range values child.lua('MiniNotify.config.window.max_width_share = 10') refresh() child.expect_screenshot()
child.lua('MiniNotify.config.window.max_width_share = 0') refresh() child.expect_screenshot()end
T['Window']['respects `window.winblend`'] = function() local validate_winblend = function(ref) local win_id = get_notif_win_id() eq(child.api.nvim_win_get_option(win_id, 'winblend'), ref) end
add('Hello') validate_winblend(child.lua_get('MiniNotify.config.window.winblend')) clear()
child.lua('MiniNotify.config.window.winblend = 50') add('Hello') validate_winblend(50)end
T['Window']['respects tabline/statusline/cmdline'] = function() child.set_size(7, 20) child.lua('MiniNotify.config.content.format = function(notif) return notif.msg end') for i = 1, 7 do add('#' .. i) end
-- Validate tabline/statusline local validate = function(screenshot_opts) refresh() child.expect_screenshot(screenshot_opts) end
local validate_ui_lines = function() local ignore_tabline = child.fn.has('nvim-0.11') == 0 and 1 or nil local ignore_ruler = child.fn.has('nvim-0.12') == 0 and 7 or nil
child.o.showtabline, child.o.laststatus = 2, 2 validate({ ignore_text = { ignore_tabline, ignore_ruler }, ignore_attr = { ignore_tabline } })
child.o.showtabline, child.o.laststatus = 2, 0 validate({ ignore_text = { ignore_tabline, ignore_ruler }, ignore_attr = { ignore_tabline } })
child.o.showtabline, child.o.laststatus = 0, 2 validate({ ignore_text = { ignore_ruler } })
child.o.showtabline, child.o.laststatus = 0, 0 validate({ ignore_text = { ignore_ruler } }) end
-- Both with and without border validate_ui_lines() child.lua([[MiniNotify.config.window.config = { border = 'none' }]]) validate_ui_lines()
-- Command line child.o.showtabline, child.o.laststatus = 0, 0 child.o.cmdheight = 3 local ignore_cmdline = child.fn.has('nvim-0.11') == 1 and {} or { ignore_text = { 5 }, ignore_attr = { 5, 6, 7 } } validate(ignore_cmdline)
child.o.cmdheight = 0 validate()end
T['Window']['persists across tabpages'] = function() add('Hello') local init_tabpage_id = child.api.nvim_get_current_tabpage() eq(is_notif_window_shown(init_tabpage_id), true)
-- Window should appear only in current tabpage child.cmd('tabe') local new_tabpage_id = child.api.nvim_get_current_tabpage() eq(is_notif_window_shown(init_tabpage_id), false) eq(is_notif_window_shown(new_tabpage_id), true)
child.cmd('tabnext') eq(is_notif_window_shown(init_tabpage_id), true) eq(is_notif_window_shown(new_tabpage_id), false)end
T['Window']['fully updates on vim resize'] = function() -- With default window config child.set_size(10, 50) add('A very long notification') child.expect_screenshot() child.o.columns = 25 child.expect_screenshot() clear()
-- With callable window config child.set_size(15, 50) child.lua([[MiniNotify.config.window.config = function() return { row = math.floor(0.2 * vim.o.lines), col = math.floor(0.8 * vim.o.columns) } end]]) add('A very long notification') child.expect_screenshot() child.o.lines, child.o.columns = 10, 25 child.expect_screenshot()end
T['Window']['does not affect normal window navigation'] = function() local win_id_1 = child.api.nvim_get_current_win() child.cmd('botright wincmd v') local win_id_2 = child.api.nvim_get_current_win() add('Hello')
child.cmd('wincmd w') eq(child.api.nvim_get_current_win(), win_id_1) child.cmd('wincmd w') eq(child.api.nvim_get_current_win(), win_id_2) child.cmd('wincmd w') eq(child.api.nvim_get_current_win(), win_id_1)end
T['Window']['uses dedicated UI highlight groups'] = function() add('Hello') local win_id = get_notif_win_id() local winhighlight = child.api.nvim_win_get_option(win_id, 'winhighlight') expect.match(winhighlight, 'NormalFloat:MiniNotifyNormal') expect.match(winhighlight, 'FloatBorder:MiniNotifyBorder') expect.match(winhighlight, 'FloatTitle:MiniNotifyTitle')end
T['Window']['handles width computation for empty lines inside notification buffer'] = function() child.set_size(7, 20) child.lua('MiniNotify.config.content.format = function(notif) return notif.msg end')
add('') add('') child.expect_screenshot()end
T['Window']['handles deleting all buffers'] = function() local validate = function(name_suffix) add('Hello')
local helper_buf_id, ref_pattern = nil, '^mininotify://%d+/' .. vim.pesc(name_suffix) .. '$' for _, buf_id in ipairs(child.api.nvim_list_bufs()) do if string.find(child.api.nvim_buf_get_name(buf_id), ref_pattern) ~= nil then helper_buf_id = buf_id end end eq(type(helper_buf_id), 'number') eq(child.api.nvim_get_option_value('modified', { buf = helper_buf_id }), false) end
validate('content') validate('textlock-check-scratch')
child.cmd('%bwipeout') validate('content') validate('textlock-check-scratch')
child.cmd('%bdelete') validate('content') validate('textlock-check-scratch')end
T['LSP progress'] = new_set({ hooks = { pre_case = function() child.set_size(7, 50) mock_gettimeofday() child.lua('MiniNotify.config.window.config = { width = 45, height = 1 }')
-- Mock LSP just to have its client id child.cmd('luafile tests/mock-lsp/fruits.lua') end, },})
local call_handler = function(result, ctx) local result_str = vim.inspect(result, { newline = ' ', indent = '' }) local ctx_str = vim.inspect(ctx, { newline = ' ', indent = '' }) local lua_cmd = string.format([[vim.lsp.handlers['$/progress'](nil, %s, %s, {})]], result_str, ctx_str) child.lua(lua_cmd)end
T['LSP progress']['works'] = function() local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') }
local result = { token = 'test', value = { kind = 'begin', title = 'Testing', message = '0/1', percentage = 0 } } call_handler(result, ctx) child.expect_screenshot()
result.value.kind, result.value.message, result.value.percentage = 'report', '1/1', 100 call_handler(result, ctx) child.expect_screenshot()
result.value.kind, result.value.message, result.value.percentage = 'end', 'done', nil call_handler(result, ctx) child.expect_screenshot()
-- Should wait some time and then hide notifications sleep(default_duration_last - small_time) child.expect_screenshot() sleep(small_time + small_time) child.expect_screenshot()
-- Should update single notification (and not remove/add new ones) local history = get_all() eq(#history, 1) -- - Should use correct content based on latest LSP response eq(history[1].level, 'INFO') eq(history[1].hl_group, 'MiniNotifyLspProgress') eq(history[1].data, { source = 'lsp_progress', client_name = 'fruits-lsp', response = result, context = ctx })end
T['LSP progress']['handles not present data'] = function() -- NOTE: client's name is always present local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') }
-- All data which is allowed to be absent (as per LSP spec) is absent local result = { token = 'test', value = { kind = 'begin', title = 'Testing' } } call_handler(result, ctx) child.expect_screenshot()
result.value.kind, result.value.title = 'report', nil call_handler(result, ctx) child.expect_screenshot()
result.value.kind = 'end' call_handler(result, ctx) child.expect_screenshot()end
T['LSP progress']['handles sent error'] = function() child.lua('vim.notify = function(...) _G.notify_args = {...} end') child.lua([[vim.lsp.handlers['$/progress']( { code = 1, message = 'Error' }, {}, {bufnr = vim.api.nvim_get_current_buf(), client_id = _G.fruits_lsp_client_id}, {} )]]) eq( child.lua_get('_G.notify_args'), { vim.inspect({ code = 1, message = 'Error' }), child.lua_get('vim.log.levels.ERROR') } )end
T['LSP progress']['respects `lsp_progress.enable`'] = function() local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') } local result = { token = 'test', value = { kind = 'begin', title = 'Testing', message = '0/1', percentage = 0 } }
child.lua('MiniNotify.config.lsp_progress.enable = false') call_handler(result, ctx) eq(is_notif_window_shown(), false)
child.lua('MiniNotify.config.lsp_progress.enable = true') call_handler(result, ctx) eq(is_notif_window_shown(), true)end
T['LSP progress']['respects `lsp_progress.level`'] = function() child.lua('MiniNotify.config.lsp_progress.level = "ERROR"') local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') } local result = { token = 'test', value = { kind = 'begin', title = 'Testing', message = '0/1', percentage = 0 } }
call_handler(result, ctx) eq(get_all()[1].level, 'ERROR')end
T['LSP progress']['respects `lsp_progress.duration_last`'] = function() local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') } local result = { token = 'test', value = { kind = 'begin', title = 'Testing', message = '0/1', percentage = 0 } } call_handler(result, ctx)
result.value.kind, result.value.message, result.value.percentage = 'report', '1/1', 100 call_handler(result, ctx)
local new_duration_last = 6 * small_time child.lua('MiniNotify.config.lsp_progress.duration_last = ' .. new_duration_last) result.value.kind, result.value.message, result.value.percentage = 'end', 'done', nil call_handler(result, ctx) sleep(new_duration_last - 2 * small_time) child.expect_screenshot() sleep(2 * small_time + small_time) child.expect_screenshot()end
T['LSP progress']['reuses previous LSP handler'] = function() -- Test only on Neovim>=0.10 as previously it was different event and -- (possibly) different implementation (which makes mocking difficult). -- But relevant event should still be triggered in Neovim<0.10. if child.fn.has('nvim-0.10') == 0 then return end child.cmd('au LspProgress * lua _G.n_been_here = (_G.n_been_here or 0) + 1')
local ctx = { bufnr = vim.api.nvim_get_current_buf(), client_id = child.lua_get('_G.fruits_lsp_client_id') } local result = { token = 'test', value = { kind = 'begin', title = 'Testing' } } call_handler(result, ctx)
eq(child.lua_get('_G.n_been_here'), 1)
-- Should persist even if module was removed package.loaded['mini.notify'] = nil child.lua([[require('mini.notify').setup()]]) call_handler(result, ctx) eq(child.lua_get('_G.n_been_here'), 2)
-- Should be callable multiple times call_handler(result, ctx) eq(child.lua_get('_G.n_been_here'), 3)end
return T