feat: spellcheck picker, all misspelled words in buffer

Author: ibhagwan

OPTIONS.md

@@ -1165,6 +1165,10 @@ Filetypes
 
 Neovim's menus
 
+#### spellcheck
+
+Misspelled words in buffer
+
 #### spell_suggest
 
 Spelling suggestions

README.md

@@ -301,6 +301,7 @@ Alternatively, resuming work on a specific picker:
 | `keymaps`              | key mappings                   |
 | `filetypes`            | filetypes                      |
 | `menus`                | menus                          |
+| `spellcheck`           | misspelled words in buffer     |
 | `spell_suggest`        | spelling suggestions           |
 | `packadd`              | :packadd <package>             |
 

doc/fzf-lua-opts.txt

@@ -1,4 +1,4 @@
-*fzf-lua-opts.txt*        For Neovim >= 0.8.0       Last change: 2025 March 13
+*fzf-lua-opts.txt*         For Neovim >= 0.8.0        Last change: 2025 May 13
 
 ==============================================================================
 Table of Contents                             *fzf-lua-opts-table-of-contents*
@@ -1605,6 +1605,12 @@ Neovim's menus
 
 
 
+spellcheck                                           *fzf-lua-opts-spellcheck*
+
+Misspelled words in buffer
+
+
+                                                                              
 spell_suggest                                     *fzf-lua-opts-spell_suggest*
 
 Spelling suggestions

lua/fzf-lua/actions.lua

@@ -664,6 +664,12 @@ M.spell_apply = function(selected, opts)
   end
 end
 
+M.spell_suggest = function(selected, opts)
+  if not selected[1] then return false end
+  M.file_edit(selected, opts)
+  FzfLua.spell_suggest({ no_resume = true })
+end
+
 M.set_filetype = function(selected)
   vim.bo.filetype = selected[1]:match("[^" .. utils.nbsp .. "]+$")
 end

lua/fzf-lua/config.lua

@@ -982,6 +982,7 @@ M._action_to_helpstr = {
   [actions.nvim_opt_edit_local]  = "nvim-opt-edit-local",
   [actions.nvim_opt_edit_global] = "nvim-opt-edit-global",
   [actions.spell_apply]          = "spell-apply",
+  [actions.spell_suggest]        = "spell-suggest",
   [actions.set_filetype]         = "set-filetype",
   [actions.packadd]              = "packadd",
   [actions.help]                 = "help-open",

lua/fzf-lua/defaults.lua

@@ -728,6 +728,33 @@ M.defaults.treesitter           = {
   },
 }
 
