Files
neovim/test/functional/vimscript/fnamemodify_spec.lua
Justin M. Keyes 446b9d8c55 docs: misc, remove some old help tags #40214
- Remove old help tags: they add noise to cmdline completion.

Co-authored-by: acehinnnqru <acehinnnqru@gmail.com>
Co-authored-by: KangaZero <samuelyongw@gmail.com>
Co-authored-by: Simone Ragusa <hi@interrato.dev>
Co-authored-by: Chinmay Dalal <~chinmay/public-inbox@lists.sr.ht>
Co-authored-by: coyaSONG <66289470+coyaSONG@users.noreply.github.com>
Co-authored-by: Olivia Kinnear <git@superatomic.dev>
2026-07-18 04:29:51 -04:00

249 lines
8.6 KiB
Lua

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local clear = n.clear
local eq = t.eq
local exec_lua = n.exec_lua
local fnamemodify = n.fn.fnamemodify
local getcwd = n.fn.getcwd
local command = n.command
local poke_eventloop = n.poke_eventloop
local write_file = t.write_file
local is_os = t.is_os
local chdir = n.fn.chdir
describe('fnamemodify()', function()
setup(function()
write_file('Xtest-fnamemodify.txt', [[foobar]])
t.mkdir('foo')
write_file('foo/bar', [[bar]])
end)
before_each(clear)
teardown(function()
os.remove('Xtest-fnamemodify.txt')
n.rmdir('foo')
end)
it('root path', function()
local root = assert(t.fix_slashes(n.pathroot()))
eq(root, fnamemodify([[/]], ':p:h'))
eq(root, fnamemodify([[/]], ':p'))
if is_os('win') then
eq(root, fnamemodify([[\]], ':p:h'))
eq(root, fnamemodify([[\]], ':p'))
command('set shellslash')
eq(root, fnamemodify([[\]], ':p:h'))
eq(root, fnamemodify([[\]], ':p'))
eq(root, fnamemodify([[/]], ':p:h'))
eq(root, fnamemodify([[/]], ':p'))
local letter_colon = root:sub(1, 2)
local old_dir = ('%s/'):format(getcwd())
local foo_dir = old_dir .. 'foo/'
eq(old_dir, fnamemodify(letter_colon, ':p'))
eq(old_dir, fnamemodify(letter_colon .. '.', ':p'))
eq(old_dir, fnamemodify(letter_colon .. './', ':p'))
eq(foo_dir, fnamemodify(letter_colon .. './foo', ':p'))
eq(foo_dir, fnamemodify(letter_colon .. 'foo', ':p'))
chdir('foo')
eq(old_dir, fnamemodify(letter_colon .. '..', ':p'))
eq(old_dir, fnamemodify(letter_colon .. '../', ':p'))
eq(foo_dir .. 'bar', fnamemodify(letter_colon .. 'bar', ':p'))
end
end)
it('~user in a fast event #40707', function()
exec_lua([[
local timer = assert(vim.uv.new_timer())
timer:start(0, 0, function()
timer:close()
assert(vim.in_fast_event())
_G.result = vim.fn.fnamemodify('~neovim_user_not_found_test/', ':p')
end)
]])
poke_eventloop()
local expected = '~neovim_user_not_found_test/'
if is_os('win') then
-- Windows never expands ~user, ':p' just prefixes the cwd.
expected = fnamemodify('.', ':p') .. expected
end
eq(expected, exec_lua('return _G.result'))
end)
it(':8 (DOS 8.3 short format)', function()
eq('Xtest-fnamemodify.txt', fnamemodify([[Xtest-fnamemodify.txt]], ':8'))
end)
it('examples from ":help filename-modifiers"', function()
-- src/ cannot be a symlink in this test.
n.api.nvim_set_current_dir(t.paths.test_source_path)
local filename = 'src/version.c'
local cwd = vim.fs.normalize(getcwd())
eq(('%s/src/version.c'):format(cwd), fnamemodify(filename, ':p'))
eq('src/version.c', fnamemodify(filename, ':p:.'))
eq(('%s/src'):format(cwd), fnamemodify(filename, ':p:h'))
eq(cwd, fnamemodify(filename, ':p:h:h'))
eq('version.c', fnamemodify(filename, ':p:t'))
eq(('%s/src/version'):format(cwd), fnamemodify(filename, ':p:r'))
eq(('%s/src/main.c'):format(cwd), fnamemodify(filename, ':s?version?main?:p'))
local converted_cwd = cwd:gsub('/', '\\')
eq(converted_cwd .. '\\src\\version.c', fnamemodify(filename, ':p:gs?/?\\\\?'))
eq('src', fnamemodify(filename, ':h'))
eq('version.c', fnamemodify(filename, ':t'))
eq('src/version', fnamemodify(filename, ':r'))
eq('version', fnamemodify(filename, ':t:r'))
eq('c', fnamemodify(filename, ':e'))
eq('src/main.c', fnamemodify(filename, ':s?version?main?'))
end)
it('advanced examples from ":help filename-modifiers"', function()
local filename = 'src/version.c.gz'
eq('gz', fnamemodify(filename, ':e'))
eq('c.gz', fnamemodify(filename, ':e:e'))
eq('c.gz', fnamemodify(filename, ':e:e:e'))
eq('c', fnamemodify(filename, ':e:e:r'))
eq('src/version.c', fnamemodify(filename, ':r'))
eq('c', fnamemodify(filename, ':r:e'))
eq('src/version', fnamemodify(filename, ':r:r'))
eq('src/version', fnamemodify(filename, ':r:r:r'))
end)
it(':h', function()
-- generic path
eq('.', fnamemodify('hello.txt', ':h'))
-- Repeated ":h" on a bare name: the first ":h" replaces the buffer with ".", the
-- next must re-anchor into it and not read the freed buffer (Coverity CID 649200).
eq('.', fnamemodify('hello.txt', ':h:h'))
eq('.', fnamemodify('hello.txt', ':h:h:h'))
eq('path/to', fnamemodify('path/to/hello.txt', ':h'))
eq('/', fnamemodify('/', ':h'))
eq('/', fnamemodify('/foo', ':h'))
-- collapses more than two leading slashes into a single slash
eq('/', fnamemodify('///', ':h'))
eq('/', fnamemodify('////', ':h'))
eq('/', fnamemodify('///foo', ':h'))
eq('/foo', fnamemodify('///foo/bar', ':h'))
eq('/foo', fnamemodify('///foo////bar', ':h'))
eq('/foo', fnamemodify('////foo/bar', ':h'))
-- preserves exactly two leading slashes
eq('//', fnamemodify('//', ':h'))
if not is_os('win') then
-- POSIX permits special handling for exactly two leading slashes.
eq('//', fnamemodify('//', ':h'))
eq('//', fnamemodify('//foo', ':h'))
eq('//foo', fnamemodify('//foo/bar', ':h'))
eq('//foo', fnamemodify('//foo///bar', ':h'))
else
eq('//server', fnamemodify('//server', ':h'))
eq('//server/share', fnamemodify('//server/share', ':h'))
eq('//server/share/', fnamemodify('//server/share/', ':h'))
eq('//server///share', fnamemodify('//server///share', ':h'))
eq('//server/share/', fnamemodify('//server/share/foo', ':h'))
eq([[//foo/C$]], fnamemodify([[\\foo\C$]], ':h'))
eq([[//foo/C$/]], fnamemodify([[\\foo\C$\]], ':h'))
eq([[//foo/C$/]], fnamemodify([[\\foo\C$\bar]], ':h'))
eq([[//foo/C$/]], fnamemodify([[\\foo\C$\bar]], ':h:h'))
eq([[//foo/C$/]], fnamemodify([[//foo\C$/bar]], ':h'))
-- `C$` is a share name, not a file name
eq('', fnamemodify('//foo/C$/bar', ':h:t'))
eq('C:', fnamemodify('C:foo', ':h'))
eq('C:/', fnamemodify('C:/foo', ':h'))
eq('//?/C:/', fnamemodify('//?/C:/', ':h'))
eq('//?/C:/', fnamemodify('//?/C:/foo', ':h'))
eq(
'//?/Volume{b75e2c83-0000-0000-0000-602f00000000}/',
fnamemodify('//?/Volume{b75e2c83-0000-0000-0000-602f00000000}/foo', ':h')
)
eq(
'//?/Volume{b75e2c83-0000-0000-0000-602f00000000}/',
fnamemodify('///?/Volume{b75e2c83-0000-0000-0000-602f00000000}/foo', ':h')
)
eq('//?/UNC/server', fnamemodify('//?/UNC/server', ':h'))
eq('//?/UNC/server/share', fnamemodify('//?/UNC/server/share', ':h'))
eq('//?/UNC/server/share/', fnamemodify('//?/UNC/server/share/foo', ':h'))
end
end)
it(':t', function()
eq('hello.txt', fnamemodify('hello.txt', ':t'))
eq('hello.txt', fnamemodify('path/to/hello.txt', ':t'))
end)
it(':r', function()
eq('hello', fnamemodify('hello.txt', ':r'))
eq('path/to/hello', fnamemodify('path/to/hello.txt', ':r'))
end)
it(':e', function()
eq('txt', fnamemodify('hello.txt', ':e'))
eq('txt', fnamemodify('path/to/hello.txt', ':e'))
end)
it('regex replacements', function()
eq('content-there-here.txt', fnamemodify('content-here-here.txt', ':s/here/there/'))
eq('content-there-there.txt', fnamemodify('content-here-here.txt', ':gs/here/there/'))
end)
it('shell escape', function()
local expected
if is_os('win') then
-- we expand with double-quotes on Windows
expected = [["hello there! quote ' newline]] .. '\n' .. [["]]
else
expected = [['hello there! quote '\'' newline]] .. '\n' .. [[']]
end
eq(expected, fnamemodify("hello there! quote ' newline\n", ':S'))
end)
it('can combine :e and :r', function()
-- simple, single extension filename
eq('c', fnamemodify('a.c', ':e'))
eq('c', fnamemodify('a.c', ':e:e'))
eq('c', fnamemodify('a.c', ':e:e:r'))
eq('c', fnamemodify('a.c', ':e:e:r:r'))
-- multi extension filename
eq('rb', fnamemodify('a.spec.rb', ':e:r'))
eq('rb', fnamemodify('a.spec.rb', ':e:r:r'))
eq('spec', fnamemodify('a.spec.rb', ':e:e:r'))
eq('spec', fnamemodify('a.spec.rb', ':e:e:r:r'))
eq('spec', fnamemodify('a.b.spec.rb', ':e:e:r'))
eq('b.spec', fnamemodify('a.b.spec.rb', ':e:e:e:r'))
eq('b', fnamemodify('a.b.spec.rb', ':e:e:e:r:r'))
eq('spec', fnamemodify('a.b.spec.rb', ':r:e'))
eq('b', fnamemodify('a.b.spec.rb', ':r:r:e'))
-- extraneous :e expansions
eq('c', fnamemodify('a.b.c.d.e', ':r:r:e'))
eq('b.c', fnamemodify('a.b.c.d.e', ':r:r:e:e'))
-- :e never includes the whole filename, so "a.b":e:e:e --> "b"
eq('b.c', fnamemodify('a.b.c.d.e', ':r:r:e:e:e'))
eq('b.c', fnamemodify('a.b.c.d.e', ':r:r:e:e:e:e'))
end)
end)