mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(lua): swap value params in tbl_extend behavior callback #33847

Browse Source
This commit is contained in:
Maria José Solano
2025-05-04 16:28:03 -05:00
committed by GitHub
parent 0402f5a76b
commit df345503eb
3 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
runtime/doc/lua.txt
View File

@@ -2259,15 +2259,15 @@ vim.tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()*
overwritten instead of merged). overwritten instead of merged).
Parameters: ~ Parameters: ~
• {behavior} (`'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any?): any`) • {behavior} (`'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any`)
Decides what to do if a key is found in more than one map: Decides what to do if a key is found in more than one map:
• "error": raise an error • "error": raise an error
• "keep": use value from the leftmost map • "keep": use value from the leftmost map
• "force": use value from the rightmost map • "force": use value from the rightmost map
• If a function, it receives the current key, value, and • If a function, it receives the current key, the previous
the previous value in the currently merged table (if value in the currently merged table (if present), the
present) and should return the value for the given key current value and should return the value for the given
in the merged table. key in the merged table.
• {...} (`table`) Two or more tables • {...} (`table`) Two or more tables
Return: ~ Return: ~
@@ -2280,15 +2280,15 @@ vim.tbl_extend({behavior}, {...}) *vim.tbl_extend()*
Merges two or more tables. Merges two or more tables.
Parameters: ~ Parameters: ~
• {behavior} (`'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any?): any`) • {behavior} (`'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any`)
Decides what to do if a key is found in more than one map: Decides what to do if a key is found in more than one map:
• "error": raise an error • "error": raise an error
• "keep": use value from the leftmost map • "keep": use value from the leftmost map
• "force": use value from the rightmost map • "force": use value from the rightmost map
• If a function, it receives the current key, value, and • If a function, it receives the current key, the previous
the previous value in the currently merged table (if value in the currently merged table (if present), the
present) and should return the value for the given key current value and should return the value for the given
in the merged table. key in the merged table.
• {...} (`table`) Two or more tables • {...} (`table`) Two or more tables
Return: ~ Return: ~

14
runtime/lua/vim/shared.lua
View File

@@ -366,7 +366,7 @@ local function can_merge(v)
end end
--- Recursive worker for tbl_extend --- Recursive worker for tbl_extend
--- @param behavior 'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any): any --- @param behavior 'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any
--- @param deep_extend boolean --- @param deep_extend boolean
--- @param ... table<any,any> --- @param ... table<any,any>
local function tbl_extend_rec(behavior, deep_extend, ...) local function tbl_extend_rec(behavior, deep_extend, ...)
@@ -382,7 +382,7 @@ local function tbl_extend_rec(behavior, deep_extend, ...)
if deep_extend and can_merge(v) and can_merge(ret[k]) then if deep_extend and can_merge(v) and can_merge(ret[k]) then
ret[k] = tbl_extend_rec(behavior, true, ret[k], v) ret[k] = tbl_extend_rec(behavior, true, ret[k], v)
elseif type(behavior) == 'function' then elseif type(behavior) == 'function' then
ret[k] = behavior(k, v, ret[k]) ret[k] = behavior(k, ret[k], v)
elseif behavior ~= 'force' and ret[k] ~= nil then elseif behavior ~= 'force' and ret[k] ~= nil then
if behavior == 'error' then if behavior == 'error' then
error('key found in more than one map: ' .. k) error('key found in more than one map: ' .. k)
@@ -397,7 +397,7 @@ local function tbl_extend_rec(behavior, deep_extend, ...)
return ret return ret
end end
--- @param behavior 'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any): any --- @param behavior 'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any
--- @param deep_extend boolean --- @param deep_extend boolean
--- @param ... table<any,any> --- @param ... table<any,any>
local function tbl_extend(behavior, deep_extend, ...) local function tbl_extend(behavior, deep_extend, ...)
@@ -427,11 +427,11 @@ end
--- ---
---@see |extend()| ---@see |extend()|
--- ---
---@param behavior 'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any?): any Decides what to do if a key is found in more than one map: ---@param behavior 'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any Decides what to do if a key is found in more than one map:
--- - "error": raise an error --- - "error": raise an error
--- - "keep": use value from the leftmost map --- - "keep": use value from the leftmost map
--- - "force": use value from the rightmost map --- - "force": use value from the rightmost map
--- - If a function, it receives the current key, value, and the previous value in the currently merged table (if present) and should --- - If a function, it receives the current key, the previous value in the currently merged table (if present), the current value and should
--- return the value for the given key in the merged table. --- return the value for the given key in the merged table.
---@param ... table Two or more tables ---@param ... table Two or more tables
---@return table : Merged table ---@return table : Merged table
@@ -450,11 +450,11 @@ end
--- ---
---@generic T1: table ---@generic T1: table
---@generic T2: table ---@generic T2: table
---@param behavior 'error'|'keep'|'force'|fun(key:any, v:any, prev_value:any?): any Decides what to do if a key is found in more than one map: ---@param behavior 'error'|'keep'|'force'|fun(key:any, prev_value:any?, value:any): any Decides what to do if a key is found in more than one map:
--- - "error": raise an error --- - "error": raise an error
--- - "keep": use value from the leftmost map --- - "keep": use value from the leftmost map
--- - "force": use value from the rightmost map --- - "force": use value from the rightmost map
--- - If a function, it receives the current key, value, and the previous value in the currently merged table (if present) and should --- - If a function, it receives the current key, the previous value in the currently merged table (if present), the current value and should
--- return the value for the given key in the merged table. --- return the value for the given key in the merged table.
---@param ... T2 Two or more tables ---@param ... T2 Two or more tables
---@return T1|T2 (table) Merged table ---@return T1|T2 (table) Merged table

4
test/functional/lua/vim_spec.lua
View File

@@ -1040,7 +1040,7 @@ describe('lua stdlib', function()
local a = { a = 1, b = 2, c = 1 } local a = { a = 1, b = 2, c = 1 }
local b = { a = -1, b = 5, c = 3, d = 4 } local b = { a = -1, b = 5, c = 3, d = 4 }
-- Return the maximum value for each key. -- Return the maximum value for each key.
local c = vim.tbl_extend(function(k, v, prev_v) local c = vim.tbl_extend(function(k, prev_v, v)
if prev_v then if prev_v then
return v > prev_v and v or prev_v return v > prev_v and v or prev_v
else else
@@ -1195,7 +1195,7 @@ describe('lua stdlib', function()
local a = { a = 1, b = 2, c = { d = 1, e = -2} } local a = { a = 1, b = 2, c = { d = 1, e = -2} }
local b = { a = -1, b = 5, c = { d = 6 } } local b = { a = -1, b = 5, c = { d = 6 } }
-- Return the maximum value for each key. -- Return the maximum value for each key.
local c = vim.tbl_deep_extend(function(k, v, prev_v) local c = vim.tbl_deep_extend(function(k, prev_v, v)
if prev_v then if prev_v then
return v > prev_v and v or prev_v return v > prev_v and v or prev_v
else else