docs: document validator combinators

refactor!: soft-deprecate `compose` combinator

Author: willothy

docs/pages/docs/components/form.mdx

@@ -38,14 +38,14 @@ n.form(
 
 #### on_submit
 
-<Property 
+<Property
   defaultValue="fn.ignore"
   types={['fun(is_valid: boolean): nil']}
 />
 
 #### submit_key
 
-<Property 
+<Property
   defaultValue="<C-CR>"
   types={['string[]', 'string']}
 />
@@ -63,4 +63,11 @@ Available validation functions:
 - `equals`
 - `contains`
 
+Available combinators:
+
+- `all`: ensures all validators pass
+- `any`: ensures at least one validator passes
+- `none`: ensures no validators pass
+- `compose` (deprecated, use `all`)
+
 

lua/nui-components/validators.lua

@@ -1,11 +1,13 @@
 local M = {}
 
+---@type fun(min: integer): fun(arg: string): boolean
 function M.min_length(min)
   return function(arg)
     return #arg >= min
   end
 end
 
+---@type fun(arg: string): boolean
 M.is_not_empty = M.min_length(1)
 
 function M.max_length(max)
@@ -14,32 +16,21 @@ function M.max_length(max)
   end
 end
 
+---@type fun(pattern: string): fun(arg: string): boolean
 function M.contains(pattern)
   return function(arg)
-    return string.find(arg, pattern)
+    return string.find(arg, pattern) ~= nil
   end
 end
 
+---@type fun(value: any): fun(arg: any): boolean
 function M.equals(value)
   return function(arg)
     return vim.deep_equal(value, arg)
   end
 end
 
-function M.compose(...)
-  local tbl = { ... }
-
-  return function(value)
-    for _, fn in ipairs(tbl) do
-      if not fn(value) then
-        return false
-      end
-    end
-
-    return true
-  end
-end
-
+---@type fun(...: fun(arg: any): boolean): fun(arg: any): boolean
 function M.none(...)
   local validators = { ... }
   return function(value)
@@ -52,6 +43,7 @@ function M.none(...)
   end
 end
 
+---@type fun(...: fun(arg: any): boolean): fun(arg: any): boolean
 function M.any(...)
   local validators = { ... }
   return function(value)
@@ -64,7 +56,8 @@ function M.any(...)
   end
 end
 
-function M.all(...)
+---@type fun(...: fun(arg: any): boolean): fun(arg: any): boolean
+local function all(...)
   local validators = { ... }
 
   return function(value)
@@ -78,4 +71,8 @@ function M.all(...)
   end
 end
 
+M.all = all
+
+M.compose = all
+
 return M