feat: add type annotations for plenary.run

nvim-lua · Apr 4, 2024 · 233246f · 233246f
1 parent f37156b
commit 233246f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/lua/plenary/init.lua b/lua/plenary/init.lua
@@ -15,6 +15,7 @@
 ---@field operators PlenaryOperators
 ---@field path PlenaryPath
 ---@field reload PlenaryReload
+---@field run PlenaryRun
 ---@field scandir PlenaryScandir
 ---@field strings PlenaryStrings
 ---@field tbl PlenaryTbl

diff --git a/lua/plenary/run.lua b/lua/plenary/run.lua
@@ -1,7 +1,13 @@
 local floatwin = require "plenary.window.float"
 
+---@class PlenaryRun
 local run = {}
 
+---@param title_text string[]
+---@param cmd string|string[]
+---@param opts? any
+---@return integer bufnr
+---@return integer win_id
 run.with_displayed_output = function(title_text, cmd, opts)
   local views = floatwin.centered_with_top_win(title_text)