Ⅰ. 插件描述

fzf :heart: vim

Ⅱ. 基本信息

创建日期： 2015-08-14

使用用户： 8115

Github星： 4554

插件作者： Junegunn Choi

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'junegunn/fzf-vim'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'junegunn/fzf-vim'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'junegunn/fzf-vim'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/junegunn/fzf.vim

Ⅳ. 文档说明

fzf :heart: vim

Things you can do with fzf and Vim.

Rationale

fzf in itself is not a Vim plugin, and the official repository only
provides the basic wrapper function for Vim and it's up to the users to
write their own Vim commands with it. However, I've learned that many users of
fzf are not familiar with Vimscript and are looking for the "default"
implementation of the features they can find in the alternative Vim plugins.

This repository is a bundle of fzf-based commands and mappings extracted from
my .vimrc to address such needs. They are not designed to be
flexible or configurable, and there's no guarantee of backward-compatibility.

Why you should use fzf on Vim

Because you can and you love fzf.

fzf runs asynchronously and can be orders of magnitude faster than similar Vim

However, the benefit may not be noticeable if the size of the input
small, which is the case for many of the commands provided here.

Nevertheless I wrote them anyway since it's really easy to implement custom
selector with fzf.

Installation

fzf.vim depends on the basic Vim plugin of [the main fzf
repository][fzf-main], which means you need to **set up both "fzf" and
"fzf.vim" on Vim**. To learn more about fzf/Vim integration, see
README-VIM.

Using vim-plug

Plug 'junegunn/fzf', { 'do': './install --bin' }
Plug 'junegunn/fzf.vim'

Make sure to use Vim 7.4 or above
The do option makes sure that you have the latest version of fzf binary
If you have already installed fzf using Homebrew, and do
not wish to have another copy on your system, replace the first line with

Plug '/usr/local/opt/fzf'

If you want to set up fzf globally on your system only using vim-plug, you
can write Plug 'junegunn/fzf', { 'do': './install --all' }

Commands

Command	List
`:Files [PATH]`	Files (similar to `:FZF`)
`:GFiles [OPTS]`	Git files (`git ls-files`)
`:GFiles?`	Git files (`git status`)
`:Buffers`	Open buffers
`:Colors`	Color schemes
`:Ag [PATTERN]`	ag search result (`ALT-A` to select all, `ALT-D` to deselect all)
`:Rg [PATTERN]`	rg search result (`ALT-A` to select all, `ALT-D` to deselect all)
`:Lines [QUERY]`	Lines in loaded buffers
`:BLines [QUERY]`	Lines in the current buffer
`:Tags [QUERY]`	Tags in the project (`ctags -R`)
`:BTags [QUERY]`	Tags in the current buffer
`:Marks`	Marks
`:Windows`	Windows
`:Locate PATTERN`	`locate` command output
`:History`	`v:oldfiles` and open buffers
`:History:`	Command history
`:History/`	Search history
`:Snippets`	Snippets (UltiSnips)
`:Commits`	Git commits (requires fugitive.vim)
`:BCommits`	Git commits for the current buffer
`:Commands`	Commands
`:Maps`	Normal mode mappings
`:Helptags`	Help tags ¹
`:Filetypes`	File types

Most commands support CTRL-T / CTRL-X / CTRL-V key
bindings to open in a new tab, a new split, or in a new vertical split
Bang-versions of the commands (e.g. Ag!) will open fzf in fullscreen
You can set g:fzf_command_prefix to give the same prefix to the commands
- e.g. let g:fzf_command_prefix = 'Fzf' and you have FzfFiles, etc.

(1: Helptags will shadow the command of the same name
from pathogen. But its functionality is still available via `call
pathogen#helptags()`. ↩)

Customization

Global options

Every command in fzf.vim internally calls fzf#wrap function of the main
repository which supports a set of global option variables. So please read
through README-VIM to learn more about them.

Command-local options

A few commands in fzf.vim can be customized with global option variables shown
below.

" [Buffers] Jump to the existing window if possible
let g:fzf_buffers_jump = 1

" [[B]Commits] Customize the options used by 'git log':
let g:fzf_commits_log_options = '--graph --color=always --format="%C(auto)%h%d %s %C(black)%C(bold)%cr"'

" [Tags] Command to generate tags file
let g:fzf_tags_command = 'ctags -R'

" [Commands] --expect expression for directly executing the command
let g:fzf_commands_expect = 'alt-enter,ctrl-x'

Advanced customization

Vim functions

Each command in fzf.vim is backed by a Vim function. You can override
a command or define a variation of it by calling its corresponding function.

Command	Vim function
`Files`	`fzf#vim#files(dir, [spec dict], [fullscreen bool])`
`GFiles`	`fzf#vim#gitfiles(git_options, [spec dict], [fullscreen bool])`
`GFiles?`	`fzf#vim#gitfiles('?', [spec dict], [fullscreen bool])`
`Buffers`	`fzf#vim#buffers([spec dict], [fullscreen bool])`
`Colors`	`fzf#vim#colors([spec dict], [fullscreen bool])`
`Rg`	`fzf#vim#grep(command, [has_column bool], [spec dict], [fullscreen bool])`
...	...

