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.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951local helpers = dofile('tests/helpers.lua')
local child = helpers.new_child_neovim()local expect, eq, no_eq = helpers.expect, helpers.expect.equality, helpers.expect.no_equalitylocal new_set = MiniTest.new_set
-- Helpers with child processes--stylua: ignore startlocal load_module = function(config) child.mini_load('icons', config) endlocal unload_module = function() child.mini_unload('icons') end--stylua: ignore 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 = function(...) return child.lua_get('{ MiniIcons.get(...) }', { ... }) endlocal list = forward_lua('MiniIcons.list')
-- Output test set ============================================================local T = new_set({ hooks = { pre_case = function() child.setup() load_module() 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.MiniIcons)'), 'table')
-- Autocommand group eq(child.fn.exists('#MiniIcons'), 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('MiniIconsAzure', 'links to Function') has_highlight('MiniIconsBlue', 'links to DiagnosticInfo') has_highlight('MiniIconsCyan', 'links to DiagnosticHint') has_highlight('MiniIconsGreen', 'links to DiagnosticOk') has_highlight('MiniIconsGrey', child.fn.has('nvim-0.10') == 1 and 'cleared' or 'cterm= gui=') has_highlight('MiniIconsOrange', 'links to DiagnosticWarn') has_highlight('MiniIconsPurple', 'links to Constant') has_highlight('MiniIconsRed', 'links to DiagnosticError') has_highlight('MiniIconsYellow', 'links to DiagnosticWarn')end
T['setup()']['creates `config` field'] = function() eq(child.lua_get('type(_G.MiniIcons.config)'), 'table')
-- Check default values local expect_config = function(field, value) eq(child.lua_get('MiniIcons.config.' .. field), value) end
expect_config('style', 'glyph')
expect_config('default', {}) expect_config('directory', {}) expect_config('extension', {}) expect_config('file', {}) expect_config('filetype', {}) expect_config('lsp', {}) expect_config('os', {}) eq(child.lua_get('type(MiniIcons.config.use_file_extension)'), 'function') eq(child.lua_get('MiniIcons.config.use_file_extension()'), true)end
T['setup()']['respects `config` argument'] = function() unload_module() load_module({ style = 'ascii' }) eq(child.lua_get('MiniIcons.config.style'), 'ascii')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({ style = 1 }, 'style', 'string') expect_config_error({ default = 1 }, 'default', 'table') expect_config_error({ directory = 1 }, 'directory', 'table') expect_config_error({ extension = 1 }, 'extension', 'table') expect_config_error({ file = 1 }, 'file', 'table') expect_config_error({ filetype = 1 }, 'filetype', 'table') expect_config_error({ lsp = 1 }, 'lsp', 'table') expect_config_error({ os = 1 }, 'os', 'table') expect_config_error({ use_file_extension = 1 }, 'use_file_extension', 'function')end
T['setup()']['ensures colors'] = function() child.cmd('colorscheme default') expect.match(child.cmd_capture('hi MiniIconsAzure'), 'links to Function')end
T['setup()']['can customize icons'] = function() -- Both override existing and provide new ones load_module({ default = { -- Can provide only customized attributes extension = { glyph = 'E' }, file = { hl = 'AAA' }, }, directory = { my_dir = { glyph = 'D', hl = 'Directory' }, }, })
eq(get('default', 'extension')[1], 'E') eq(get('default', 'file')[2], 'AAA') eq(get('directory', 'my_dir'), { 'D', 'Directory', false })end
T['setup()']['customization respects `vim.filetype.match()` fallback'] = function() child.lua([[vim.filetype.add({ extension = { myext = 'extinguisher' } })]])
load_module({ filetype = { extinguisher = { glyph = '', hl = 'MiniIconsRed' } }, extension = { myext = { hl = 'Special' } }, file = { ['hello.myext'] = { hl = 'String' } }, }) eq(get('file', 'hello.myext'), { '', 'String', false }) eq(get('extension', 'myext'), { '', 'Special', false }) eq(get('filetype', 'extinguisher'), { '', 'MiniIconsRed', false })end
T['setup()']['respects `config.style` when customizing icons'] = function() load_module({ style = 'ascii', default = { default = { glyph = '-', hl = 'Comment' } }, extension = { ext = { glyph = '', hl = 'MiniIconsRed' } }, })
eq(get('default', 'default'), { 'D', 'Comment', false }) eq(get('extension', 'ext'), { 'E', 'MiniIconsRed', false })end
T['get()'] = new_set()
T['get()']['works with "default" category'] = function() local validate = function(name, icon, hl, is_default) eq(get('default', name), { icon, hl, is_default }) end
validate('default', '', 'MiniIconsGrey', false) validate('directory', '', 'MiniIconsAzure', false) validate('extension', '', 'MiniIconsGrey', false) validate('file', '', 'MiniIconsGrey', false) validate('filetype', '', 'MiniIconsGrey', false) validate('lsp', '', 'MiniIconsRed', false) validate('os', '', 'MiniIconsPurple', false)
-- Can be customized load_module({ default = { file = { glyph = '', hl = 'Comment' }, }, }) validate('file', '', 'Comment', false)
-- Validates not supported category expect.error(function() get('default', 'aaa') end, 'aaa.*not.*category')end
T['get()']['works with "directory" category'] = function() load_module({ default = { directory = { glyph = 'D', hl = 'Comment' } }, directory = { mydir = { glyph = '', hl = 'AA' } }, })
local validate = function(name, icon, hl, is_default) eq(get('directory', name), { icon, hl, is_default }) end
validate('.git', '', 'MiniIconsOrange', false) validate('mydir', '', 'AA', false) validate('should-be-default', 'D', 'Comment', true)
-- Works with full paths validate('/home/user/.git', '', 'MiniIconsOrange', false) validate('/home/user/mydir', '', 'AA', false) validate('/home/user/should-be-default', 'D', 'Comment', true)end
T['get()']['works with "extension" category'] = function() load_module({ default = { extension = { glyph = 'E', hl = 'Comment' } }, extension = { myext = { glyph = '', hl = 'AA' }, ['my.ext'] = { glyph = '', hl = 'MiniIconsRed' }, ['my.other.ext'] = { glyph = 'O', hl = 'Error' }, ['my.lua'] = { glyph = 'L', hl = 'String' }, }, filetype = { squirrel = { glyph = 'S', hl = 'Special' } }, }) local validate = function(name, icon, hl, is_default) eq(get('extension', name), { icon, hl, is_default }) end
validate('lua', '', 'MiniIconsAzure', false) validate('my.lua', 'L', 'String', false)
validate('myext', '', 'AA', false) validate('my.ext', '', 'MiniIconsRed', false) validate('my.other.ext', 'O', 'Error', false)
validate('xpm', '', 'MiniIconsYellow', false) validate('nut', 'S', 'Special', false)
validate('should-be-default', 'E', 'Comment', true)
-- Properly resolves complex extensions validate('hello.lua', '', 'MiniIconsAzure', false) validate('hello.my.lua', 'L', 'String', false) validate('hello.world.mp4', '', 'MiniIconsAzure', false) validate('hello.myext', '', 'AA', false) validate('hello.my.ext', '', 'MiniIconsRed', false) validate('hello.my.other.ext', 'O', 'Error', false)end
T['get()']['works with "file" category'] = function() load_module({ default = { file = { glyph = 'F', hl = 'Comment' } }, file = { myfile = { glyph = '', hl = 'AA' }, ['init.lua'] = { glyph = 'V' }, }, filetype = { gitignore = { glyph = 'G', hl = 'Ignore' } }, extension = { py = { glyph = 'PY', hl = 'String' }, ['my.py'] = { glyph = 'MY', hl = 'Comment' }, ext = { glyph = 'E', hl = 'Comment' }, ['my.ext'] = { glyph = '', hl = 'MiniIconsRed' }, }, })
local validate = function(name, icon, hl, is_default) eq(get('file', name), { icon, hl, is_default }) end
-- Works with different sources of resolution -- - Exact basename validate('LICENSE', '', 'MiniIconsCyan', false) -- - Extension validate('hello.lua', '', 'MiniIconsAzure', false) -- - `vim.filetype.match()` validate('Cargo.lock', '', 'MiniIconsOrange', false) -- - `vim.filetype.match()` which relies on supplied `buf` validate('hello.xpm', '', 'MiniIconsYellow', false) -- - `vim.filetype.match()` with recognizable extension validate('build.xml', '', 'MiniIconsRed', false) -- - Default validate('should-be-default', 'F', 'Comment', true)
-- Can use customizations validate('myfile', '', 'AA', false) validate('init.lua', 'V', 'MiniIconsGreen', false) validate('hello.py', 'PY', 'String', false) validate('.gitignore', 'G', 'Ignore', false)
-- Can use complex "extension" validate('hello.ext', 'E', 'Comment', false) validate('hello.my.ext', '', 'MiniIconsRed', false) validate('hello.extra.dot.my.ext', '', 'MiniIconsRed', false) validate('hello.my.py', 'MY', 'Comment', false) validate('hello.extra.dot.my.py', 'MY', 'Comment', false)
-- Works with full paths local validate_full = function(name) eq(get('file', name), get('file', name:match('/([^/]+)$'))) end validate_full('/home/user/LICENSE') validate_full('/home/user/init.lua') validate_full('/home/user/world.lua') validate_full('/home/user/myfile') validate_full('/home/user/world.py') validate_full('/home/user/world.ext') validate_full('/home/user/world.my.ext') validate_full('/home/user/should-be-default')
-- Should use full name in `vim.filetype.match()` validate('/etc/group', '', 'MiniIconsCyan', false) child.lua([[vim.filetype.add({ pattern = { ['.*/dir/conf'] = 'conf' } })]]) validate('/home/user/dir/conf', '', 'MiniIconsGrey', false)
-- Cached data for basename should not affect full path resolution eq(get('file', 'gshadow'), { 'F', 'Comment', true }) validate('/etc/gshadow', '', 'MiniIconsCyan', false)
-- Should override some confusing `vim.filetype.match()` results validate('.dockerignore', '', 'MiniIconsOrange', false)end
T['get()']['respects `config.use_file_extension`'] = function() child.lua([[ _G.log = {} MiniIcons.setup({ extension = { ['my.ext'] = { glyph = 'M', hl = 'Comment' }, }, use_file_extension = function(ext, file, ...) table.insert(_G.log, { ext, file, ... }) if ext == 'yml' then return nil end if vim.endswith(ext, 'scm') then return false end return true end }) ]])
-- Should be called only once with proper arguments child.lua('_G.log = {}') eq(get('file', 'hello.woRld.My.Ext'), { 'M', 'Comment', false }) eq(child.lua_get('_G.log'), { { 'world.my.ext', 'hello.woRld.My.Ext' } })
-- Should allow skipping extensions if returns not `true` child.lua([[vim.filetype.add({ pattern = { ['.*/roles/.*/tasks/.*%.ya?ml'] = 'yaml.ansible' } })]]) eq(get('file', '/home/user/roles/a/tasks/hello.yml'), { '', 'MiniIconsGrey', false }) eq(get('file', '/home/user/roles/a/tasks/hello.yaml'), { '', 'MiniIconsPurple', false }) eq(get('file', '/hello.yml'), { '', 'MiniIconsPurple', false }) eq(get('file', '/extra.dots.yml'), { '', 'MiniIconsPurple', false })
-- - '/queries/.*%.scm' pattern should be built-in eq(get('file', './queries/lua.scm'), { '', 'MiniIconsGreen', false }) eq(get('file', './queries/extra.dots.scm'), { '', 'MiniIconsGreen', false }) eq(get('file', 'lua.scm'), { '', 'MiniIconsGrey', false })
-- Should not be called if there is no extension child.lua('_G.log = {}') get('file', 'file-without-extension') eq(child.lua_get('_G.log'), {})end
T['get()']['works with "filetype" category'] = function() load_module({ default = { filetype = { glyph = 'F', hl = 'Comment' } }, filetype = { myfiletype = { glyph = '', hl = 'AA' } }, })
local validate = function(name, icon, hl, is_default) eq(get('filetype', name), { icon, hl, is_default }) end
validate('help', '', 'MiniIconsPurple', false) validate('myfiletype', '', 'AA', false) validate('should-be-default', 'F', 'Comment', true)end
T['get()']['works with "lsp" category'] = function() load_module({ default = { lsp = { glyph = 'L', hl = 'Comment' } }, lsp = { mylsp = { glyph = '', hl = 'AA' } }, })
local validate = function(name, icon, hl, is_default) eq(get('lsp', name), { icon, hl, is_default }) end
validate('array', '', 'MiniIconsOrange', false) validate('mylsp', '', 'AA', false) validate('should-be-default', 'L', 'Comment', true)end
T['get()']['works with "os" category'] = function() load_module({ default = { os = { glyph = 'O', hl = 'Comment' } }, os = { myos = { glyph = '', hl = 'AA' } }, })
local validate = function(name, icon, hl, is_default) eq(get('os', name), { icon, hl, is_default }) end
validate('arch', '', 'MiniIconsAzure', false) validate('myos', '', 'AA', false) validate('should-be-default', 'O', 'Comment', true)end
T['get()']['caches output'] = function() local durations = child.lua([[ local file = 'complex.file.name.which.should.fall.back.to.vim.filetype.match' local bench = function() local start_time = vim.loop.hrtime() MiniIcons.get('file', file) return vim.loop.hrtime() - start_time end
local dur_no_cache = bench() local dur_cache = bench()
-- Calling `setup()` should reset cache MiniIcons.setup() local dur_no_cache_2 = bench()
return { no_cache = dur_no_cache, cache = dur_cache, no_cache_2 = dur_no_cache_2 } ]])
eq(durations.cache <= 0.02 * durations.no_cache, true) eq(durations.cache <= 0.02 * durations.no_cache_2, true)end
T['get()']['adds to cache resolved output in its original category'] = function() -- NOTES: -- - There should also be caching of both "file" and "extension" category -- resolving to "filetype", but as "filetype" is already very fast without -- caching, the benchmarking is not stable. local durations = child.lua([[ local bench = function(category, name) local start_time = vim.loop.hrtime() MiniIcons.get(category, name) return vim.loop.hrtime() - start_time end
-- "file" category resolving to manually tracked "extension" local ext_manual_no_cache = bench('extension', 'lua') MiniIcons.get('file', 'hello.py') local ext_manual_cache = bench('extension', 'py')
-- "file" category resolving to known (i.e. not fallback) "extension" local ext_known_no_cache = bench('extension', 'txt') MiniIcons.get('file', 'hello.yml') local ext_known_cache = bench('extension', 'yml')
-- "file" category resolving to unknown "extension" local ext_unknown_no_cache = bench('extension', 'myext') MiniIcons.get('file', 'hello.myotherext') local ext_unknown_cache = bench('extension', 'myotherext')
return { ext_manual_no_cache = ext_manual_no_cache, ext_manual_cache = ext_manual_cache, ext_known_no_cache = ext_known_no_cache, ext_known_cache = ext_known_cache, ext_unknown_no_cache = ext_unknown_no_cache, ext_unknown_cache = ext_unknown_cache, } ]])
-- Resolution with manually tracked data is usually fast, hence higher coeff eq(durations.ext_manual_cache < 0.7 * durations.ext_manual_no_cache, true)
-- There is a full effect of caching for not manually tracked eq(durations.ext_known_cache < 0.1 * durations.ext_known_no_cache, true) eq(durations.ext_unknown_cache < 0.1 * durations.ext_unknown_no_cache, true)end
T['get()']['uses cached extension during "file" resolution'] = function() local durations = child.lua([[ local bench = function(category, name) local start_time = vim.loop.hrtime() MiniIcons.get(category, name) return vim.loop.hrtime() - start_time end
-- Known extension (i.e. not falling back to default) local file_known_ext_no_cache = bench('file', 'hello.txt') MiniIcons.get('extension', 'yml') local file_known_ext_cache = bench('file', 'world.yml')
-- Unknown extension (i.e. falling back to default) local file_unknown_ext_no_cache = bench('file', 'hello.myext') MiniIcons.get('file', 'hello.myotherext') local file_unknown_ext_cache = bench('file', 'world.myotherext')
return { file_known_ext_no_cache = file_known_ext_no_cache, file_known_ext_cache = file_known_ext_cache, file_unknown_ext_no_cache = file_unknown_ext_no_cache, file_unknown_ext_cache = file_unknown_ext_cache, } ]])
-- Known extensions are used as output resulting in no `vim.filetype.match()` -- call for file name itself eq(durations.file_known_ext_cache < 0.1 * durations.file_known_ext_no_cache, true)
-- Unknown extensions are NOT used as output, but they are still cached which -- results in no extra `vim.filetype.match()` call to resolve itself inside -- "extension" category eq(durations.file_unknown_ext_cache < 0.7 * durations.file_unknown_ext_no_cache, true)end
T['get()']['prefers user configured data over `vim.filetype.match()`'] = function() load_module({ extension = { ['complex.extension.which.user.configured.to.not.fall.back.to.vim.filetype.match'] = { glyph = 'E' }, ['complex.extension.two.which.user.configured.to.not.fall.back.to.vim.filetype.match'] = { glyph = 'e' }, }, file = { ['complex.file.name.which.user.configured.to.not.fall.back.to.vim.filetype.match'] = { glyph = 'C' } }, })
local durations = child.lua([[ local bench = function(category, name) local start_time = vim.loop.hrtime() MiniIcons.get(category, name) return vim.loop.hrtime() - start_time end
local ext_fallback = bench('extension', 'not-supported-extension') local ext_ext = bench('extension', 'complex.extension.which.user.configured.to.not.fall.back.to.vim.filetype.match')
local file_fallback = bench('file', 'not-supported-file') local file_file = bench('file', 'complex.file.name.which.user.configured.to.not.fall.back.to.vim.filetype.match') local file_ext = bench('file', 'FILENAME.complex.extension.two.which.user.configured.to.not.fall.back.to.vim.filetype.match')
return { ext_fallback = ext_fallback, ext_ext = ext_ext,
file_fallback = file_fallback, file_file = file_file, file_ext = file_ext, } ]])
eq(durations.ext_ext < 0.1 * durations.ext_fallback, true) eq(durations.file_file < 0.1 * durations.file_fallback, true) eq(durations.file_ext < 0.1 * durations.file_fallback, true)end
T['get()']['respects `config.style`'] = function() load_module({ style = 'ascii', default = { file = { glyph = '' } }, extension = { myext = { glyph = '', hl = 'MiniIconsRed' } }, })
-- ASCII style is upper variant of the first byte of the resolved name eq(get('default', 'directory'), { 'D', 'MiniIconsAzure', false })
-- - 'init.lua' is explicitly tracked eq(get('file', 'init.lua'), { 'I', 'MiniIconsGreen', false }) -- - 'hello.lua' is resolved to use "lua" extension eq(get('file', 'hello.lua'), { 'L', 'MiniIconsAzure', false }) -- - 'Cargo.lock' is resolved to use "toml" filetype eq(get('file', 'Cargo.lock'), { 'T', 'MiniIconsOrange', false }) -- - 'not-supported' is resolved to use "file" default eq(get('file', 'not-supported'), { 'F', 'MiniIconsGrey', true })
-- Should work with full paths eq(get('file', '/home/user/LICENSE'), { 'L', 'MiniIconsCyan', false }) eq(get('file', '/home/user/world.lua'), { 'L', 'MiniIconsAzure', false }) eq(get('file', '/home/user/Cargo.lock'), { 'T', 'MiniIconsOrange', false }) eq(get('file', '/home/user/not-supported-2'), { 'F', 'MiniIconsGrey', true })
-- Should work with all categories eq(get('default', 'lsp')[1], 'L') eq(get('directory', 'nvim')[1], 'N') eq(get('extension', 'lua')[1], 'L') eq(get('filetype', 'help')[1], 'H') eq(get('lsp', 'array')[1], 'A') eq(get('os', 'arch')[1], 'A')
-- Should work with customized icons eq(get('default', 'directory')[1], 'D') eq(get('extension', 'myext')[1], 'M') eq(get('file', 'hello.myext')[1], 'M')
-- Should properly return if output is fallback (even if icons are the same) eq(get('directory', 'dir-not-supported'), { 'D', 'MiniIconsAzure', true }) eq(get('extension', 'ext-not-supported'), { 'E', 'MiniIconsGrey', true }) eq(get('file', 'file-not-supported'), { 'F', 'MiniIconsGrey', true }) eq(get('filetype', 'filetype-not-supported'), { 'F', 'MiniIconsGrey', true }) eq(get('lsp', 'lsp-not-supported'), { 'L', 'MiniIconsRed', true }) eq(get('os', 'os-not-supported'), { 'O', 'MiniIconsPurple', true })end
T['get()']['respects multibyte characters with "ascii" style'] = function() load_module({ style = 'ascii', directory = { ['й_dir'] = { glyph = 'M' } }, extension = { ['й_ext'] = { glyph = 'M' } }, file = { ['й_file'] = { glyph = 'M' } }, filetype = { ['й_filetype'] = { glyph = 'M' } }, lsp = { ['й_lsp'] = { glyph = 'M' } }, os = { ['й_os'] = { glyph = 'M' } }, })
-- Currently matched without making it upper case to save speed for -- overwhelmingly common single byte case (because `vim.fn.toupper()` is -- *much* slower than `string.upper()`) eq(get('directory', 'й_dir')[1], 'Й') eq(get('extension', 'й_ext')[1], 'Й') eq(get('file', 'й_file')[1], 'Й') eq(get('filetype', 'й_filetype')[1], 'Й') eq(get('lsp', 'й_lsp')[1], 'Й') eq(get('os', 'й_os')[1], 'Й')
-- Default stil should match with category's first letter eq(get('directory', 'й_default_dir')[1], 'D') eq(get('extension', 'й_default_ext')[1], 'E') eq(get('file', 'й_default_file')[1], 'F') eq(get('filetype', 'й_default_filetype')[1], 'F') eq(get('lsp', 'й_default_lsp')[1], 'L') eq(get('os', 'й_default_os')[1], 'O')end
T['get()']['respects customizations in config'] = function() load_module({ default = { directory = { glyph = '', hl = 'Directory' } }, directory = { mydir = { glyph = 'A', hl = 'Comment' } }, extension = { myext = { glyph = 'B' } }, file = { myfile = { hl = 'String' } }, filetype = { myfiletype = { glyph = 'D' } }, lsp = { mylsp = { glyph = 'E' } }, os = { myos = { glyph = 'F' } }, })
eq(get('default', 'directory'), { '', 'Directory', false }) eq(get('directory', 'mydir'), { 'A', 'Comment', false }) eq(get('extension', 'myext'), { 'B', 'MiniIconsGrey', false }) eq(get('file', 'myfile'), { '', 'String', false }) eq(get('filetype', 'myfiletype'), { 'D', 'MiniIconsGrey', false }) eq(get('lsp', 'mylsp'), { 'E', 'MiniIconsRed', false }) eq(get('os', 'myos'), { 'F', 'MiniIconsPurple', false })end
T['get()']['handles different casing'] = function() load_module({ directory = { mydir = { glyph = 'A' } }, extension = { myext = { glyph = 'B' } }, file = { myfile = { glyph = 'C' } }, filetype = { myfiletype = { glyph = 'D' } }, lsp = { mylsp = { glyph = 'E' } }, os = { myos = { glyph = 'F' } }, })
-- Should match exactly for "file" and "directory" no_eq(get('directory', 'nvim'), get('directory', 'Nvim')) no_eq(get('directory', 'mydir'), get('directory', 'MyDir'))
-- - 'Cargo.lock' is matched as 'toml' in `vim.filetype.match()` no_eq(get('file', 'Cargo.lock'), get('file', 'cargo.lock')) no_eq(get('file', 'myfile'), get('file', 'MyFile'))
-- Others - ignoring case eq(get('default', 'file'), get('default', 'FILE'))
eq(get('extension', 'lua'), get('extension', 'LUA')) eq(get('file', 'hello.R'), get('file', 'hello.r'))
eq(get('extension', 'MyExT')[1], 'B') eq(get('file', 'hello.MyExT')[1], 'B')
eq(get('filetype', 'help'), get('filetype', 'Help')) eq(get('filetype', 'myfiletype'), get('filetype', 'MyFileType'))
eq(get('lsp', 'array'), get('lsp', 'Array')) eq(get('lsp', 'mylsp'), get('lsp', 'MyLsp'))
eq(get('os', 'arch'), get('os', 'Arch')) eq(get('os', 'myos'), get('os', 'MyOs'))end
T['get()']['can be used without `setup()`'] = function() unload_module() eq(child.lua_get('{ require("mini.icons").get("default", "file") }'), { '', 'MiniIconsGrey', false })end
T['get()']['works with deleted cwd'] = function() local temp_dir = 'tests/dir-icons/temp' vim.fn.mkdir(temp_dir, 'p') MiniTest.finally(function() vim.fn.delete(temp_dir, 'rf') end)
local file_path = child.fn.fnamemodify('tests/dir-icons/file.txt', ':p') child.fn.chdir(temp_dir) vim.fn.delete(temp_dir, 'rf')
-- Should use `vim.filetype.match` without errors due to missing cwd eq(get('extension', 'xpm'), { '', 'MiniIconsYellow', false }) eq(get('extension', 'unknown'), { '', 'MiniIconsGrey', true }) eq(get('file', 'hello.tcsh'), { '', 'MiniIconsAzure', false }) eq(get('file', file_path), { '', 'MiniIconsYellow', false }) eq(get('file', 'does-not-exist'), { '', 'MiniIconsGrey', true })end
T['get()']['handles deleting all buffers'] = function() -- As `vim.filetype.match()` requries a buffer to be more useful, make sure -- that there is a persistent helper buffer local validate = function() local helper_buf_id, ref_pattern = nil, '^miniicons://%d+/filetype%-match%-scratch$' 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
eq(get('file', 'hello.xpm'), { '', 'MiniIconsYellow', false }) validate()
child.cmd('%bwipeout') eq(get('file', 'hello.tcsh'), { '', 'MiniIconsAzure', false }) validate()
child.cmd('%bdelete') eq(get('file', 'hello.zsh'), { '', 'MiniIconsGreen', false }) validate()end
T['get()']['uses width one glyphs'] = function() local bad_glyphs = {} for _, cat in ipairs(list('default')) do for _, name in ipairs(list(cat)) do local icon = get(cat, name)[1] if vim.fn.strdisplaywidth(icon) > 1 then table.insert(bad_glyphs, { cat, name, icon }) end end end eq(bad_glyphs, {})end
T['get()']['validates arguments'] = function() expect.error(function() get(1, 'lua') end, 'category.*string') expect.error(function() get('file', 1) end, 'name.*string')
expect.error(function() get('aaa', 'lua') end, 'aaa.*not.*category')end
T['list()'] = new_set()
T['list()']['works'] = function() local islist = vim.fn.has('nvim-0.10') == 1 and vim.islist or vim.tbl_islist local validate = function(category, ref_present_entry) local res = list(category) eq(islist(res), true) eq(vim.tbl_contains(res, ref_present_entry), true) end
eq(list('default'), { 'default', 'directory', 'extension', 'file', 'filetype', 'lsp', 'os' }) validate('directory', 'nvim') validate('extension', 'h') validate('file', 'init.lua') validate('filetype', 'lua') validate('lsp', 'array') validate('os', 'arch')
-- Should not add cached but not explicitly supported items local validate_no = function(category, name) get(category, name) eq(vim.tbl_contains(list(category), name), false) end
validate_no('directory', 'mydir') validate_no('extension', 'myext') validate_no('file', 'myfile') validate_no('filetype', 'myfiletype') validate_no('lsp', 'mylsp') validate_no('os', 'myos')end
T['list()']['uses lowercase icon names for categories which ignore case'] = function() -- Otherwise `get()` will not match names with uppercase letter local validate = function(category) local not_lowercase = vim.tbl_filter(function(name) return name ~= name:lower() end, list(category)) eq(not_lowercase, {}) end validate('default') validate('extension') validate('filetype') validate('lsp') validate('os')end
T['list()']['validates arguments'] = function() expect.error(function() list(1) end, '1.*not.*category') expect.error(function() list('aaa') end, 'aaa.*not.*category')end
T['mock_nvim_web_devicons()'] = new_set()
T['mock_nvim_web_devicons()']['works'] = function() load_module({ default = { file = { glyph = 'f', hl = 'Comment' }, filetype = { glyph = 't', hl = 'Comment' }, extension = { glyph = 'e', hl = 'Comment' }, }, extension = { myext = { glyph = 'E', hl = 'Constant' } }, file = { myfile = { glyph = 'F', hl = 'String' } }, filetype = { myfiletype = { glyph = 'T', hl = 'Special' } }, os = { myos = { glyph = 'O', hl = 'Delimiter' } }, }) child.api.nvim_set_hl(0, 'Comment', { fg = '#aaaaaa', ctermfg = 248 }) child.api.nvim_set_hl(0, 'Constant', { fg = '#e0e060', ctermfg = 185 }) child.api.nvim_set_hl(0, 'String', { fg = '#60e060', ctermfg = 77 }) child.api.nvim_set_hl(0, 'Special', { fg = '#e060e0', ctermfg = 170 }) child.api.nvim_set_hl(0, 'Delimiter', { fg = '#60e0e0', ctermfg = 80 })
expect.error(function() child.lua('require("nvim-web-devicons")') end, 'nvim%-web%-devicons.*not found') child.lua('MiniIcons.mock_nvim_web_devicons()') expect.no_error(function() child.lua('require("nvim-web-devicons")') end)
child.lua('_G.devicons = require("nvim-web-devicons")')
-- Should reasonable mock at least common functions which return something eq(child.lua_get('{ devicons.get_icon("init.lua", nil) }'), { '', 'MiniIconsGreen' }) eq(child.lua_get('{ devicons.get_icon(nil, "lua") }'), { '', 'MiniIconsAzure' }) eq(child.lua_get('{ devicons.get_icon("hello.py", "lua", {}) }'), { '', 'MiniIconsYellow' }) eq(child.lua_get('{ devicons.get_icon("init.lua", "lua", {}) }'), { '', 'MiniIconsGreen' }) eq(child.lua_get('{ devicons.get_icon("xxx", nil, {}) }'), {}) eq(child.lua_get('{ devicons.get_icon(nil, "xxx", {}) }'), {}) eq(child.lua_get('{ devicons.get_icon("xxx", nil, { default = true }) }'), { 'f', 'Comment' }) eq(child.lua_get('{ devicons.get_icon(nil, "xxx", { default = true }) }'), { 'e', 'Comment' }) expect.error(function() child.lua('devicons.get_icon(1, nil, {})') end) expect.error(function() child.lua('devicons.get_icon(nil, 1, {})') end)
local get_icon_by_filetype = function(...) return child.lua_get('{ devicons.get_icon_by_filetype(...) }', { ... }) end eq(get_icon_by_filetype('help', {}), { '', 'MiniIconsPurple' }) eq(get_icon_by_filetype('xxx', {}), {}) eq(get_icon_by_filetype('xxx', { default = true }), { 't', 'Comment' })
eq(child.lua_get('{ devicons.get_icon_color("myfile", nil, {}) }'), { 'F', '#60e060' }) eq(child.lua_get('{ devicons.get_icon_color("xxx", nil, {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_color("xxx", nil, { default = true }) }'), { 'f', '#aaaaaa' })
eq(child.lua_get('{ devicons.get_icon_cterm_color("myfile", nil, {}) }'), { 'F', 77 }) eq(child.lua_get('{ devicons.get_icon_cterm_color("xxx", nil, {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_cterm_color("xxx", nil, { default = true }) }'), { 'f', 248 })
eq(child.lua_get('{ devicons.get_icon_colors("myfile", nil, {}) }'), { 'F', '#60e060', 77 }) eq(child.lua_get('{ devicons.get_icon_colors("xxx", nil, {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_colors("xxx", nil, { default = true }) }'), { 'f', '#aaaaaa', 248 })
eq(child.lua_get('{ devicons.get_icon_color_by_filetype("myfiletype", {}) }'), { 'T', '#e060e0' }) eq(child.lua_get('{ devicons.get_icon_color_by_filetype("xxx", {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_color_by_filetype("xxx", { default = true }) }'), { 't', '#aaaaaa' })
eq(child.lua_get('{ devicons.get_icon_cterm_color_by_filetype("myfiletype", {}) }'), { 'T', 170 }) eq(child.lua_get('{ devicons.get_icon_cterm_color_by_filetype("xxx", {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_cterm_color_by_filetype("xxx", { default = true }) }'), { 't', 248 })
eq(child.lua_get('{ devicons.get_icon_colors_by_filetype("myfiletype", {}) }'), { 'T', '#e060e0', 170 }) eq(child.lua_get('{ devicons.get_icon_colors_by_filetype("xxx", {}) }'), {}) eq(child.lua_get('{ devicons.get_icon_colors_by_filetype("xxx", { default = true }) }'), { 't', '#aaaaaa', 248 })
eq(child.lua_get('devicons.get_icon_name_by_filetype("myfiletype")'), 'myfiletype')
local ref_default_icon = { color = '#aaaaaa', cterm_color = '248', icon = 'f', name = 'Default' } eq(child.lua_get('devicons.get_default_icon()'), ref_default_icon)
local ref_all = { default = ref_default_icon, myext = { color = '#e0e060', cterm_color = '185', icon = 'E', name = 'myext' }, myfile = { color = '#60e060', cterm_color = '77', icon = 'F', name = 'myfile' }, myos = { color = '#60e0e0', cterm_color = '80', icon = 'O', name = 'myos' }, } local out_all = child.lua([[ local t = devicons.get_icons() return { default = t[1], myext = t.myext, myfile = t.myfile, myos = t.myos, -- Should not be present, i.e. should be `nil` myfiletype = t.myfiletype, } ]]) eq(out_all, ref_all)
eq(child.lua_get('devicons.get_icons_by_desktop_environment()'), {}) eq(child.lua_get('{ myext = devicons.get_icons_by_extension().myext }'), { myext = ref_all.myext }) eq(child.lua_get('{ myfile = devicons.get_icons_by_filename().myfile }'), { myfile = ref_all.myfile }) eq(child.lua_get('{ myos = devicons.get_icons_by_operating_system().myos }'), { myos = ref_all.myos }) eq(child.lua_get('devicons.get_icons_by_window_manager()'), {})
-- Should have others at least present local present = { 'has_loaded', 'refresh', 'set_default_icon', 'set_icon', 'set_icon_by_filetype', 'set_up_highlights', 'setup' } for _, method in ipairs(present) do eq(child.lua_get('type(devicons.' .. method .. ')'), 'function') end
-- Should set global variable which is set in 'plugin/nvim-web-devicons.vim' eq(child.g.nvim_web_devicons, 1)end
T['tweak_lsp_kind()'] = new_set({ hooks = { pre_case = function() child.lua([[MiniIcons.setup({ default = { lsp = { glyph = 'L' } }, lsp = { text = { glyph = 'T' }, file = { glyph = 'F' }, somethingnew = { glyph = 'S' }, } })]]) end, },})
local setup_lsp_protocol = function() child.lua([[ vim.lsp.protocol = { CompletionItemKind = { [1] = 'Text', Text = 1, [2] = 'Method', Method = 2, [3] = 'SomethingNew', SomethingNew = 3, [4] = 'Fallback', Fallback = 4, }, SymbolKind = { [1] = 'File', File = 1, [2] = 'Module', Module = 2, [3] = 'SomethingNew', SomethingNew = 3, [4] = 'Fallback', Fallback = 4, }, } ]]) return { CompletionItemKind = { Text = 1, Method = 2, SomethingNew = 3, Fallback = 4 }, SymbolKind = { File = 1, Module = 2, SomethingNew = 3, Fallback = 4 }, }end
local validate_lsp_protocol = function(mode, field, ref_arr) local init_map = setup_lsp_protocol() child.lua('MiniIcons.tweak_lsp_kind(...)', { mode })
child.lua('_G.tbl = vim.lsp.protocol.' .. field) child.lua([=[ _G.arr, _G.map = {}, {} for k, v in pairs(_G.tbl) do if type(k) == 'number' then _G.arr[k] = v else _G.map[k] = v end end ]=])
-- Should modify only "array" part (i.e. only "number -> kind" map) in order -- to preserve original info eq(child.lua_get('_G.arr'), ref_arr) eq(child.lua_get('_G.map'), init_map[field])end
T['tweak_lsp_kind()']['works'] = function() -- By default should prepend icon validate_lsp_protocol(nil, 'CompletionItemKind', { 'T Text', ' Method', 'S SomethingNew', 'L Fallback' }) validate_lsp_protocol(nil, 'SymbolKind', { 'F File', ' Module', 'S SomethingNew', 'L Fallback' })end
T['tweak_lsp_kind()']['respects `mode` argument'] = function() validate_lsp_protocol('append', 'CompletionItemKind', { 'Text T', 'Method ', 'SomethingNew S', 'Fallback L' }) validate_lsp_protocol('append', 'SymbolKind', { 'File F', 'Module ', 'SomethingNew S', 'Fallback L' })
validate_lsp_protocol('prepend', 'CompletionItemKind', { 'T Text', ' Method', 'S SomethingNew', 'L Fallback' }) validate_lsp_protocol('prepend', 'SymbolKind', { 'F File', ' Module', 'S SomethingNew', 'L Fallback' })
validate_lsp_protocol('replace', 'CompletionItemKind', { 'T', '', 'S', 'L' }) validate_lsp_protocol('replace', 'SymbolKind', { 'F', '', 'S', 'L' })end
T['tweak_lsp_kind()']['validates arguments'] = function() expect.error(function() child.lua('MiniIcons.tweak_lsp_kind("aa")') end, '`mode`.*one of')end
return T