Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RishabhRD/nvim-qf
vim-qf fork for neovim
https://github.com/RishabhRD/nvim-qf
Last synced: 3 months ago
JSON representation
vim-qf fork for neovim
- Host: GitHub
- URL: https://github.com/RishabhRD/nvim-qf
- Owner: RishabhRD
- License: mit
- Created: 2021-09-12T06:58:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-09-12T17:42:28.000Z (about 3 years ago)
- Last Synced: 2024-06-10T01:39:09.742Z (5 months ago)
- Language: Vim script
- Size: 25.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-qf
**nvim-qf**—short for *nvim-quickfix*—is a growing collection of settings, commands and mappings put together to make working with the location list/window and the quickfix list/window smoother.
## What it is not
- It is not a rewrite of vim-qf... infact it is a fork of vim-qf
- No I am not doing it in lua... (Who knows what the future would be)
## Why
The motivation was :cwindow and :lwindow was not working with my needs. I need
quickfix list even if there is no error and :cwindow and :lwindow apparently
doesn't suit this need. For example toggle-qf should work even if there is no
error.
## Features
### Anti-features
Many plugins interact with the quickfix/location list/window in ways that are more or less incompatible with vim-qf. I have put considerable effort in making most vim-qf features optional so it should be possible to disable individual features in case of conflict but well… you never know.
**If one of your plugins somehow already manages the quickfix/location list/window, then you should probably look elsewhere.**
### Global features (available from any window)
- quickfix buffers are hidden from `:ls` and buffer navigation
- quit Vim if the last window is a location/quickfix window
- close the location window automatically when quitting parent window
- (optional) mappings for `:cnext`, `:cprevious`, `:lnext`, `:lprevious` that wrap around the beginning and end of the list
- (optional) mapping for jumping to and from the location/quickfix window,
- (optional) mappings for toggling location/quickfix windows
- (optional) open the location/quickfix window automatically after `:make`, `:grep`, `:lvimgrep` and friends if there are valid locations/errors
- (optional) automatically set the height of location/quickfix windows to the number of list items if less than Vim's default height (10) or the user's prefered height
### Local features (available only in location/quickfix windows)
- disable relative numbers
- filter and restore the current list:
![filter][1]
- perform commands on each line in the current list
- perform commands on each file in the current list
- jump to next group of entries belonging to same file ("file grouping"):
![group][2]
- save and load named lists:
![list][3]
- (optional) disable soft-wrapping
- (optional) Ack.vim-inspired mappings
- (optional) shorten filepaths for better legibility
## Installation
### Method 1
Use your favorite plugin manager
```
Plug 'RishabhRD/nvim-qf'
```
## Documentation
You can use this command to get help on vim-qf:
:help nvim-qf
## TODO
- Export more options?
- Add titles to saved lists, e.g. to display in :ListLists?
## DONE
- Use `` mappings.
- Add proper attribution for a few features.
- Write a proper `help` file.
- Ask #vim's opinion.
- Add a gifcast to the README.
- Add `:packadd` support?
[1]: https://romainl.github.io/vim-qf/filter.gif
[2]: https://romainl.github.io/vim-qf/group.gif
[3]: https://romainl.github.io/vim-qf/list.gif