Skip to content

Commit

Permalink
feat(fzf): add fzf-lua support in Readme & add TodoFzfLua command (#312)
Browse files Browse the repository at this point in the history
## Description

<!-- Describe the big picture of your changes to communicate to the
maintainers
  why we should accept this pull request. -->

This plugin has support `fzf-lua` ( an alternative to `Telescope` ) in
lua/fzf.lua. But nowhere in the `README` it is said that there's
`fzf-lua` support, so i added it explicitly in the `README`. There's
also no commands to call the function so i added the `TodoFzfLua`
command

Co-authored-by: user <[email protected]>
  • Loading branch information
iguanacucumber and user authored Aug 31, 2024
1 parent 8f45f35 commit 6d6cf47
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- configurable **signs**
- open todos in a **quickfix** list
- open todos in [Trouble](https://github.com/folke/trouble.nvim)
- search todos with [Telescope](https://github.com/nvim-telescope/telescope.nvim)
- search todos with [Telescope](https://github.com/nvim-telescope/telescope.nvim) & [FzfLua](https://github.com/ibhagwan/fzf-lua)

## ⚡️ Requirements

Expand All @@ -22,6 +22,7 @@
+ [ripgrep](https://github.com/BurntSushi/ripgrep) and [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) are used for searching.
+ [Trouble](https://github.com/folke/trouble.nvim)
+ [Telescope](https://github.com/nvim-telescope/telescope.nvim)
+ [FzfLua](https://github.com/ibhagwan/fzf-lua)

## 📦 Installation

Expand Down Expand Up @@ -184,6 +185,9 @@ Search through all project todos with Telescope

![image](https://user-images.githubusercontent.com/292349/118135371-ccb91200-b3b7-11eb-9002-66af3b683cf0.png)

> [!Note]
> The same can be done with `:TodoFzfLua`
<!-- markdownlint-disable-file MD033 -->
<!-- markdownlint-configure-file { "MD013": { "line_length": 120 } } -->
<!-- markdownlint-configure-file { "MD004": { "style": "sublist" } } -->
1 change: 1 addition & 0 deletions plugin/todo.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
command! -nargs=* TodoQuickFix lua require("todo-comments.search").setqflist(<q-args>)
command! -nargs=* TodoLocList lua require("todo-comments.search").setloclist(<q-args>)
command! -nargs=* TodoTelescope Telescope todo-comments todo <args>
command! -nargs=* TodoFzfLua lua require("todo-comments.fzf").todo() <args>
command! -nargs=* TodoTrouble Trouble todo <args>

0 comments on commit 6d6cf47

Please sign in to comment.