refactor(api)!: rename Dictionary => Dict

In the api_info() output:

    :new|put =map(filter(api_info().functions, '!has_key(v:val,''deprecated_since'')'), 'v:val')
    ...

    {'return_type': 'ArrayOf(Integer, 2)', 'name': 'nvim_win_get_position', 'method': v:true, 'parameters': [['Window', 'window']], 'since': 1}

The `ArrayOf(Integer, 2)` return type didn't break clients when we added
it, which is evidence that clients don't use the `return_type` field,
thus renaming Dictionary => Dict in api_info() is not (in practice)
a breaking change.
This commit is contained in:
Justin M. Keyes
2024-09-20 07:34:50 +02:00
parent 5acdc4499e
commit 737f58e232
77 changed files with 606 additions and 622 deletions

View File

@@ -38,7 +38,7 @@ describe('b:changedtick', function()
-- Somehow undo counts as two changes
eq(5, changedtick())
end)
it('is present in b: dictionary', function()
it('is present in b: dict', function()
eq(2, changedtick())
command('let d = b:')
eq(2, api.nvim_get_var('d').changedtick)
@@ -168,7 +168,7 @@ describe('b:changedtick', function()
)
eq(2, changedtick())
end)
it('does not inherit VAR_FIXED when copying dictionary over', function()
it('does not inherit VAR_FIXED when copying dict over', function()
eq(2, changedtick())
eq('', exec_capture('let d1 = copy(b:)|let d1.changedtick = 42'))
eq('', exec_capture('let d2 = copy(b:)|unlet d2.changedtick'))

View File

@@ -295,7 +295,7 @@ describe('context functions', function()
eq(outofbounds, pcall_err(call, 'ctxget', 0))
end)
it('returns context dictionary at index in context stack', function()
it('returns context dict at index in context stack', function()
feed('i1<cr>2<cr>3<c-[>ddddddqahjklq')
command('edit! ' .. fname1)
feed('G')
@@ -404,7 +404,7 @@ describe('context functions', function()
eq(outofbounds, pcall_err(call, 'ctxset', { dummy = 1 }, 0))
end)
it('errors when context dictionary is invalid', function()
it('errors when context dict is invalid', function()
call('ctxpush')
eq(
'Vim:E474: Failed to convert list to msgpack string buffer',
@@ -412,7 +412,7 @@ describe('context functions', function()
)
end)
it('sets context dictionary at index in context stack', function()
it('sets context dict at index in context stack', function()
api.nvim_set_var('one', 1)
api.nvim_set_var('Two', 2)
api.nvim_set_var('THREE', 3)

View File

@@ -108,7 +108,7 @@ describe('input()', function()
{T:1}^ |
]])
end)
it('allows unequal numeric values when using {opts} dictionary', function()
it('allows unequal numeric values when using {opts} dict', function()
command('echohl Test')
api.nvim_set_var('opts', { prompt = 1, default = 2, cancelreturn = 3 })
feed([[:echo input(opts)<CR>]])
@@ -164,7 +164,7 @@ describe('input()', function()
reset = true,
}
end)
it('allows omitting everything with dictionary argument', function()
it('allows omitting everything with dict argument', function()
command('echohl Test')
feed([[:call input({})<CR>]])
screen:expect([[
@@ -290,7 +290,7 @@ describe('inputdialog()', function()
{T:1}^ |
]])
end)
it('allows unequal numeric values when using {opts} dictionary', function()
it('allows unequal numeric values when using {opts} dict', function()
command('echohl Test')
api.nvim_set_var('opts', { prompt = 1, default = 2, cancelreturn = 3 })
feed([[:echo input(opts)<CR>]])
@@ -346,7 +346,7 @@ describe('inputdialog()', function()
reset = true,
}
end)
it('allows omitting everything with dictionary argument', function()
it('allows omitting everything with dict argument', function()
command('echohl Test')
feed(':echo inputdialog({})<CR>')
screen:expect([[

View File

@@ -911,7 +911,7 @@ describe('json_encode() function', function()
eq('[]', eval('json_encode(v:_null_list)'))
end)
it('can dump NULL dictionary', function()
it('can dump NULL dict', function()
eq('{}', eval('json_encode(v:_null_dict)'))
end)

View File

@@ -36,7 +36,7 @@ describe('maparg()', function()
lnum = 0,
}
it('returns a dictionary', function()
it('returns a dict', function()
command('nnoremap foo bar')
eq('bar', fn.maparg('foo'))
eq(foo_bar_map_table, fn.maparg('foo', 'n', false, true))
@@ -54,7 +54,7 @@ describe('maparg()', function()
eq('', fn.maparg('not a mapping'))
end)
it('returns an empty dictionary when no map is present and dict is requested', function()
it('returns an empty dict when no map is present and dict is requested', function()
eq({}, fn.maparg('not a mapping', 'n', false, true))
end)

View File

@@ -437,16 +437,16 @@ describe('msgpackparse() function', function()
parse_eq({ 'ab' }, { '\196\002ab' })
end)
it('restores FIXEXT1 as special dictionary', function()
it('restores FIXEXT1 as special dict', function()
parse_eq({ { _TYPE = {}, _VAL = { 0x10, { '', '' } } } }, { '\212\016', '' })
eq(1, eval('g:parsed[0]._TYPE is v:msgpack_types.ext'))
end)
it('restores MAP with BIN key as ordinary dictionary', function()
it('restores MAP with BIN key as ordinary dict', function()
parse_eq({ { a = '' } }, { '\129\196\001a\196\n' })
end)
it('restores MAP with duplicate STR keys as special dictionary', function()
it('restores MAP with duplicate STR keys as special dict', function()
command('let dumped = ["\\x82\\xA1a\\xC4\\n\\xA1a\\xC4\\n"]')
-- FIXME Internal error bug, can't use parse_eq() here
command('silent! let parsed = msgpackparse(dumped)')
@@ -464,7 +464,7 @@ describe('msgpackparse() function', function()
eq(eval('v:t_string'), eval('type(g:parsed[0]._VAL[1][0])'))
end)
it('restores MAP with MAP key as special dictionary', function()
it('restores MAP with MAP key as special dict', function()
parse_eq({ { _TYPE = {}, _VAL = { { {}, '' } } } }, { '\129\128\196\n' })
eq(1, eval('g:parsed[0]._TYPE is v:msgpack_types.map'))
end)
@@ -510,7 +510,7 @@ describe('msgpackparse() function', function()
)
end)
it('fails to parse a dictionary', function()
it('fails to parse a dict', function()
eq(
'Vim(call):E899: Argument of msgpackparse() must be a List or Blob',
exc_exec('call msgpackparse({})')
@@ -764,7 +764,7 @@ describe('msgpackdump() function', function()
)
end)
it('fails to dump a dictionary', function()
it('fails to dump a dict', function()
eq('Vim(call):E686: Argument of msgpackdump() must be a List', exc_exec('call msgpackdump({})'))
end)
@@ -813,7 +813,7 @@ describe('msgpackdump() function', function()
eq({ '\144' }, eval('msgpackdump([v:_null_list])'))
end)
it('can dump NULL dictionary', function()
it('can dump NULL dict', function()
eq({ '\128' }, eval('msgpackdump([v:_null_dict])'))
end)
end)

View File

@@ -170,9 +170,9 @@ describe('string() function', function()
)
end)
it('does not show errors when dumping partials referencing the same dictionary', function()
it('does not show errors when dumping partials referencing the same dict', function()
command('let d = {}')
-- Regression for “eval/typval_encode: Dump empty dictionary before
-- Regression for “eval/typval_encode: Dump empty dict before
-- checking for refcycle”, results in error.
eq(
"[function('tr', {}), function('tr', {})]",
@@ -256,7 +256,7 @@ describe('string() function', function()
end)
describe('used to represent dictionaries', function()
it('dumps empty dictionary', function()
it('dumps empty dict', function()
eq('{}', eval('string({})'))
end)
@@ -267,7 +267,7 @@ describe('string() function', function()
eq("[{}, function('tr', {})]", eval('string([d, function("tr", d)])'))
end)
it('dumps non-empty dictionary', function()
it('dumps non-empty dict', function()
eq("{'t''est': 1}", fn.string({ ["t'est"] = 1 }))
end)