refactor(ALL): unify error handling and type checking

Details:
- Uniformly use same `H.error` helper.
- Switch from `vim.validate` for type checking to custom helper. This is
  mostly due to Neovim>=0.11 changing `vim.validate` signature from
  a table for multiple targets to several arguments for single taget.
  Although it is backwards compatible until Neovim 1.0, it already now
  generates `:checkhealth` warnings. As creating backwards compatible
  `vim.validate` wrappers is even more lines, using own helper with the
  similar signature as Neovim>=0.11 seems to be ok.
  Notes:
  - As a positive side effect, errors are prepended with "(mini.xxx)"
    prefix.
  - In cases when `vim.validate` is used with function predicate, apply
    it directly and use `H.error` on `false`. This resulted in extra
    line-removing diff.

Author: echasnovski

lua/mini/ai.lua

@@ -1132,29 +1132,24 @@ H.ns_id = {
 -- Helper functionality =======================================================
 -- Settings -------------------------------------------------------------------
 H.setup_config = function(config)
-  -- General idea: if some table elements are not present in user-supplied
-  -- `config`, take them from default config
-  vim.validate({ config = { config, 'table', true } })
+  H.check_type('config', config, 'table', true)
   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
 
-  vim.validate({
-    custom_textobjects = { config.custom_textobjects, 'table', true },
-    mappings = { config.mappings, 'table' },
-    n_lines = { config.n_lines, 'number' },
-    search_method = { config.search_method, H.is_search_method },
-    silent = { config.silent, 'boolean' },
-  })
+  H.check_type('custom_textobjects', config.custom_textobjects, 'table', true)
 
-  vim.validate({
-    ['mappings.around'] = { config.mappings.around, 'string' },
-    ['mappings.inside'] = { config.mappings.inside, 'string' },
-    ['mappings.around_next'] = { config.mappings.around_next, 'string' },
-    ['mappings.inside_next'] = { config.mappings.inside_next, 'string' },
-    ['mappings.around_last'] = { config.mappings.around_last, 'string' },
-    ['mappings.inside_last'] = { config.mappings.inside_last, 'string' },
-    ['mappings.goto_left'] = { config.mappings.goto_left, 'string' },
-    ['mappings.goto_right'] = { config.mappings.goto_right, 'string' },
-  })
+  H.check_type('mappings', config.mappings, 'table')
+  H.check_type('mappings.around', config.mappings.around, 'string')
+  H.check_type('mappings.inside', config.mappings.inside, 'string')
+  H.check_type('mappings.around_next', config.mappings.around_next, 'string')
+  H.check_type('mappings.inside_next', config.mappings.inside_next, 'string')
+  H.check_type('mappings.around_last', config.mappings.around_last, 'string')
+  H.check_type('mappings.inside_last', config.mappings.inside_last, 'string')
+  H.check_type('mappings.goto_left', config.mappings.goto_left, 'string')
+  H.check_type('mappings.goto_right', config.mappings.goto_right, 'string')
+
+  H.check_type('n_lines', config.n_lines, 'number')
+  H.validate_search_method(config.search_method, 'search_method')
+  H.check_type('silent', config.silent, 'boolean')
 
   return config
 end
@@ -1956,6 +1951,13 @@ H.get_visual_region = function()
 end
 
 -- Utilities ------------------------------------------------------------------
+H.error = function(msg) error('(mini.ai) ' .. msg, 0) end
+
+H.check_type = function(name, val, ref, allow_nil)
+  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
+  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
+end
+
 H.echo = function(msg, is_important)
   if H.get_config().silent then return end
 
@@ -1984,8 +1986,6 @@ end
 
 H.message = function(msg) H.echo(msg, true) end
 
-H.error = function(msg) error(string.format('(mini.ai) %s', msg), 0) end
-
 H.map = function(mode, lhs, rhs, opts)
   if lhs == '' then return end
   opts = vim.tbl_deep_extend('force', { silent = true }, opts or {})

lua/mini/align.lua

@@ -1316,23 +1316,23 @@ H.indent_functions = {
 -- Helper functionality =======================================================
 -- Settings -------------------------------------------------------------------
 H.setup_config = function(config)
-  -- General idea: if some table elements are not present in user-supplied
-  -- `config`, take them from default config
-  vim.validate({ config = { config, 'table', true } })
+  H.check_type('config', config, 'table', true)
   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
 
-  vim.validate({
-    mappings = { config.mappings, 'table' },
-    modifiers = { config.modifiers, H.is_valid_modifiers },
-    steps = { config.steps, H.is_valid_steps },
-    options = { config.options, 'table' },
-    silent = { config.silent, 'boolean' },
-  })
+  H.check_type('mappings', config.mappings, 'table')
+  H.check_type('mappings.start', config.mappings.start, 'string')
+  H.check_type('mappings.start_with_preview', config.mappings.start_with_preview, 'string')
 
-  vim.validate({
-    ['mappings.start'] = { config.mappings.start, 'string' },
-    ['mappings.start_with_preview'] = { config.mappings.start_with_preview, 'string' },
-  })
+  H.check_type('modifiers', config.modifiers, 'table')
+  for k, v in pairs(config.modifiers) do
+    if not vim.is_callable(v) then
+      H.error(string.format('`modifiers[%s]` should be callable.', vim.inspect(k)))
+    end
+  end
+
+  H.validate_steps(config.steps, 'steps')
+  H.check_type('options', config.options, 'table')
+  H.check_type('silent', config.silent, 'boolean')
 
   return config
 end
@@ -1616,19 +1616,6 @@ H.default_action_merge = function(parts, opts)
 end
 
 -- Work with modifiers --------------------------------------------------------
-H.is_valid_modifiers = function(x, x_name)
-  x_name = x_name or 'config.modifiers'
-
-  if type(x) ~= 'table' then return false, string.format('`%s` should be table.', x_name) end
-  for k, v in pairs(x) do
-    if not vim.is_callable(v) then
-      return false, string.format('`%s[%s]` should be callable.', x_name, vim.inspect(k))
-    end
-  end
-
-  return true
-end
-
 H.make_filter_action = function(expr)
   if expr == nil then return nil end
   if expr == '' then expr = 'true' end
@@ -1932,6 +1919,13 @@ H.set_lines = function(start_row, end_row, replacement)
 end
 
 -- Utilities ------------------------------------------------------------------
+H.error = function(msg) error('(mini.align) ' .. msg, 0) end
+
+H.check_type = function(name, val, ref, allow_nil)
+  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
+  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
+end
+
 H.echo = function(msg, add_to_history)
   if H.get_config().silent then return end
 
@@ -1958,8 +1952,6 @@ H.unecho = function()
   if H.cache.msg_shown then vim.cmd([[echo '' | redraw]]) end
 end
 
-H.error = function(msg) error(string.format('(mini.align) %s', msg), 0) end
-
 H.map = function(mode, lhs, rhs, opts)
   if lhs == '' then return end
   opts = vim.tbl_deep_extend('force', { silent = true }, opts or {})

lua/mini/animate.lua

@@ -1199,18 +1199,35 @@ H.animation_done_events = {
 -- Helper functionality =======================================================
 -- Settings -------------------------------------------------------------------
 H.setup_config = function(config)
-  -- General idea: if some table elements are not present in user-supplied
-  -- `config`, take them from default config
-  vim.validate({ config = { config, 'table', true } })
+  H.check_type('config', config, 'table', true)
   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
 
-  vim.validate({
-    cursor = { config.cursor, H.is_config_cursor },
-    scroll = { config.scroll, H.is_config_scroll },
-    resize = { config.resize, H.is_config_resize },
-    open = { config.open, H.is_config_open },
-    close = { config.close, H.is_config_close },
-  })
+  H.check_type('cursor', config.cursor, 'table')
+  H.check_type('cursor.enable', config.cursor.enable, 'boolean')
+  H.check_type('cursor.timing', config.cursor.timing, 'callable')
+  H.check_type('cursor.path', config.cursor.path, 'callable')
+
+  H.check_type('scroll', config.scroll, 'table')
+  H.check_type('scroll.enable', config.scroll.enable, 'boolean')
+  H.check_type('scroll.timing', config.scroll.timing, 'callable')
+  H.check_type('scroll.subscroll', config.scroll.subscroll, 'callable')
+
+  H.check_type('resize', config.resize, 'table')
+  H.check_type('resize.enable', config.resize.enable, 'boolean')
+  H.check_type('resize.timing', config.resize.timing, 'callable')
+  H.check_type('resize.subresize', config.resize.subresize, 'callable')
+
+  H.check_type('open', config.open, 'table')
+  H.check_type('open.enable', config.open.enable, 'boolean')
+  H.check_type('open.timing', config.open.timing, 'callable')
+  H.check_type('open.winconfig', config.open.winconfig, 'callable')
+  H.check_type('open.winblend', config.open.winblend, 'callable')
+
+  H.check_type('close', config.close, 'table')
+  H.check_type('close.enable', config.close.enable, 'boolean')
+  H.check_type('close.timing', config.close.timing, 'callable')
+  H.check_type('close.winconfig', config.close.winconfig, 'callable')
+  H.check_type('close.winblend', config.close.winblend, 'callable')
 
   return config
 end
@@ -2065,59 +2082,14 @@ end
 
 H.default_winconfig_predicate = function(win_id) return true end
 
--- Predicators ----------------------------------------------------------------
-H.is_config_cursor = function(x)
-  if type(x) ~= 'table' then return false, H.msg_config('cursor', 'table') end
-  if type(x.enable) ~= 'boolean' then return false, H.msg_config('cursor.enable', 'boolean') end
-  if not vim.is_callable(x.timing) then return false, H.msg_config('cursor.timing', 'callable') end
-  if not vim.is_callable(x.path) then return false, H.msg_config('cursor.path', 'callable') end
-
-  return true
-end
-
-H.is_config_scroll = function(x)
-  if type(x) ~= 'table' then return false, H.msg_config('scroll', 'table') end
-  if type(x.enable) ~= 'boolean' then return false, H.msg_config('scroll.enable', 'boolean') end
-  if not vim.is_callable(x.timing) then return false, H.msg_config('scroll.timing', 'callable') end
-  if not vim.is_callable(x.subscroll) then return false, H.msg_config('scroll.subscroll', 'callable') end
-
-  return true
-end
-
-H.is_config_resize = function(x)
-  if type(x) ~= 'table' then return false, H.msg_config('resize', 'table') end
-  if type(x.enable) ~= 'boolean' then return false, H.msg_config('resize.enable', 'boolean') end
-  if not vim.is_callable(x.timing) then return false, H.msg_config('resize.timing', 'callable') end
-  if not vim.is_callable(x.subresize) then return false, H.msg_config('resize.subresize', 'callable') end
-
-  return true
-end
-
-H.is_config_open = function(x)
-  if type(x) ~= 'table' then return false, H.msg_config('open', 'table') end
-  if type(x.enable) ~= 'boolean' then return false, H.msg_config('open.enable', 'boolean') end
-  if not vim.is_callable(x.timing) then return false, H.msg_config('open.timing', 'callable') end
-  if not vim.is_callable(x.winconfig) then return false, H.msg_config('open.winconfig', 'callable') end
-  if not vim.is_callable(x.winblend) then return false, H.msg_config('open.winblend', 'callable') end
-
-  return true
-end
-
-H.is_config_close = function(x)
-  if type(x) ~= 'table' then return false, H.msg_config('close', 'table') end
-  if type(x.enable) ~= 'boolean' then return false, H.msg_config('close.enable', 'boolean') end
-  if not vim.is_callable(x.timing) then return false, H.msg_config('close.timing', 'callable') end
-  if not vim.is_callable(x.winconfig) then return false, H.msg_config('close.winconfig', 'callable') end
-  if not vim.is_callable(x.winblend) then return false, H.msg_config('close.winblend', 'callable') end
+-- Utilities ------------------------------------------------------------------
+H.error = function(msg) error('(mini.animate) ' .. msg, 0) end
 
-  return true
+H.check_type = function(name, val, ref, allow_nil)
+  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
+  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
 end
 
-H.msg_config = function(x_name, msg) return string.format('`%s` should be %s.', x_name, msg) end
-
--- Utilities ------------------------------------------------------------------
-H.error = function(msg) error(string.format('(mini.animate) %s', msg), 0) end
-
 H.validate_if = function(predicate, x, x_name)
   local is_valid, msg = predicate(x, x_name)
   if not is_valid then H.error(msg) end

lua/mini/base16.lua

@@ -355,15 +355,13 @@ H.default_config = vim.deepcopy(MiniBase16.config)
 -- Helper functionality =======================================================
 -- Settings -------------------------------------------------------------------
 H.setup_config = function(config)
-  -- General idea: if some table elements are not present in user-supplied
-  -- `config`, take them from default config
-  vim.validate({ config = { config, 'table', true } })
+  H.check_type('config', config, 'table', true)
   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
 
   -- Validate settings
   H.validate_base16_palette(config.palette, 'config.palette')
   H.validate_use_cterm(config.use_cterm, 'config.use_cterm')
-  vim.validate({ plugins = { config.plugins, 'table' } })
+  H.check_type('plugins', config.plugins, 'table')
 
   return config
 end
@@ -1574,4 +1572,12 @@ H.nearest_rgb_id = function(rgb_target, rgb_palette)
   return best_id
 end
 
+-- Utilities ------------------------------------------------------------------
+H.error = function(msg) error('(mini.base16) ' .. msg, 0) end
+
+H.check_type = function(name, val, ref, allow_nil)
+  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
+  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
+end
+
 return MiniBase16

lua/mini/basics.lua

@@ -389,32 +389,26 @@ H.buffer_diagnostic_state = {}
 -- Helper functionality =======================================================
 -- Settings -------------------------------------------------------------------
 H.setup_config = function(config)
-  -- General idea: if some table elements are not present in user-supplied
-  -- `config`, take them from default config
-  vim.validate({ config = { config, 'table', true } })
+  H.check_type('config', config, 'table', true)
   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
 
-  vim.validate({
-    options = { config.options, 'table' },
-    mappings = { config.mappings, 'table' },
-    autocommands = { config.autocommands, 'table' },
-  })
+  H.check_type('options', config.options, 'table')
 
-  vim.validate({
-    ['options.basic'] = { config.options.basic, 'boolean' },
-    ['options.extra_ui'] = { config.options.extra_ui, 'boolean' },
-    ['options.win_borders'] = { config.options.win_borders, 'string' },
+  H.check_type('options.basic', config.options.basic, 'boolean')
+  H.check_type('options.extra_ui', config.options.extra_ui, 'boolean')
+  H.check_type('options.win_borders', config.options.win_borders, 'string')
 
-    ['mappings.basic'] = { config.mappings.basic, 'boolean' },
-    ['mappings.option_toggle_prefix'] = { config.mappings.option_toggle_prefix, 'string' },
-    ['mappings.windows'] = { config.mappings.windows, 'boolean' },
-    ['mappings.move_with_alt'] = { config.mappings.move_with_alt, 'boolean' },
+  H.check_type('mappings', config.mappings, 'table')
+  H.check_type('mappings.basic', config.mappings.basic, 'boolean')
+  H.check_type('mappings.option_toggle_prefix', config.mappings.option_toggle_prefix, 'string')
+  H.check_type('mappings.windows', config.mappings.windows, 'boolean')
+  H.check_type('mappings.move_with_alt', config.mappings.move_with_alt, 'boolean')
 
-    ['autocommands.basic'] = { config.autocommands.basic, 'boolean' },
-    ['autocommands.relnum_in_visual_mode'] = { config.autocommands.relnum_in_visual_mode, 'boolean' },
+  H.check_type('autocommands', config.autocommands, 'table')
+  H.check_type('autocommands.basic', config.autocommands.basic, 'boolean')
+  H.check_type('autocommands.relnum_in_visual_mode', config.autocommands.relnum_in_visual_mode, 'boolean')
 
-    ['silent'] = { config.silent, 'boolean' },
-  })
+  H.check_type('silent', config.silent, 'boolean')
 
   return config
 end
@@ -746,6 +740,13 @@ H.apply_autocommands = function(config)
 end
 
 -- Utilities ------------------------------------------------------------------
+H.error = function(msg) error('(mini.basics) ' .. msg, 0) end
+
+H.check_type = function(name, val, ref, allow_nil)
+  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
+  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
+end
+
 H.map = function(mode, lhs, rhs, opts)
   if lhs == '' then return end
   opts = vim.tbl_deep_extend('force', { silent = true }, opts or {})