feat: add type annotations for plenary.operators

Author: delphinus

lua/plenary/init.lua

@@ -12,6 +12,7 @@
 ---@field json PlenaryJson
 ---@field log PlenaryLog
 ---@field nvim_meta PlenaryNvimMeta
+---@field operators PlenaryOperators
 ---@field path PlenaryPath
 ---@field scandir PlenaryScandir
 ---@field strings PlenaryStrings

lua/plenary/operators.lua

@@ -4,7 +4,8 @@
 ---Lua has no currying so we have to make a function for each operator.
 ---@brief ]]
 
-return {
+---@class PlenaryOperators
+local M = {
   ----------------------------------------------------------------------------
   -- Comparison operators
   ----------------------------------------------------------------------------
@@ -30,15 +31,27 @@ return {
   ----------------------------------------------------------------------------
   -- Arithmetic operators
   ----------------------------------------------------------------------------
+  ---@param a number
+  ---@param b number
+  ---@return number
   add = function(a, b)
     return a + b
   end,
+  ---@param a number
+  ---@param b number
+  ---@return number
   div = function(a, b)
     return a / b
   end,
+  ---@param a number
+  ---@param b number
+  ---@return integer
   floordiv = function(a, b)
     return math.floor(a / b)
   end,
+  ---@param a number
+  ---@param b number
+  ---@return integer
   intdiv = function(a, b)
     local q = a / b
     if a >= 0 then
@@ -47,54 +60,92 @@ return {
       return math.ceil(q)
     end
   end,
+  ---@param a number
+  ---@param b number
+  ---@return number
   mod = function(a, b)
     return a % b
   end,
+  ---@param a number
+  ---@param b number
+  ---@return number
   mul = function(a, b)
     return a * b
   end,
+  ---@param a number
+  ---@return number
   neq = function(a)
     return -a
   end,
+  ---@param a number
+  ---@return number
   unm = function(a)
     return -a
   end, -- an alias
+  ---@param a number
+  ---@param b number
+  ---@return number
   pow = function(a, b)
     return a ^ b
   end,
+  ---@param a number
+  ---@param b number
+  ---@return number
   sub = function(a, b)
     return a - b
   end,
+  ---@param a number
+  ---@param b number
+  ---@return number
   truediv = function(a, b)
     return a / b
   end,
 
   ----------------------------------------------------------------------------
   -- String operators
   ----------------------------------------------------------------------------
+  ---@param a string
+  ---@param b string
+  ---@return string
   concat = function(a, b)
     return a .. b
   end,
+  ---@param a string
+  ---@return integer
   len = function(a)
     return #a
   end,
+  ---@param a string
+  ---@return integer
   length = function(a)
     return #a
   end, -- an alias
 
   ----------------------------------------------------------------------------
   -- Logical operators
   ----------------------------------------------------------------------------
+  ---@param a boolean
+  ---@param b boolean
+  ---@return boolean
   land = function(a, b)
     return a and b
   end,
+  ---@param a boolean
+  ---@param b boolean
+  ---@return boolean
   lor = function(a, b)
     return a or b
   end,
+  ---@param a boolean
+  ---@return boolean
   lnot = function(a)
     return not a
   end,
+  ---@param a boolean
+  ---@return boolean
   truth = function(a)
     return not not a
   end,
 }
+
+return M