]> git.wincent.com - docvim.git/blob - tests/fixtures/markdown/integration-ferret-plugin.golden
Remove unnecessary explicit anchors in headings
[docvim.git] / tests / fixtures / markdown / integration-ferret-plugin.golden
1 # ferret
2
3 ## Intro
4
5 > "ferret (verb)<br />(ferret something out) search tenaciously for and find something: she had the ability to ferret out the facts."
6
7 <p align="right"><a name="ferret-features" href="#user-content-ferret-features"><code>ferret-features</code></a></p>
8 Ferret improves Vim's multi-file search in four ways:
9
10 ### 1. Powerful multi-file search
11
12 Ferret provides an <strong>[`:Ack`](#user-content-ack)</strong> command for searching across multiple files using The Silver Searcher (https://github.com/ggreer/the_silver_searcher), Ack (http://beyondgrep.com/), or Grep (http://www.gnu.org/software/grep/). Support for passing options through to the underlying search command exists, along with the ability to use full regular expression syntax without doing special escaping.
13
14 Shortcut mappings are provided to start an <strong>[`:Ack`](#user-content-ack)</strong> search (<leader>a) or to search for the word currently under the cursor (<leader>s).
15
16 Results are normally displayed in the <strong>`quickfix`</strong> window, but Ferret also provides a <strong>[`:Lack`](#user-content-lack)</strong> command that behaves like <strong>[`:Ack`](#user-content-ack)</strong> but uses the <strong>`location-list`</strong> instead, and a <leader>l mapping as a shortcut to <strong>[`:Lack`](#user-content-lack)</strong>.
17
18 Finally, Ferret offers integration with dispatch.vim (https://github.com/tpope/vim-dispatch), which enables asynchronous searching despite the fact that Vim itself is single-threaded.
19
20 ### 2. Streamlined multi-file replace
21
22 The companion to <strong>[`:Ack`](#user-content-ack)</strong> is <strong>[`:Acks`](#user-content-acks)</strong> (mnemonic: "Ack substitute", accessible via shortcut <leader>r), which allows you to run a multi-file replace across all the files placed in the <strong>`quickfix`</strong> window by a previous invocation of <strong>[`:Ack`](#user-content-ack)</strong>.
23
24 ### 3. Quickfix listing enhancements
25
26 The <strong>`quickfix`</strong> listing itself is enhanced with settings to improve its usability, and natural mappings that allow quick removal of items from the list (for example, you can reduce clutter in the listing by removing lines that you don't intend to make changes to).
27
28 Additionally, Vim's <strong>`:cn`</strong>, <strong>`:cp`</strong>, <strong>`:cnf`</strong> and <strong>`:cpf`</strong> commands are tweaked to make it easier to immediately identify matches by centering them within the viewport.
29
30 ### 4. Easy operations on files in the quickfix listing
31
32 Finally, Ferret provides a <strong>[`:Qargs`](#user-content-qargs)</strong> command that puts the files currently in the <strong>`quickfix`</strong> listing into the <strong>`:args`</strong> list, where they can be operated on in bulk via the <strong>`:argdo`</strong> command. This is what's used under the covers by <strong>[`:Acks`](#user-content-acks)</strong> to do its work.
33
34 ## Installation
35
36 To install Ferret, use your plug-in management system of choice.
37
38 If you don't have a "plug-in management system of choice", I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install Ferret into `~/.vim/bundle`, you can do so with:
39
40 ```
41 git clone https://github.com/wincent/ferret.git ~/.vim/bundle/ferret
42 ```
43
44 Alternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:
45
46 ```
47 git submodule add https://github.com/wincent/ferret.git ~/vim/bundle/ferret
48 git submodule init
49 ```
50
51 To generate help tags under Pathogen, you can do so from inside Vim with:
52
53 ```
54 :call pathogen#helptags()
55 ```
56
57 ### `:Ack {pattern} {options}`
58
59 Searches for {pattern} in all the files under the current directory (see <strong>`:pwd`</strong>), unless otherwise overridden via {options}, and displays the results in the <strong>`quickfix`</strong> listing.
60
61 `ag` (The Silver Searcher) will be used preferentially if present on the system, because it is faster, falling back to `ack` and then `grep` as needed.
62
63 If dispatch.vim is installed the search process will run asynchronously via the <strong>`:Make`</strong> command, otherwise it will be run synchronously via <strong>`:cexpr`</strong>. Asynchronous searches are preferred because they do not block, despite the fact that Vim itself is single threaded. The <strong>`g:FerretDispatch`</strong> option can be used to prevent the use of dispatch.vim.
64
65 The {pattern} is passed through as-is to the underlying search program, and no escaping is required other than preceding spaces by a single backslash. For example, to search for "\bfoo[0-9]{2} bar\b" (ie. using `ag`'s Perl-style regular expression syntax), you could do:
66
67 ```
68 :Ack \bfoo[0-9]{2}\ bar\b
69 ```
70
71 Likewise, {options} are passed through. In this example, we pass the `-w` option (to search on word boundaries), and scope the search to the "foo" and "bar" subdirectories: >
72
73 ```
74 :Ack -w something foo bar
75 ```
76
77 As a convenience <leader>a is set-up (<strong>[`<Plug>(FerretAck)`](#user-content-plugferretack)</strong>) as a shortcut to enter <strong>`Cmdline-mode`</strong> with `:Ack` inserted on the <strong>`Cmdline`</strong>. Likewise <leader>s (<strong>[`<Plug>(FerretAckWord)`](#user-content-plugferretackword)</strong>) is a shortcut for running <strong>[`:Ack`](#user-content-ack)</strong> with the word currently under the cursor.
78
79 ### `:Lack {pattern} {options}`
80
81 Just like <strong>[`:Ack`](#user-content-ack)</strong>, but instead of using the <strong>`quickfix`</strong> listing, which is global across an entire Vim instance, it uses the <strong>`location-list`</strong>, which is a per-window construct.
82
83 Note that <strong>[`:Lack`](#user-content-lack)</strong> always runs synchronously via <strong>`:cexpr`</strong>, because dispatch.vim doesn't currently support the <strong>`location-list`</strong>.
84
85 ### `:Acks /{pattern}/{replacement}/`
86
87 Takes all of the files currently in the <strong>`quickfix`</strong> listing and performs a substitution of all instances of {pattern} (a standard Vim search <strong>`pattern`</strong>) by {replacement}.
88
89 A typical sequence consists of an <strong>[`:Ack`](#user-content-ack)</strong> invocation to populate the <strong>`quickfix`</strong> listing and then <strong>[`:Acks`](#user-content-acks)</strong> (mnemonic: "Ack substitute") to perform replacements. For example, to replace "foo" with "bar" across all files in the current directory:
90
91 ```
92 :Ack foo
93 :Acks /foo/bar/
94 ```
95
96 ### `:Qargs`
97
98 This is a utility function that is used by the <strong>[`:Acks`](#user-content-acks)</strong> command but is also generally useful enough to warrant being exposed publicly.
99
100 It takes the files currently in the <strong>`quickfix`</strong> listing and sets them as <strong>`:args`</strong> so that they can be operated on en masse via the <strong>`:argdo`</strong> command.
101
102 ## Mappings
103
104 ### Circumstances where mappings do not get set up
105
106 Note that Ferret will not try to set up the <leader> mappings if any of the following are true:
107
108 - A mapping for already exists.
109 - An alternative mapping for the same functionality has already been set up from a <strong>`.vimrc`</strong>.
110 - The mapping has been suppressed by setting <strong>`g:FerretMap`</strong> to 1 in your <strong>`.vimrc`</strong>.
111
112 ### Mappings specific to the quickfix window
113
114 Additionally, Ferret will set up special mappings in <strong>`quickfix`</strong> listings, unless prevented from doing so by <strong>`g:FerretQFMap`</strong>:
115
116 - `d` (<strong>`visual-mode`</strong>): delete visual selection
117 - `dd` (<strong>`Normal-mode`</strong>): delete current line
118 - `d`{motion} (<strong>`Normal-mode`</strong>): delete range indicated by {motion}
119
120 ### `<Plug>(FerretAck)`
121
122 Ferret maps <leader>a to <strong>[`<Plug>(FerretAck)`](#user-content-plugferretack)</strong>, which triggers the <strong>[`:Ack`](#user-content-ack)</strong> command. To use an alternative mapping instead, create a different one in your <strong>`.vimrc`</strong> instead using <strong>`:nmap`</strong>:
123
124 ```
125 " Instead of <leader>a, use <leader>x.
126 nmap <leader>x <Plug>(FerretAck)
127 ```
128
129 ### `<Plug>(FerretLack)`
130
131 Ferret maps <leader>l to <strong>[`<Plug>(FerretLack)`](#user-content-plugferretlack)</strong>, which triggers the <strong>[`:Lack`](#user-content-lack)</strong> command. To use an alternative mapping instead, create a different one in your <strong>`.vimrc`</strong> instead using <strong>`:nmap`</strong>:
132
133 ```
134 " Instead of <leader>l, use <leader>y.
135 nmap <leader>y <Plug>(FerretLack)
136 ```
137
138 ### `<Plug>(FerretAckWord)`
139
140 Ferret maps <leader>s (mnemonix: "selection) to <strong>[`<Plug>(FerretAckWord)`](#user-content-plugferretackword)</strong>, which uses <strong>[`:Ack`](#user-content-ack)</strong> to search for the word currently under the cursor. To use an alternative mapping instead, create a different one in your <strong>`.vimrc`</strong> instead using <strong>`:nmap`</strong>:
141
142 ```
143 " Instead of <leader>s, use <leader>z.
144 nmap <leader>z <Plug>(FerretAckWord)
145 ```
146
147 ### `<Plug>(FerretAcks)`
148
149 Ferret maps <leader>r (mnemonic: "replace") to <strong>[`<Plug>(FerretAcks)`](#user-content-plugferretacks)</strong>, which triggers the <strong>[`:Acks`](#user-content-acks)</strong> command and fills the prompt with the last search term from Ferret. to use an alternative mapping instead, create a different one in your <strong>`.vimrc`</strong> instead using <strong>`:nmap`</strong>:
150
151 ```
152 " Instead of <leader>r, use <leader>u.
153 nmap <leader>u <Plug>(FerretAcks)
154 ```
155
156 Controls whether to set up the Ferret mappings, such as <strong>[`<Plug>(FerretAck)`](#user-content-plugferretack)</strong> (see <strong>[`ferret-mappings`](#user-content-ferret-mappings)</strong> for a full list). To prevent any mapping from being configured, set to 0:
157
158 ```
159 let g:FerretMap=0
160 ```
161
162 Controls whether to set up custom versions of the <strong>`quickfix`</strong> commands, <strong>`:cn`</strong>, <strong>`:cnf`</strong>, <strong>`:cp`</strong> an <strong>`:cpf`</strong>. These overrides vertically center the match within the viewport on each jump. To prevent the custom versions from being configured, set to 0:
163
164 ```
165 let g:FerretQFCommands=0
166 ```
167
168 ## Custom autocommands
169
170 <p align="right"><a name="ferretdidwrite" href="#user-content-ferretdidwrite"><code>FerretDidWrite</code></a> <a name="ferretwillwrite" href="#user-content-ferretwillwrite"><code>FerretWillWrite</code></a></p>
171 For maximum compatibility with other plug-ins, Ferret runs the following "User" autocommands before and after running the file writing operations during <strong>[`:Acks`](#user-content-acks)</strong>:
172
173 - FerretWillWrite
174 - FerretDidWrite
175
176 For example, to call a pair of custom functions in response to these events, you might do:
177
178 ```
179 autocmd! User FerretWillWrite
180 autocmd User FerretWillWrite call CustomWillWrite()
181 autocmd! User FerretDidWrite
182 autocmd User FerretDidWrite call CustomDidWrite()
183 ```
184
185 ## Overrides
186
187 Ferret overrides the 'grepformat' and 'grepprg' settings, preferentially setting `ag`, `ack` or `grep` as the 'grepprg' (in that order) and configuring a suitable 'grepformat'.
188
189 Additionally, Ferret includes an <strong>`ftplugin`</strong> for the <strong>`quickfix`</strong> listing that adjusts a number of settings to improve the usability of search results.
190
191 <p align="right"><a name="ferret-nolist" href="#user-content-ferret-nolist"><code>ferret-nolist</code></a></p>
192 'nolist'
193
194 Turned off to reduce visual clutter in the search results, and because 'list' is most useful in files that are being actively edited, which is not the case for <strong>`quickfix`</strong> results.
195
196 <p align="right"><a name="ferret-norelativenumber" href="#user-content-ferret-norelativenumber"><code>ferret-norelativenumber</code></a></p>
197 'norelativenumber'
198
199 Turned off, because it is more useful to have a sense of absolute progress through the results list than to have the ability to jump to nearby results (especially seeing as the most common operations are moving to the next or previous file, which are both handled nicely by <strong>`:cnf`</strong> and <strong>`:cpf`</strong> respectively).
200
201 <p align="right"><a name="ferret-nowrap" href="#user-content-ferret-nowrap"><code>ferret-nowrap</code></a></p>
202 'nowrap'
203
204 Turned off to avoid ugly wrapping that makes the results list hard to read, and because in search results, the most relevant information is the filename, which is on the left and is usually visible even without wrapping.
205
206 <p align="right"><a name="ferret-number" href="#user-content-ferret-number"><code>ferret-number</code></a></p>
207 'number'
208
209 Turned on to give a sense of absolute progress through the results.
210
211 <p align="right"><a name="ferret-scrolloff" href="#user-content-ferret-scrolloff"><code>ferret-scrolloff</code></a></p>
212 'scrolloff'
213
214 Set to 0 because the <strong>`quickfix`</strong> listing is usually small by default, so trying to keep the current line away from the edge of the viewpoint is futile; by definition it is usually near the edge.
215
216 <p align="right"><a name="ferret-nocursorline" href="#user-content-ferret-nocursorline"><code>ferret-nocursorline</code></a></p>
217 'nocursorline'
218
219 Turned off to reduce visual clutter.
220
221 To prevent any of these <strong>`quickfix`</strong>-specific overrides from being set up, you can set <strong>`g:FerretQFOptions`</strong> to 0 in your <strong>`.vimrc`</strong>:
222
223 ```
224 let g:FerretQFOptions=0
225 ```
226
227 ## Troubleshooting
228
229 <p align="right"><a name="ferret-quotes" href="#user-content-ferret-quotes"><code>ferret-quotes</code></a></p>
230 ### Ferret fails to find patterns containing spaces
231
232 As described in the documentation for <strong>[`:Ack`](#user-content-ack)</strong>, the search pattern is passed through as-is to the underlying search command, and no escaping is required other than preceding spaces by a single backslash.
233
234 So, to find "foo bar", you would search like:
235
236 ```
237 :Ack foo\ bar
238 ```
239
240 Unescaped spaces in the search are treated as argument separators, so a command like the following means pass the `-w` option through, search for pattern "foo", and limit search to the "bar" directory:
241
242 ```
243 :Ack -w foo bar
244 ```
245
246 Note that including quotes will not do what you intend.
247
248 ```
249  " Search for '"foo' in the 'bar"' directory:
250  :Ack "foo bar"
251
252  " Search for "'foo' in the "bar'" directory:
253  :Ack 'foo bar'
254 ```
255
256 This approach to escaping is taken in order to make it straightfoward to use powerful Perl-compatible regular expression syntax in an unambiguous way without having to worry about shell escaping rules:
257
258 ```
259 :Ack \blog\((['"]).*?\1\) -i --ignore-dir=src/vendor src dist build
260 ```
261
262 ## FAQ
263
264 ### Why do Ferret commands start with "Ack", "Lack" and so on?
265
266 Ferret was originally the thinnest of wrappers (7 lines of code in my <strong>`.vimrc`</strong>) around `ack`. The earliest traces of it can be seen in the initial commit to my dotfiles repo in May, 2009 (https://wt.pe/h).
267
268 So, even though Ferret has a new name now and actually prefers `ag` over `ack` when available, I prefer to keep the command names intact and benefit from years of accumulated muscle-memory.
269
270 ## Related
271
272 Just as Ferret aims to improve the multi-file search and replace experience, Loupe does the same for within-file searching:
273
274 https://github.com/wincent/loupe
275
276 ## Website
277
278 The official Ferret source code repo is at:
279
280 http://git.wincent.com/ferret.git
281
282 A mirror exists at:
283
284 https://github.com/wincent/ferret
285
286 Official releases are listed at:
287
288 http://www.vim.org/scripts/script.php?script_id=5220
289
290 ## License
291
292 Copyright 2015-present Greg Hurrell. All rights reserved.
293
294 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
295
296 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
297
298 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
299
300 ## Development
301
302 ### Contributing patches
303
304 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/ferret/pulls
305
306 ### Cutting a new release
307
308 At the moment the release process is manual:
309
310 - Perform final sanity checks and manual testing
311 - Update the <strong>[`ferret-history`](#user-content-ferret-history)</strong> section of the documentation
312 - Verify clean work tree:
313
314 ```
315 git status
316 ```
317
318 - Tag the release:
319
320 ```
321 git tag -s -m "$VERSION release" $VERSION
322 ```
323
324 - Publish the code:
325
326 ```
327 git push origin master --follow-tags
328 git push github master --follow-tags
329 ```
330
331 - Produce the release archive:
332
333 ```
334 git archive -o ferret-$VERSION.zip HEAD -- .
335 ```
336
337 - Upload to http://www.vim.org/scripts/script.php?script_id=5220
338
339 ## Authors
340
341 Ferret is written and maintained by Greg Hurrell <greg@hurrell.net>.
342
343 The idea for vim-dispatch integration was taken from Miles Sterrett's ack.vim plug-in (https://github.com/mileszs/ack.vim).
344
345 Other contributors that have submitted patches include (in alphabetical order):
346
347 - Daniel Silva
348 - Joe Lencioni
349 - Nelo-Thara Wallus
350 - Vaibhav Sagar
351
352 ## History
353
354 0.3.1 (not yet released)
355
356 - Fix broken <strong>[`:Qargs`](#user-content-qargs)</strong> command (patch from Daniel Silva).
357
358 0.3 (24 July 2015)
359
360 - Added highlighting of search pattern and related <strong>`g:FerretHlsearch`</strong> option (patch from Nelo-Thara Wallus).
361 - Add better error reporting for failed or incorrect searches.
362
363 0.2 (16 July 2015)
364
365 - Added <strong>[`FerretDidWrite`](#user-content-ferretdidwrite)</strong> and <strong>[`FerretWillWrite`](#user-content-ferretwillwrite)</strong> autocommands (patch from Joe Lencioni).
366 - Add <strong>[`<Plug>(FerretAcks)`](#user-content-plugferretacks)</strong> mapping (patch from Nelo-Thara Wallus).
367
368 0.1 (8 July 2015)
369
370 - Initial release, extracted from my dotfiles (https://github.com/wincent/wincent).