(We can see that the last two optional arguments of each function are

They are directly passed to fzf#wrap function. If you haven't
README-VIM already, please read it before proceeding.)

Example: Customizing `Files` command

This is the default definition of Files command:

command! -bang -nargs=? -complete=dir Files call fzf#vim#files(<q-args>, <bang>0)

Let's say you want to a variation of it called ProjectFiles that only
searches inside ~/projects directory. Then you can do it like this:

command! -bang ProjectFiles call fzf#vim#files('~/projects', <bang>0)

Or, if you want to override the command with different fzf options, just pass
a custom spec to the function.

command! -bang -nargs=? -complete=dir Files
    \ call fzf#vim#files(<q-args>, {'options': ['--layout=reverse', '--info=inline']}, <bang>0)

Want a preview window?

command! -bang -nargs=? -complete=dir Files
    \ call fzf#vim#files(<q-args>, {'options': ['--layout=reverse', '--info=inline', '--preview', 'cat {}']}, <bang>0)

It kind of works, but you probably want a nicer previewer program than cat.
fzf.vim ships a versatile preview script you can readily

It internally executes bat for syntax
highlighting, so make sure to install it.

command! -bang -nargs=? -complete=dir Files
    \ call fzf#vim#files(<q-args>, {'options': ['--layout=reverse', '--info=inline', '--preview', '~/.vim/plugged/fzf.vim/bin/preview.sh {}']}, <bang>0)

However, it's not ideal to hard-code the path to the script which can be
different in different circumstances. So in order to make it easier to set up
the previewer, fzf.vim provides fzf#vim#with_preview helper function.
Similarly to fzf#wrap, it takes a spec dictionary and returns a copy of it
with additional preview options.

command! -bang -nargs=? -complete=dir Files
    \ call fzf#vim#files(<q-args>, fzf#vim#with_preview({'options': ['--layout=reverse', '--info=inline']}), <bang>0)

You can just omit the spec argument if you only want the previewer.

command! -bang -nargs=? -complete=dir Files
    \ call fzf#vim#files(<q-args>, fzf#vim#with_preview(), <bang>0)

Example: `git grep` wrapper

The following example implements GGrep command that works similarly to
predefined Ag or Rg using fzf#vim#grep.

The second argument to fzf#vim#grep is 0 (false), because git grep does
not print column numbers.
We set the base directory to git root by setting dir attribute in spec
dictionary.
The preview script supports grep format
(FILE_PATH:LINE_NO:...), so we can just wrap the spec with

fzf#vim#with_preview as before to enable previewer.

command! -bang -nargs=* GGrep
  \ call fzf#vim#grep(
  \   'git grep --line-number '.shellescape(<q-args>), 0,
  \   fzf#vim#with_preview({'dir': systemlist('git rev-parse --show-toplevel')[0]}), <bang>0)

Example: `Rg` command with preview window

You can see the definition of Rg command with :command Rg. With the
information, you can redefine it with the preview window enabled. In this
case, we're only interested in setting up the preview window, so we will omit
the spec argument to fzf#vim#preview.

command! -bang -nargs=* Rg
  \ call fzf#vim#grep(
  \   'rg --column --line-number --no-heading --color=always --smart-case '.shellescape(<q-args>), 1,
  \   fzf#vim#with_preview(), <bang>0)

Example: Advanced ripgrep integration

In the default implementation of Rg, ripgrep process starts only once with
the initial query (e.g. :Rg foo) and fzf filters the output of the process.

This is okay in most cases because fzf is quite performant even with millions
of lines, but we can make fzf completely delegate its search responsibliity to
ripgrep process by making it restart ripgrep whenever the query string is

In this scenario, fzf becomes a simple selector interface rather than
"fuzzy finder".

We will name the new command all-uppercase RG so we can still access the
default version.
--bind 'change:reload:rg ... {q}' will make fzf restart ripgrep process
whenever the query string, denoted by {q}, is changed.
With --phony option, fzf will no longer perform search. The query string
you type on fzf prompt is only used for restarting ripgrep process.
Also note that we enabled previewer with fzf#vim#with_preview.

function! RipgrepFzf(query, fullscreen)
  let command_fmt = 'rg --column --line-number --no-heading --color=always --smart-case %s || true'
  let initial_command = printf(command_fmt, shellescape(a:query))
  let reload_command = printf(command_fmt, '{q}')
  let spec = {'options': ['--phony', '--query', a:query, '--bind', 'change:reload:'.reload_command]}
  call fzf#vim#grep(initial_command, 1, fzf#vim#with_preview(spec), a:fullscreen)
endfunction

command! -nargs=* -bang RG call RipgrepFzf(<q-args>, <bang>0)

Mappings

