https://github.com/romainl/vim-qf

Tame the quickfix window.
https://github.com/romainl/vim-qf

quickfix-window vim vim-plugin

Last synced: 3 months ago
JSON representation

Tame the quickfix window.

• Host: GitHub
• URL: https://github.com/romainl/vim-qf
• Owner: romainl
• License: mit
• Created: 2015-04-07T20:45:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-17T14:32:16.000Z (about 1 year ago)
• Last Synced: 2024-05-31T12:35:18.193Z (5 months ago)
• Topics: quickfix-window, vim, vim-plugin
• Language: Vim Script
• Homepage:
• Size: 5.1 MB
• Stars: 610
• Watchers: 13
• Forks: 34
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vim-qf

**vim-qf**—short for *vim-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.

## 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 runtimepath/plugin manager.

### Method 2

If you are using Vim 8.0 or above, move this directory to:

    # Unix-like systems

    ~/.vim/pack/{whatever name you want}/start/vim-qf

    # Windows

    %userprofile%\vimfiles\pack\{whatever name you want}\start\vim-qf

See `:help package`.

### Method 3

If you are using Vim 7.4 or below, move the files in this directory to their standard location:

    # Unix-like systems

    ~/.vim/after/ftplugin/qf.vim

    ~/.vim/autoload/qf.vim

    ~/.vim/autoload/qf/*.vim

    ~/.vim/doc/qf.txt

    ~/.vim/plugin/qf.vim

    # Windows

    %userprofile%\vimfiles\after\ftplugin\qf.vim

    %userprofile%\vimfiles\autoload\qf.vim

    %userprofile%\vimfiles\autoload\qf\*.vim

    %userprofile%\vimfiles\doc\qf.txt

    %userprofile%\vimfiles\plugin\qf.vim

## Documentation

You can use this command to get help on vim-qf:

    :help vim-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