Add input validation for switches

Author: CKolkey

lua/neogit/lib/popup/builder.lua

@@ -54,6 +54,8 @@ local M = {}
 ---@field type string
 ---@field user_input boolean
 ---@field value string?
+---@field validate fun(string): boolean
+---@field validate_help string|nil
 
 ---@class PopupConfig
 ---@field id string
@@ -90,6 +92,8 @@ local M = {}
 ---@field value? string Allows for pre-building cli flags that can be customized by user input
 ---@field user_input? boolean If true, allows user to customize the value of the cli flag
 ---@field dependent? string[] other switches/options with a state dependency on this one
+---@field validate? fun(string): boolean
+---@field validate_help? string
 
 ---@class PopupOptionOpts
 ---@field key_prefix? string Allows overwriting the default '=' to set option
@@ -252,6 +256,10 @@ function M:switch(key, cli, description, opts)
     internal = opts.internal,
     cli_prefix = opts.cli_prefix,
     user_input = opts.user_input,
+    validate = opts.validate or function()
+      return true
+    end,
+    validate_help = opts.validate_help,
     cli_suffix = opts.cli_suffix,
     options = opts.options,
     incompatible = util.build_reverse_lookup(opts.incompatible),

lua/neogit/lib/popup/init.lua

@@ -119,8 +119,17 @@ function M:toggle_switch(switch)
   if switch.user_input then
     if switch.enabled then
       local value = input.get_user_input(switch.cli_prefix .. switch.cli_base, { separator = "" })
-      if value then
-        switch.cli = switch.cli_base .. value
+      if value and value ~= "" then
+        if switch.validate(value) then
+          switch.cli = switch.cli_base .. value
+        else
+          switch.enabled = false
+          switch.cli = switch.cli_base
+          notification.warn(switch.validate_help)
+        end
+      else
+        switch.enabled = false
+        switch.cli = switch.cli_base
       end
     else
       switch.cli = switch.cli_base

lua/neogit/popups/log/init.lua

@@ -19,7 +19,14 @@ function M.create()
     :option("F", "grep", "", "Search messages", { key_prefix = "-" })
     :switch("G", "G", "Search changes", { user_input = true, cli_prefix = "-" })
     :switch("S", "S", "Search occurrences", { user_input = true, cli_prefix = "-" })
-    :switch("L", "L", "Trace line evolution", { user_input = true, cli_prefix = "-" })
+    :switch("L", "L", "Trace line evolution", {
+      user_input = true,
+      cli_prefix = "-",
+      validate_help = "Input must match 'start,end:file' or ':funcname:file'",
+      validate = function(input)
+        return (input:match("^%d+,%d+:.-$") ~= nil) or (input:match("^:.-:.-$") ~= nil)
+      end,
+    })
     :option("s", "since", "", "Limit to commits since", { key_prefix = "-" })
     :option("u", "until", "", "Limit to commits until", { key_prefix = "-" })
     :switch("m", "no-merges", "Omit merges", { key_prefix = "=" })