Mapping	Description
`<plug>(fzf-maps-n)`	Normal mode mappings
`<plug>(fzf-maps-i)`	Insert mode mappings
`<plug>(fzf-maps-x)`	Visual mode mappings
`<plug>(fzf-maps-o)`	Operator-pending mappings
`<plug>(fzf-complete-word)`	`cat /usr/share/dict/words`
`<plug>(fzf-complete-path)`	Path completion using `find` (file + dir)
`<plug>(fzf-complete-file)`	File completion using `find`
`<plug>(fzf-complete-file-ag)`	File completion using `ag`
`<plug>(fzf-complete-line)`	Line completion (all open buffers)
`<plug>(fzf-complete-buffer-line)`	Line completion (current buffer only)

Usage

" Mapping selecting mappings
nmap <leader><tab> <plug>(fzf-maps-n)
xmap <leader><tab> <plug>(fzf-maps-x)
omap <leader><tab> <plug>(fzf-maps-o)

" Insert mode completion
imap <c-x><c-k> <plug>(fzf-complete-word)
imap <c-x><c-f> <plug>(fzf-complete-path)
imap <c-x><c-j> <plug>(fzf-complete-file-ag)
imap <c-x><c-l> <plug>(fzf-complete-line)

" Advanced customization using Vim function
inoremap <expr> <c-x><c-k> fzf#vim#complete#word({'left': '15%'})

Completion helper

fzf#vim#complete is a helper function for creating custom fuzzy completion
using fzf. If the first parameter is a command string or a Vim list, it will
be used as the source.

" Replace the default dictionary completion with fzf-based fuzzy completion
inoremap <expr> <c-x><c-k> fzf#vim#complete('cat /usr/share/dict/words')

For advanced uses, you can pass an options dictionary to the function. The set
of options is pretty much identical to that for fzf#run only with the
following exceptions:

reducer (funcref)
- Reducer transforms the output lines of fzf into a single string value
prefix (string or funcref; default: \k*$)
- Regular expression pattern to extract the completion prefix
- Or a function to extract completion prefix
Both source and options can be given as funcrefs that take the
completion prefix as the argument and return the final value
sink or sink* are ignored

" Global line completion (not just open buffers. ripgrep required.)
inoremap <expr> <c-x><c-l> fzf#vim#complete(fzf#wrap({
  \ 'prefix': '^.*$',
  \ 'source': 'rg -n ^ --color always',
  \ 'options': '--ansi --delimiter : --nth 3..',
  \ 'reducer': { lines -> join(split(lines[0], ':\zs')[2:], '') }}))

Reducer example

function! s:make_sentence(lines)
  return substitute(join(a:lines), '^.', '\=toupper(submatch(0))', '').'.'
endfunction

inoremap <expr> <c-x><c-s> fzf#vim#complete({
  \ 'source':  'cat /usr/share/dict/words',
  \ 'reducer': function('<sid>make_sentence'),
  \ 'options': '--multi --reverse --margin 15%,0',
  \ 'left':    20})

Status line of terminal buffer

When fzf starts in a terminal buffer (see fzf/README-VIM.md), you
may want to customize the statusline of the containing buffer.

Hide statusline

autocmd! FileType fzf set laststatus=0 noshowmode noruler
  \| autocmd BufLeave <buffer> set laststatus=2 showmode ruler

Custom statusline

function! s:fzf_statusline()
  " Override statusline as you like
  highlight fzf1 ctermfg=161 ctermbg=251
  highlight fzf2 ctermfg=23 ctermbg=251
  highlight fzf3 ctermfg=237 ctermbg=251
  setlocal statusline=%#fzf1#\ >\ %#fzf2#fz%#fzf3#f
endfunction

autocmd! User FzfStatusLine call <SID>fzf_statusline()

License

MIT

Vim插件网

fzf.vim

Ⅰ. 插件描述

Ⅱ. 基本信息

Ⅲ. 安装方法

使用Vundle管理器安装

使用NeoBundle管理器安装

使用VimPlug管理器安装

使用Pathogen管理器安装

Ⅳ. 文档说明

fzf :heart: vim

Rationale

Why you should use fzf on Vim

Installation

Using vim-plug

Commands

Customization

Global options

Command-local options

Advanced customization

Vim functions

Example: Customizing `Files` command

Example: `git grep` wrapper

Example: `Rg` command with preview window

Example: Advanced ripgrep integration

Mappings

Usage

Completion helper

Reducer example

Status line of terminal buffer

Hide statusline

Custom statusline

License

添加新评论

Ⅰ. 插件描述

Ⅱ. 基本信息

Ⅲ. 安装方法

使用Vundle管理器安装

使用NeoBundle管理器安装

使用VimPlug管理器安装

使用Pathogen管理器安装

Ⅳ. 文档说明

fzf :heart: vim

Rationale

Why you should use fzf on Vim

Installation

Using vim-plug

Commands

Customization

Global options

Command-local options

Advanced customization

Vim functions

Example: Customizing Files command

Example: git grep wrapper

Example: Rg command with preview window

Example: Advanced ripgrep integration

Mappings

Usage

Completion helper

Reducer example

Status line of terminal buffer

Hide statusline

Custom statusline

License

添加新评论

Example: Customizing `Files` command

Example: `git grep` wrapper

Example: `Rg` command with preview window