Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stefandtw/quickfix-reflector.vim

Change code right in the quickfix window
https://github.com/stefandtw/quickfix-reflector.vim

Last synced: 3 months ago
JSON representation

Change code right in the quickfix window

Awesome Lists containing this project

README 

        
Usage

=====



In the quickfix window, simply edit any entry you like. Once you save the quickfix buffer, your changes will be made in the actual file an entry points to.



You can also delete lines in the quickfix window. This way, you can first review the quickfix list, remove all entries you don't care to change, and then use `%s/foo/bar` (or anything else) on the rest.



Details

=======



* Works in location list windows, too

* The quickfix buffer is now `modifiable`

* The usual write commands can be used (`:w`, `:x` etc.), but they won't save the buffer to a file. Instead they will trigger replacement for any changes you made.

* If you specifically want to save the quickfix buffer to a file, you can still do that the same way as before `:write my_qf_list`

* Adding and removing lines in the quickfix buffer breaks each line's link to Vim's internal quickfix entry. After making such changes, you need to write the quickfix buffer. This will rewrite Vim's internal quickfix list. Otherwise, pressing `` may jump to the wrong entry.

* If you like to use `:caddexpr` or similar partial updates to the quickfix list, you need re-initialize the quickfix buffer before it can be saved. The easiest way is to `:copen` again. See [Issue #25](https://github.com/stefandtw/quickfix-reflector.vim/issues/25).



Limits to text replacement

==========================



Whenever a replacement fails, you get an '[ERROR]' in the corresponding quickfix entry.



Replacement only works if the text that was modified actually exists in the corresponding text file and line number. So it may fail if the file was modified since the quickfix list was built.



If the quickfix entry contains only part of a line, replacement should work as long as there is a substring of that line with at least three characters.



Example: The quickfix entry `Missing ; at: xyz` can be used to replace in a line `a = xyz`. However, it cannot be used in a line `xyz = 1+xyz` because it is not clear which xyz would need to be replaced



Options

=======



```

let g:qf_modifiable = 1

```

If 1, automatically sets quickfix buffers 'modifiable'. If you prefer to do

this manually, set the value to 0. Default: 1.



```

let g:qf_join_changes = 1

```

If 1, changes within a single buffer will be joined using |:undojoin|, allowing

them to be undone as a unit.  Default: 0.



```

let g:qf_write_changes = 1

```

If 1, writing the quickfix buffer will also write corresponding files. If 0,

buffers of corresponding files will be changed but not written, allowing you

to preview the changes before writing the individual buffers yourself.

Default: 1



Events

======



Custom events can be used like this:

```

autocmd User  :echo 'do something'

```

If you prefer, you can redirect a custom event using regular Vim events. Example:

```

autocmd User QfReplacementBufWritePost doautocmd BufWritePost

```



Implemented events:

* `QfReplacementBufWritePost` This event is sent after making a replacement and writing the corresponding buffer.



Links

=====



* [Github](https://github.com/stefandtw/quickfix-reflector.vim)

* [vim.org](http://www.vim.org/scripts/script.php?script_id=4890)



Installation

============



Use [Pathogen](https://github.com/tpope/vim-pathogen), [Vundle](https://github.com/gmarik/Vundle.vim), or your own favorite method.



Development

===========



Run `rake test` for the [vspec](https://github.com/kana/vim-vspec) tests.



To get the test environment working you need to

* install ruby

* `gem install bundler`

* `bundle install`



More details [here](http://whileimautomaton.net/2013/02/08211255).