Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SUSTech-data/wildfire.nvim
wildfire burns treesitter
https://github.com/SUSTech-data/wildfire.nvim
hacktoberfest neovim
Last synced: 2 months ago
JSON representation
wildfire burns treesitter
- Host: GitHub
- URL: https://github.com/SUSTech-data/wildfire.nvim
- Owner: SUSTech-data
- Created: 2023-08-10T03:31:55.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-21T05:38:21.000Z (about 1 year ago)
- Last Synced: 2024-07-03T12:15:03.127Z (3 months ago)
- Topics: hacktoberfest, neovim
- Language: Lua
- Homepage:
- Size: 1.26 MB
- Stars: 272
- Watchers: 17
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔥Wildfire.nvim: Wildfire burns treesitter🌲
A modern successor to
[wildfire.vim](https://github.com/gcmt/wildfire.vim), empowered with the
superpower of treesitter.
Incremental and decremental selection
## Highlights
- âš¡ Smartly select the **inner** part of texts
- âš« **count prefix**
- 🌳 **Treesitter Integration**
## Motivation
I’ve found that treesitter’s
[`incremental_selection`](https://www.reddit.com/r/neovim/comments/r10llx/the_most_amazing_builtin_feature_nobody_ever/)
is particularly handy for text selection. It often allows for selecting
the desired text with fewer keystrokes compared to a well-configured
wildfire.vim, all without the need to set up intricate text objects.
However, since treesitter relies solely on AST for incremental
selection, it tends to be overly **aggressive** for surrounds. In such
case, I have to revert to using text objects for selection, which is
annoyed and tripped me up in practical use.
On the other hand, treesitter doesn’t support the
`count prefix(vim.v.count)`, which can make it somewhat cumbersome when
dealing with longer ranges. Its implementation is also a bit buggy, as
you might select an area within the same range(see below).
> A picture is worth a thousand words
## Usage
The usage is almost the same as
[wildfire.vim](https://github.com/gcmt/wildfire.vim) and
[`incremental_selection`](https://www.reddit.com/r/neovim/comments/r10llx/the_most_amazing_builtin_feature_nobody_ever/),
You can check out their introduction to get a sense of it.
- `CR` Init selection and do incremental selection if you have
initilized (so just keep pressing `CR`).
- `BS` Decremental selection.
- `NUM-CR` Accelerate selection with count prefix.
This plugin offers a streamlined method for text selection, freeing you
from the hassle of configuring and remembering intricate text objects.
Plus, initiating this plugin with `CR` seamlessly transitions you into
visual mode. This means you can still harness the power of your
preferred text objects without any extra keystrokes (like `v-i-b` or
`CR-i-b`).
Beyond the basic actions such as yank(`CR`), delete(`d`), and change
(`c`), here are a few other awesome tricks up its sleeve:
- Partially format with: textDocument/rangeFormatting
- Narrow down regions using:
[nag.nvim](https://github.com/haolian9/nag.nvim)
- Adding surrounding pairs via:
[nvim-surround](https://github.com/kylechui/nvim-surround)
- Comments with [comment.nvim](https://github.com/numToStr/Comment.nvim)
> **Tip**
>
> This plugin embodies my endeavor to embrace the Helix-inspired select
> first method. The horizon is vast, and the possibilities limitless.
> Come, let’s explore the extent of what we can achieve together! 🚀
## Installation
``` lua
{
"sustech-data/wildfire.nvim",
event = "VeryLazy",
dependencies = { "nvim-treesitter/nvim-treesitter" },
config = function()
require("wildfire").setup()
end,
}
```
## Configuration
This plugin is modified based on the official implementation of
treesitter, so you can configure it in a very similar manner.
Currently you can only set surroundings with unit width, refer to the
default settings below.
``` lua
{
surrounds = {
{ "(", ")" },
{ "{", "}" },
{ "<", ">" },
{ "[", "]" },
},
keymaps = {
init_selection = "",
node_incremental = "",
node_decremental = "",
},
filetype_exclude = { "qf" }, --keymaps will be unset in excluding filetypes
}
```
To disable a keymaps, set it to `nil` or `false`.
The quick selection havn’t support natively, but you can try it out by
``` lua
:lua require'wildfire'.init_selection():lua require('tsht').nodes()
```
which is powered by
[treehopper](https://github.com/mfussenegger/nvim-treehopper),
[flash](https://github.com/folke/flash.nvim/tree/main) also provide
similar things
## Roadmap
- [x] init with count prefix
- [x] support configuring exclude filetypes
- [ ] Native quick selection support
- [ ] Advanced surround support (Any length)
- [ ] Handle surround in node