mirror of
https://github.com/neovim/neovim.git
synced 2025-09-06 03:18:16 +00:00
424f4cc038
## Problem
The pattern used to match indentation is wrong as can be seen in
```lua
-- current pattern doesn't match starting space
print(vim.inspect((" xyz"):match("(^%s+)%S")))
-- nil
-- instead, it matches characters `^ ` in text
print(vim.inspect(("x^ yz"):match("(^%s+)%S")))
-- "^ "
-- indentation could've been matched by, however not required
print(vim.inspect((" xyz"):match("^(%s+)%S")))
-- " "
```
## Solution
We don't even need to modify `base_indent` at every line. If every line's indentation is calculated by the previous line's indentation (which already has starting indentation) added to the starting indentation, we see that indentation is multiplied on every line.
Hence, we only add the starting line indentation to every line.
311 lines
9.1 KiB
Lua
311 lines
9.1 KiB
Lua
---@diagnostic disable: no-unknown
|
|
|
|
local t = require('test.testutil')
|
|
local n = require('test.functional.testnvim')()
|
|
|
|
local buf_lines = n.buf_lines
|
|
local clear = n.clear
|
|
local eq = t.eq
|
|
local exec_lua = n.exec_lua
|
|
local feed = n.feed
|
|
local api = n.api
|
|
local fn = n.fn
|
|
local matches = t.matches
|
|
local pcall_err = t.pcall_err
|
|
local poke_eventloop = n.poke_eventloop
|
|
local retry = t.retry
|
|
|
|
describe('vim.snippet', function()
|
|
before_each(function()
|
|
clear()
|
|
exec_lua(function()
|
|
local function set_snippet_jump(direction, key)
|
|
vim.keymap.set({ 'i', 's' }, key, function()
|
|
if vim.snippet.active({ direction = direction }) then
|
|
return string.format('<Cmd>lua vim.snippet.jump(%d)<CR>', direction)
|
|
else
|
|
return key
|
|
end
|
|
end, { silent = true, expr = true })
|
|
end
|
|
|
|
set_snippet_jump(1, '<Tab>')
|
|
set_snippet_jump(-1, '<S-Tab>')
|
|
end)
|
|
end)
|
|
after_each(clear)
|
|
|
|
--- @param snippet string[]
|
|
--- @param expected string[]
|
|
--- @param settings? string
|
|
--- @param prefix? string
|
|
local function test_expand_success(snippet, expected, settings, prefix)
|
|
if settings then
|
|
exec_lua(settings)
|
|
end
|
|
if prefix then
|
|
feed('i' .. prefix)
|
|
end
|
|
exec_lua('vim.snippet.expand(...)', table.concat(snippet, '\n'))
|
|
eq(expected, buf_lines(0))
|
|
end
|
|
|
|
local function wait_for_pum()
|
|
retry(nil, nil, function()
|
|
eq(1, fn.pumvisible())
|
|
end)
|
|
end
|
|
|
|
--- @param snippet string
|
|
--- @param err string
|
|
local function test_expand_fail(snippet, err)
|
|
matches(err, pcall_err(exec_lua, string.format('vim.snippet.expand("%s")', snippet)))
|
|
end
|
|
|
|
it('adds base indentation to inserted text', function()
|
|
test_expand_success(
|
|
{ 'function $1($2)', ' $0', 'end' },
|
|
{ ' function ()', ' ', ' end' },
|
|
'',
|
|
' '
|
|
)
|
|
end)
|
|
|
|
it('adds indentation based on the start of snippet lines', function()
|
|
local curbuf = api.nvim_get_current_buf()
|
|
|
|
test_expand_success({ 'if $1 then', ' $0', 'end' }, { 'if then', ' ', 'end' })
|
|
|
|
-- Regression test: #29658
|
|
api.nvim_buf_set_lines(curbuf, 0, -1, false, {})
|
|
test_expand_success({ '${1:foo^bar}\n' }, { 'foo^bar', '' })
|
|
|
|
-- Regression test: #30950
|
|
api.nvim_buf_set_lines(curbuf, 0, -1, false, {})
|
|
test_expand_success({ 'a^ b$1', 'b$2', 'd' }, { 'a^ b', 'b', 'd' })
|
|
end)
|
|
|
|
it('replaces tabs with spaces when expandtab is set', function()
|
|
test_expand_success(
|
|
{ 'function $1($2)', '\t$0', 'end' },
|
|
{ 'function ()', ' ', 'end' },
|
|
[[
|
|
vim.o.expandtab = true
|
|
vim.o.shiftwidth = 2
|
|
]]
|
|
)
|
|
end)
|
|
|
|
it('respects tabs when expandtab is not set', function()
|
|
test_expand_success(
|
|
{ 'function $1($2)', '\t$0', 'end' },
|
|
{ 'function ()', '\t', 'end' },
|
|
'vim.o.expandtab = false'
|
|
)
|
|
end)
|
|
|
|
it('inserts known variable value', function()
|
|
test_expand_success({ '; print($TM_CURRENT_LINE)' }, { 'foo; print(foo)' }, nil, 'foo')
|
|
end)
|
|
|
|
it('uses default when variable is not set', function()
|
|
test_expand_success({ 'print(${TM_CURRENT_WORD:foo})' }, { 'print(foo)' })
|
|
end)
|
|
|
|
it('replaces unknown variables by placeholders', function()
|
|
test_expand_success({ 'print($UNKNOWN)' }, { 'print(UNKNOWN)' })
|
|
end)
|
|
|
|
it('does not jump outside snippet range', function()
|
|
test_expand_success({ 'function $1($2)', ' $0', 'end' }, { 'function ()', ' ', 'end' })
|
|
eq(false, exec_lua('return vim.snippet.active({ direction = -1 })'))
|
|
feed('<Tab><Tab>i')
|
|
eq(false, exec_lua('return vim.snippet.active( { direction = 1 })'))
|
|
end)
|
|
|
|
it('navigates backwards', function()
|
|
test_expand_success({ 'function $1($2) end' }, { 'function () end' })
|
|
feed('<Tab><S-Tab>foo')
|
|
eq({ 'function foo() end' }, buf_lines(0))
|
|
end)
|
|
|
|
it('visits all tabstops', function()
|
|
local function cursor()
|
|
return exec_lua('return vim.api.nvim_win_get_cursor(0)')
|
|
end
|
|
|
|
test_expand_success({ 'function $1($2)', ' $0', 'end' }, { 'function ()', ' ', 'end' })
|
|
eq({ 1, 9 }, cursor())
|
|
feed('<Tab>')
|
|
eq({ 1, 10 }, cursor())
|
|
feed('<Tab>')
|
|
eq({ 2, 2 }, cursor())
|
|
end)
|
|
|
|
it('syncs text of tabstops with equal indexes', function()
|
|
test_expand_success({ 'var double = ${1:x} + ${1:x}' }, { 'var double = x + x' })
|
|
feed('123')
|
|
eq({ 'var double = 123 + 123' }, buf_lines(0))
|
|
end)
|
|
|
|
it('cancels session with changes outside the snippet', function()
|
|
test_expand_success({ 'print($1)' }, { 'print()' })
|
|
feed('<Esc>O-- A comment')
|
|
eq(false, exec_lua('return vim.snippet.active()'))
|
|
eq({ '-- A comment', 'print()' }, buf_lines(0))
|
|
end)
|
|
|
|
it('handles non-consecutive tabstops', function()
|
|
test_expand_success({ 'class $1($3) {', ' $0', '}' }, { 'class () {', ' ', '}' })
|
|
feed('Foo') -- First tabstop
|
|
feed('<Tab><Tab>') -- Jump to $0
|
|
feed('// Inside') -- Insert text
|
|
eq({ 'class Foo() {', ' // Inside', '}' }, buf_lines(0))
|
|
end)
|
|
|
|
it('handles multiline placeholders', function()
|
|
test_expand_success(
|
|
{ 'public void foo() {', ' ${0:// TODO Auto-generated', ' throw;}', '}' },
|
|
{ 'public void foo() {', ' // TODO Auto-generated', ' throw;', '}' }
|
|
)
|
|
end)
|
|
|
|
it('inserts placeholder in all tabstops when the first tabstop has the placeholder', function()
|
|
test_expand_success(
|
|
{ 'for (${1:int} ${2:x} = ${3:0}; $2 < ${4:N}; $2++) {', ' $0', '}' },
|
|
{ 'for (int x = 0; x < N; x++) {', ' ', '}' }
|
|
)
|
|
end)
|
|
|
|
it('inserts placeholder in all tabstops when a later tabstop has the placeholder', function()
|
|
test_expand_success(
|
|
{ 'for (${1:int} $2 = ${3:0}; ${2:x} < ${4:N}; $2++) {', ' $0', '}' },
|
|
{ 'for (int x = 0; x < N; x++) {', ' ', '}' }
|
|
)
|
|
end)
|
|
|
|
it('errors with multiple placeholders for the same index', function()
|
|
test_expand_fail(
|
|
'class ${1:Foo} { void ${1:foo}() {} }',
|
|
'multiple placeholders for tabstop $1'
|
|
)
|
|
end)
|
|
|
|
it('errors with multiple $0 tabstops', function()
|
|
test_expand_fail('function $1() { $0 }$0', 'multiple $0 tabstops')
|
|
end)
|
|
|
|
it('cancels session when deleting the snippet', function()
|
|
test_expand_success(
|
|
{ 'local function $1()', ' $0', 'end' },
|
|
{ 'local function ()', ' ', 'end' }
|
|
)
|
|
feed('<esc>Vjjd')
|
|
eq(false, exec_lua('return vim.snippet.active()'))
|
|
end)
|
|
|
|
it('cancels session when inserting outside snippet region', function()
|
|
feed('i<cr>')
|
|
test_expand_success(
|
|
{ 'local function $1()', ' $0', 'end' },
|
|
{ '', 'local function ()', ' ', 'end' }
|
|
)
|
|
feed('<esc>O-- A comment')
|
|
eq(false, exec_lua('return vim.snippet.active()'))
|
|
end)
|
|
|
|
it('inserts choice', function()
|
|
test_expand_success({ 'console.${1|assert,log,error|}()' }, { 'console.()' })
|
|
wait_for_pum()
|
|
feed('<Down><C-y>')
|
|
eq({ 'console.log()' }, buf_lines(0))
|
|
end)
|
|
|
|
it('closes the choice completion menu when jumping', function()
|
|
test_expand_success({ 'console.${1|assert,log,error|}($2)' }, { 'console.()' })
|
|
wait_for_pum()
|
|
exec_lua('vim.snippet.jump(1)')
|
|
eq(0, fn.pumvisible())
|
|
end)
|
|
|
|
it('jumps to next tabstop after inserting choice', function()
|
|
test_expand_success(
|
|
{ '${1|public,protected,private|} function ${2:name}() {', '\t$0', '}' },
|
|
{ ' function name() {', '\t', '}' }
|
|
)
|
|
wait_for_pum()
|
|
feed('<C-y><Tab>')
|
|
poke_eventloop()
|
|
feed('foo')
|
|
eq({ 'public function foo() {', '\t', '}' }, buf_lines(0))
|
|
end)
|
|
|
|
it('jumps through adjacent tabstops', function()
|
|
test_expand_success(
|
|
{ 'for i=1,${1:to}${2:,step} do\n\t$3\nend' },
|
|
{ 'for i=1,to,step do', '\t', 'end' }
|
|
)
|
|
feed('10')
|
|
feed('<Tab>')
|
|
poke_eventloop()
|
|
feed(',2')
|
|
eq({ 'for i=1,10,2 do', '\t', 'end' }, buf_lines(0))
|
|
end)
|
|
|
|
it('updates snippet state when built-in completion menu is visible', function()
|
|
test_expand_success({ '$1 = function($2)\nend' }, { ' = function()', 'end' })
|
|
-- Show the completion menu.
|
|
feed('<C-n>')
|
|
-- Make sure no item is selected.
|
|
feed('<C-p>')
|
|
-- Jump forward (the 2nd tabstop).
|
|
exec_lua('vim.snippet.jump(1)')
|
|
feed('foo')
|
|
eq({ ' = function(foo)', 'end' }, buf_lines(0))
|
|
end)
|
|
|
|
it('correctly indents with newlines', function()
|
|
local curbuf = api.nvim_get_current_buf()
|
|
test_expand_success(
|
|
{ 'function($2)\n\t$3\nend' },
|
|
{ 'function()', ' ', 'end' },
|
|
[[
|
|
vim.opt.sw = 2
|
|
vim.opt.expandtab = true
|
|
]]
|
|
)
|
|
api.nvim_buf_set_lines(curbuf, 0, -1, false, {})
|
|
test_expand_success(
|
|
{ 'function($2)\n$3\nend' },
|
|
{ 'function()', '', 'end' },
|
|
[[
|
|
vim.opt.sw = 2
|
|
vim.opt.expandtab = true
|
|
]]
|
|
)
|
|
api.nvim_buf_set_lines(curbuf, 0, -1, false, {})
|
|
test_expand_success(
|
|
{ 'func main() {\n\t$1\n}' },
|
|
{ 'func main() {', '\t', '}' },
|
|
[[
|
|
vim.opt.sw = 4
|
|
vim.opt.ts = 4
|
|
vim.opt.expandtab = false
|
|
]]
|
|
)
|
|
api.nvim_buf_set_lines(curbuf, 0, -1, false, {})
|
|
test_expand_success(
|
|
{ '${1:name} :: ${2}\n${1:name} ${3}= ${0:undefined}' },
|
|
{
|
|
'name :: ',
|
|
'name = undefined',
|
|
},
|
|
[[
|
|
vim.opt.sw = 4
|
|
vim.opt.ts = 4
|
|
vim.opt.expandtab = false
|
|
]]
|
|
)
|
|
end)
|
|
end)
|