feat(search): optional trigger character. Not recommended. Fixes #21

README.md

@@ -113,6 +113,10 @@ Install the plugin with your preferred package manager:
     -- behave like `incsearch`
     incremental = false,
     filetype_exclude = { "notify", "noice" },
+    -- Optional trigger character that needs to be typed before
+    -- a jump label can be used. It's NOT recommended to set this,
+    -- unless you know what you're doing
+    trigger = "",
   },
   jump = {
     -- save location in the jumplist

lua/flash/cache.lua

@@ -22,7 +22,7 @@ M.cache = setmetatable({}, { __mode = "k" })
 function M.new(state)
   local self = setmetatable({}, M)
   self.state = state
-  self.pattern = Pattern.new("", state.opts.search.mode)
+  self.pattern = Pattern.new("", state.opts.search.mode, state.opts.search.trigger)
   self.wins = {}
   return self
 end

lua/flash/config.lua

@@ -29,6 +29,10 @@ local defaults = {
     -- behave like `incsearch`
     incremental = false,
     filetype_exclude = { "notify", "noice" },
+    -- Optional trigger character that needs to be typed before
+    -- a jump label can be used. It's NOT recommended to set this,
+    -- unless you know what you're doing
+    trigger = "",
   },
   jump = {
     -- save location in the jumplist

lua/flash/search/pattern.lua

@@ -4,6 +4,7 @@ local Util = require("flash.util")
 ---@field pattern string
 ---@field search string
 ---@field skip string
+---@field trigger string
 ---@field mode Flash.Pattern.Mode
 ---@operator call:string Returns the input pattern
 local M = {}
@@ -13,9 +14,11 @@ M.__index = M
 
 ---@param pattern string
 ---@param mode Flash.Pattern.Mode
-function M.new(pattern, mode)
+---@param trigger string
+function M.new(pattern, mode, trigger)
   local self = setmetatable({}, M)
   self.mode = mode
+  self.trigger = trigger or ""
   self:set(pattern or "")
   return self
 end
@@ -25,7 +28,7 @@ function M:__eq(other)
 end
 
 function M:clone()
-  return M.new(self.pattern, self.mode)
+  return M.new(self.pattern, self.mode, self.trigger)
 end
 
 function M:empty()
@@ -41,6 +44,9 @@ function M:set(pattern)
       self.search = ""
       self.skip = ""
     else
+      if self.trigger ~= "" and pattern:sub(-1) == self.trigger then
+        pattern = pattern:sub(1, -2)
+      end
       self.search, self.skip = M._get(pattern, self.mode)
     end
     return false

lua/flash/state.lua

@@ -82,7 +82,7 @@ function M.new(opts)
   self.matchers = {}
   self.wins = {}
   self.matcher = self.opts.matcher and Matcher.from(self.opts.matcher) or Search.new
-  self.pattern = Pattern.new(self.opts.pattern, self.opts.search.mode)
+  self.pattern = Pattern.new(self.opts.pattern, self.opts.search.mode, self.opts.search.trigger)
   self.visible = true
   self.cache = Cache.new(self)
   self.labeler = self.opts.labeler or require("flash.labeler").new(self):labeler()
@@ -153,6 +153,9 @@ end
 -- Checks if the given pattern is a jump label and jumps to it.
 ---@param pattern string
 function M:check_jump(pattern)
+  if self.opts.search.trigger ~= "" and self.pattern():sub(-1) ~= self.opts.search.trigger then
+    return
+  end
   if pattern:find(self.pattern(), 1, true) == 1 and #pattern == #self.pattern() + 1 then
     local label = pattern:sub(-1)
     if self:jump(label) then