Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gcmt/wildfire.vim
Smart selection of the closest text object
https://github.com/gcmt/wildfire.vim
Last synced: about 2 months ago
JSON representation
Smart selection of the closest text object
- Host: GitHub
- URL: https://github.com/gcmt/wildfire.vim
- Owner: gcmt
- License: mit
- Created: 2014-01-08T17:43:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-22T04:40:37.000Z (about 1 year ago)
- Last Synced: 2024-06-18T14:36:05.580Z (3 months ago)
- Language: Vim Script
- Homepage:
- Size: 250 KB
- Stars: 610
- Watchers: 7
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- my-awesome-github-stars - gcmt/wildfire.vim - Smart selection of the closest text object (Vim Script)
README
## wildfire.vim
With *Wildfire* you can quickly select the closest text object among a group of candidates. By default candidates are `i'`, `i"`, `i)`, `i]`, `i}`, `ip` and `it`.
Learn more about text objects with `:help text-objects`.
### Installation
Install either with [Pathogen](https://github.com/tpope/vim-pathogen), [Vundle](https://github.com/gmarik/Vundle.vim), [NeoBundle](https://github.com/Shougo/neobundle.vim), or your favorite plugin manager.
### Usage
Press `` in normal mode to select the closest text object. Keep pressing `` for selecting the **next** closest text object. To go the other way round, that is, to select the **previously** selected text object, press ``.
To speed things up, if you want to select the `n`th closest text object you can press a number followed by `` (e.g. pressing `2` will select the second closest text object).
You can change default mappings with:
```vim
" This selects the next closest text object.
map (wildfire-fuel)
" This selects the previous closest text object.
vmap (wildfire-water)
```
By default, *Wildfire* selects any of the text objects `i'`, `i"`, `i)`, `i]`, `i}`, `ip` and `it`. You can decide the ones to consider with the following option:
```vim
let g:wildfire_objects = ["i'", 'i"', "i)", "i]", "i}", "ip", "it"]
```
### Advanced usage
Sometimes considering certain kinds of text objects can be quite annoying. This is the case of Html, where, for example, you may want to select just tag objects.
Wildfire allows you to be selective about which text objects are considered with different filetypes:
```vim
" use '*' to mean 'all other filetypes'
" in this example, html and xml share the same text objects
let g:wildfire_objects = {
\ "*" : ["i'", 'i"', "i)", "i]", "i}"],
\ "html,xml" : ["at", "it"],
\ }
```
One problem with the solution above is that with `html` and `xml` files we loose the ability to select the text objects `i'`, `i"`, `i)`, `i]` and `i}`. To solve this problem, Wildfire allows you to use different mappings for different text object candidates:
```vim
map (wildfire-fuel)
let g:wildfire_objects = {
\ "*" : ["i'", 'i"', "i)", "i]", "i}"]
\ }
cal wildfire#triggers#Add("", {
\ "html,xml" : ["at", "it"],
\ })
```
### Quick selection
A visual explanation often works far better than plain old words.
Wildfire does not set a default mapping for *quick selection*. Be sure to put something like the following line in your `.vimrc`:
```vim
nmap s (wildfire-quick-select)
```
By default, *quick selection* use text objects in `g:wildfire_objects` to set "selection marks". Have a look at the example below if you want to use different text object without having to change `g:wildfire_objects`.
```vim
cal wildfire#triggers#AddQs("s", {
\ "*" : ["i)", "i]"],
\ })
```
### Similar plugins
Wildfire is not the only plugin who can smartly select text object. Be sure to have a look at the following plugins if Wildfire doesn't suit your needs:
- [vim-expand-region](https://github.com/terryma/vim-expand-region)
- [vim-textobj-anyblock](https://github.com/rhysd/vim-textobj-anyblock)