+M.defaults.spellcheck           = {
+  previewer        = M._default_previewer_fn,
+  file_icons       = false,
+  color_icons      = false,
+  word_separator   = "[%s%p]",
+  fzf_opts         = {
+    ["--multi"]     = true,
+    ["--tabstop"]   = "4",
+    ["--delimiter"] = "[:]",
+    ["--with-nth"]  = "2..",
+  },
+  line_field_index = "{2}",
+  _actions         = function()
+    return M.globals.actions.buffers or M.globals.actions.files
+  end,
+  actions          = {
+    ["ctrl-s"] = { fn = actions.spell_suggest, header = "spell suggest" }
+  },
+  _cached_hls      = { "buf_name", "buf_nr", "buf_linenr", "path_colnr" },
+  _fmt             = {
+    to   = false,
+    from = function(s, _)
+      return s:gsub("\t\t", ": ")
+    end
+  },
+}
+
 M.defaults.tags                 = {
   previewer    = { _ctor = previewers.builtin.tags },
   input_prompt = "[tags] Grep For> ",

lua/fzf-lua/init.lua

@@ -239,6 +239,7 @@ do
     lines = { "fzf-lua.providers.buffers", "lines" },
     blines = { "fzf-lua.providers.buffers", "blines" },
     treesitter = { "fzf-lua.providers.buffers", "treesitter" },
+    spellcheck = { "fzf-lua.providers.buffers", "spellcheck" },
     helptags = { "fzf-lua.providers.helptags", "helptags" },
     manpages = { "fzf-lua.providers.manpages", "manpages" },
     -- backward compat

lua/fzf-lua/providers/buffers.lua

@@ -622,4 +622,107 @@ M.treesitter = function(opts)
   core.fzf_exec(contents, opts)
 end
 
+M.spellcheck = function(opts)
+  opts = config.normalize_opts(opts, "spellcheck")
+  if not opts then return end
+
+  if #vim.bo.spelllang == 0 then
+    utils.info("Spell language not set, use ':setl spl=...' to enable spell checking.")
+    return
+  end
+
+  -- Default to current buffer
+  opts._bufnr = tonumber(opts.bufnr) or vim.api.nvim_get_current_buf()
+  opts._bufname = path.basename(vim.api.nvim_buf_get_name(opts._bufnr))
+  if not opts._bufname or #opts._bufname == 0 then
+    opts._bufname = utils.nvim_buf_get_name(opts._bufnr)
+  end
+
+  if utils.mode_is_visual() then
+    local _, sel = utils.get_visual_selection()
+    opts.start_line = opts.start_line or sel.start.line
+    opts.end_line = opts.end_line or sel["end"].line
+  end
+
+  local contents = function(cb)
+    coroutine.wrap(function()
+      local co = coroutine.running()
+      local data = {}
+
+      -- Use vim.schedule to avoid
+      -- E5560: vimL function must not be called in a lua loop callback
+      vim.schedule(function()
+        local bufnr = opts._bufnr
+        local filepath = vim.api.nvim_buf_get_name(bufnr)
+        if vim.api.nvim_buf_is_loaded(bufnr) then
+          data = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
+        elseif vim.fn.filereadable(filepath) ~= 0 then
+          data = vim.fn.readfile(filepath, "")
+        end
+        coroutine.resume(co)
+      end)
+
+      -- wait for vim.schedule
+      coroutine.yield()
+
+      local offset = 0
+      local start_line = opts.start_line or 1
+      local end_line = opts.end_line or #data
+      local lines = end_line - start_line + 1
+
+      if opts.start == "cursor" then
+        -- start display from current line and wrap from bottom
+        offset = core.CTX().cursor[1] - start_line
+      end
+
+      for i = 1, lines do
+        local lnum = i + offset
+        if lnum > lines then
+          lnum = lnum % lines
+        end
+        lnum = lnum + start_line - 1
+
+        local line, from, to = data[lnum], 1, nil
+        repeat
+          local word_separator = opts.word_separator or "[%s%p]"
+          local function trim(s)
+            return s:gsub("^" .. word_separator .. "+", ""):gsub(word_separator .. "+$", "")
+          end
+          from, to = string.find(line, "%w+", from)
+          local word = from and string.sub(line, from, to)
+          local prefix = from and string.sub(line, from - 1, from - 1) or ""
+          local postfix = to and string.sub(line, to + 1, to + 1) or ""
+          local valid_word = word
+              and (#prefix == 0 or prefix:match("^" .. word_separator))
+              and (#postfix == 0 or postfix:match(word_separator .. "$"))
+          if valid_word then
+            local _, lead = word:find("^" .. word_separator .. "+")
+            local spell = vim.spell.check(trim(word))[1]
+            if spell then
+              cb(string.format("[%s]%s%s:%s:%s\t\t%s",
+                utils.ansi_codes[opts.hls.buf_nr](tostring(opts._bufnr)),
+                utils.nbsp,
+                utils.ansi_codes[opts.hls.buf_name](opts._bufname),
+                utils.ansi_codes[opts.hls.buf_linenr](tostring(lnum)),
+                utils.ansi_codes[opts.hls.path_colnr](tostring(from + (lead or 0))),
+                trim(word)
+              ), function(err)
+                coroutine.resume(co)
+                if err then cb(nil) end
+              end)
+              coroutine.yield()
+            end
+          end
+          if from then from = to + 1 end
+        until not from
+      end
+      cb(nil)
+    end)()
+  end
+
+  opts = core.set_header(opts, opts.headers or { "actions" })
+
+  core.fzf_exec(contents, opts)
+end
+
 return M