feat(api): allow a match to disable getting a label

README.md

@@ -347,7 +347,7 @@ interface FlashMatch {
   win: number;
   pos: [number, number]; // (1,0)-indexed
   end_pos: [number, number]; // (1,0)-indexed
-  label?: string;
+  label?: string | false; // set to false to never show a label for this match
 }
 
 // Check the code for the full definition

lua/flash/labeler.lua

@@ -54,7 +54,9 @@ function M:reset()
     end
   end
   for _, m in ipairs(self.state.results) do
-    m.label = nil
+    if m.label ~= false then
+      m.label = nil
+    end
   end
 end
 
@@ -71,7 +73,7 @@ end
 ---@param m Flash.Match
 ---@param used boolean?
 function M:label(m, used)
-  if m.label then
+  if m.label ~= nil then
     return true
   end
   local pos = m.pos:id(m.win)

lua/flash/search/matcher.lua

@@ -4,7 +4,7 @@ local Pos = require("flash.search.pos")
 ---@field win window
 ---@field pos Pos -- (1,0) indexed
 ---@field end_pos Pos -- (1,0) indexed
----@field label? string
+---@field label? string|false
 
 ---@alias Flash.Match.Find {forward?:boolean, wrap?:boolean, count?:number, pos?: Pos, match?:Flash.Match}