diff options
| -rw-r--r-- | runtime/doc/lua.txt | 14 | ||||
| -rw-r--r-- | runtime/lua/vim/shared.lua | 55 |
2 files changed, 39 insertions, 30 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 8e2270bc58..a70677cb66 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1641,7 +1641,7 @@ gsplit({s}, {sep}, {plain}) *vim.gsplit()* string.find) Return: ~ - (function) Iterator over the split components + fun():string Iterator over the split components See also: ~ |vim.split()| @@ -1684,7 +1684,7 @@ list_slice({list}, {start}, {finish}) *vim.list_slice()* • {finish} (number) End range of slice Return: ~ - (table) Copy of table sliced from start to finish (inclusive) + any[] Copy of table sliced from start to finish (inclusive) pesc({s}) *vim.pesc()* Escapes magic chars in |lua-patterns|. @@ -1724,7 +1724,7 @@ split({s}, {sep}, {kwargs}) *vim.split()* front and back of the list Return: ~ - (table) List of split components + string[] List of split components startswith({s}, {prefix}) *vim.startswith()* Tests if `s` starts with `prefix`. @@ -1787,7 +1787,7 @@ tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()* • {...} (table) Two or more map-like tables Return: ~ - (table) Merged table + table|table Merged table See also: ~ |vim.tbl_extend()| @@ -1817,7 +1817,7 @@ tbl_filter({func}, {t}) *vim.tbl_filter()* • {t} (table) Table Return: ~ - (table) Table of filtered values + any[] Table of filtered values tbl_flatten({t}) *vim.tbl_flatten()* Creates a copy of a list-like table such that any nested tables are @@ -1883,7 +1883,7 @@ tbl_keys({t}) *vim.tbl_keys()* • {t} (table) Table Return: ~ - (table) List of keys + table[] List of keys See also: ~ From https://github.com/premake/premake-core/blob/master/src/base/table.lua @@ -1906,7 +1906,7 @@ tbl_values({t}) *vim.tbl_values()* • {t} (table) Table Return: ~ - (table) List of values + any[] List of values trim({s}) *vim.trim()* Trim whitespace (Lua pattern "%s") from both sides of a string. diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua index 63a932479e..1d0a6d5406 100644 --- a/runtime/lua/vim/shared.lua +++ b/runtime/lua/vim/shared.lua @@ -14,8 +14,9 @@ local vim = vim or {} --- same functions as those in the input table. Userdata and threads are not --- copied and will throw an error. --- ----@param orig table Table to copy ----@return table Table of copied keys and (nested) values. +---@generic T: table +---@param orig T Table to copy +---@return T Table of copied keys and (nested) values. function vim.deepcopy(orig) end -- luacheck: no unused vim.deepcopy = (function() local function _id(v) @@ -62,7 +63,7 @@ end)() ---@param s string String to split ---@param sep string Separator or pattern ---@param plain boolean If `true` use `sep` literally (passed to string.find) ----@return function Iterator over the split components +---@return fun():string Iterator over the split components function vim.gsplit(s, sep, plain) vim.validate({ s = { s, 's' }, sep = { sep, 's' }, plain = { plain, 'b', true } }) @@ -111,11 +112,11 @@ end --- ---@param s string String to split ---@param sep string Separator or pattern ----@param kwargs split_kwargs Keyword arguments: +---@param kwargs {plain: boolean, trimempty: boolean}|nil Keyword arguments: --- - plain: (boolean) If `true` use `sep` literally (passed to string.find) --- - trimempty: (boolean) If `true` remove empty items from the front --- and back of the list ----@return table List of split components +---@return string[] List of split components function vim.split(s, sep, kwargs) local plain local trimempty = false @@ -158,8 +159,9 @@ end --- ---@see From https://github.com/premake/premake-core/blob/master/src/base/table.lua --- ----@param t table Table ----@return table List of keys +---@param t table<T, any> Table +---@generic T: table +---@return T[] List of keys function vim.tbl_keys(t) assert(type(t) == 'table', string.format('Expected table, got %s', type(t))) @@ -173,8 +175,9 @@ end --- Return a list of all values used in a table. --- However, the order of the return table of values is not guaranteed. --- ----@param t table Table ----@return table List of values +---@generic T +---@param t table<any, T> Table +---@return T[] List of values function vim.tbl_values(t) assert(type(t) == 'table', string.format('Expected table, got %s', type(t))) @@ -187,8 +190,9 @@ end --- Apply a function to all values of a table. --- ----@param func function|table Function or callable table ----@param t table Table +---@generic T +---@param func fun(value: T): any Function +---@param t table<any, T> Table ---@return table Table of transformed values function vim.tbl_map(func, t) vim.validate({ func = { func, 'c' }, t = { t, 't' } }) @@ -202,9 +206,10 @@ end --- Filter a table using a predicate function --- ----@param func function|table Function or callable table ----@param t table Table ----@return table Table of filtered values +---@generic T +---@param func fun(value: T): boolean Function +---@param t table<any, T> Table +---@return T[] Table of filtered values function vim.tbl_filter(func, t) vim.validate({ func = { func, 'c' }, t = { t, 't' } }) @@ -306,12 +311,14 @@ end --- ---@see |vim.tbl_extend()| --- ----@param behavior string Decides what to do if a key is found in more than one map: +---@generic T1: table +---@generic T2: table +---@param behavior "error"|"keep"|"force" Decides what to do if a key is found in more than one map: --- - "error": raise an error --- - "keep": use value from the leftmost map --- - "force": use value from the rightmost map ----@param ... table Two or more map-like tables ----@return table Merged table +---@param ... T2 Two or more map-like tables +---@return T1|T2 Merged table function vim.tbl_deep_extend(behavior, ...) return tbl_extend(behavior, true, ...) end @@ -407,11 +414,12 @@ end --- ---@see |vim.tbl_extend()| --- ----@param dst table List which will be modified and appended to +---@generic T: table +---@param dst T List which will be modified and appended to ---@param src table List from which values will be inserted ----@param start number Start index on src. Defaults to 1 ----@param finish number Final index on src. Defaults to `#src` ----@return table dst +---@param start number|nil Start index on src. Defaults to 1 +---@param finish number|nil Final index on src. Defaults to `#src` +---@return T dst function vim.list_extend(dst, src, start, finish) vim.validate({ dst = { dst, 't' }, @@ -506,10 +514,11 @@ end --- Creates a copy of a table containing only elements from start to end (inclusive) --- ----@param list table Table +---@generic T +---@param list T[] Table ---@param start number Start range of slice ---@param finish number End range of slice ----@return table Copy of table sliced from start to finish (inclusive) +---@return T[] Copy of table sliced from start to finish (inclusive) function vim.list_slice(list, start, finish) local new_list = {} for i = start or 1, finish or #list do |