feat(prompt): add flash.prompt() to get the prompt text (folke#347)

- Resolve folke#346

---------

Co-authored-by: Folke Lemaitre <[email protected]>

Author: xiyaowong

README.md

@@ -324,6 +324,7 @@ Install the plugin with your preferred package manager:
   },
   -- options for the floating window that shows the prompt,
   -- for regular jumps
+  -- `require("flash").prompt()` is always available to get the prompt text
   prompt = {
     enabled = true,
     prefix = { { "⚡", "FlashPromptIcon" } },
@@ -410,7 +411,8 @@ Install the plugin with your preferred package manager:
 - **jump**: `require("flash").jump(opts?)` opens **flash** with the given options
   - type any number of characters before typing a jump label
 - **VS Code**: some functionality is changed/disabled when running **flash** in **VS Code**:
-  - `prompt` is disabled
+  - `prompt` is disabled. You can use `require("flash").prompt()` to get the
+    prompt text and integrate it into the statusline.
   - `highlights` are set to different defaults that will actually work in VS Code
 
 ## 📡 API

lua/flash/commands.lua

@@ -33,4 +33,9 @@ function M.toggle(enabled)
   return Search.toggle(enabled)
 end
 
+---@return string
+function M.prompt()
+  return require("flash.prompt").prompt or ""
+end
+
 return M

lua/flash/config.lua

@@ -237,6 +237,7 @@ local defaults = {
   },
   -- options for the floating window that shows the prompt,
   -- for regular jumps
+  -- `require("flash").prompt()` is always available to get the prompt text
   prompt = {
     enabled = true,
     prefix = { { "⚡", "FlashPromptIcon" } },

lua/flash/prompt.lua

@@ -1,8 +1,9 @@
 local Config = require("flash.config")
 
 ---@class Flash.Prompt
----@field win window
----@field buf buffer
+---@field win number
+---@field buf number
+---@field prompt string
 local M = {}
 
 local ns = vim.api.nvim_create_namespace("flash_prompt")
@@ -47,6 +48,8 @@ function M.show()
 end
 
 function M.hide()
+  M.prompt = ""
+
   if M.win and vim.api.nvim_win_is_valid(M.win) then
     vim.api.nvim_win_close(M.win, true)
     M.win = nil
@@ -58,15 +61,24 @@ function M.hide()
 end
 
 ---@param pattern string
-function M.set(pattern)
-  M.show()
+---@param show boolean
+function M.set(pattern, show)
   local text = vim.deepcopy(Config.prompt.prefix)
   text[#text + 1] = { pattern }
 
   local str = ""
   for _, item in ipairs(text) do
     str = str .. item[1]
   end
+
+  M.prompt = str
+
+  if not show then
+    return
+  end
+
+  M.show()
+
   vim.api.nvim_buf_set_lines(M.buf, 0, -1, false, { str })
   vim.api.nvim_buf_clear_namespace(M.buf, ns, 0, -1)
   local col = 0

lua/flash/state.lua

@@ -343,8 +343,8 @@ end
 ---@param opts? Flash.Step.Options
 function M:step(opts)
   opts = opts or {}
-  if self.opts.prompt.enabled and not M.is_search() then
-    Prompt.set(self.pattern())
+  if not M.is_search() then
+    Prompt.set(self.pattern(), self.opts.prompt.enabled)
   end
   local actions = opts.actions or self.opts.actions or {}
   local c = self:get_char()