fzf.vim


Ⅰ. 插件描述

fzf :heart: vim

Ⅱ. 基本信息

创建日期:  2015-09-30
使用用户:  3
Github星:  0
插件作者:  Egor Kovetskiy

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'kovetskiy/fzf-vim-be-who-we-are'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'kovetskiy/fzf-vim-be-who-we-are'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'kovetskiy/fzf-vim-be-who-we-are'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/kovetskiy/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

  1. However, the benefit may not be noticeable if the size of the input
  2. 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.

fzf is an independent command-line program and thus requires an external
terminal emulator when on GVim. You may or may not like the experience. Also
note that fzf currently does not compile on Windows.

Installation

Using vim-plug:

Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
Plug 'junegunn/fzf.vim'
  • dir option is not mandatory
  • Use ./install --bin instead if you don't need fzf outside of Vim
  • Make sure to use Vim 7.4 or above

Commands

CommandList
Files [PATH]Files (similar to :FZF)
GFiles [OPTS]Git files (git ls-files)
GFiles?Git files (git status)
BuffersOpen buffers
ColorsColor schemes
Ag [PATTERN]ag 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
MarksMarks
WindowsWindows
Locate PATTERNlocate command output
Historyv:oldfiles and open buffers
History:Command history
History/Search history
SnippetsSnippets (UltiSnips)
CommitsGit commits (requires fugitive.vim)
BCommitsGit commits for the current buffer
CommandsCommands
MapsNormal mode mappings
HelptagsHelp tags 1
FiletypesFile 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

" This is the default extra key bindings
let g:fzf_action = {
  \ 'ctrl-t': 'tab split',
  \ 'ctrl-x': 'split',
  \ 'ctrl-v': 'vsplit' }

" Default fzf layout
" - down / up / left / right
" - window (nvim only)
let g:fzf_layout = { 'down': '~40%' }

" Customize fzf colors to match your color scheme
let g:fzf_colors =
\ { 'fg':      ['fg', 'Normal'],
  \ 'bg':      ['bg', 'Normal'],
  \ 'hl':      ['fg', 'Comment'],
  \ 'fg+':     ['fg', 'CursorLine', 'CursorColumn', 'Normal'],
  \ 'bg+':     ['bg', 'CursorLine', 'CursorColumn'],
  \ 'hl+':     ['fg', 'Statement'],
  \ 'info':    ['fg', 'PreProc'],
  \ 'prompt':  ['fg', 'Conditional'],
  \ 'pointer': ['fg', 'Exception'],
  \ 'marker':  ['fg', 'Keyword'],
  \ 'spinner': ['fg', 'Label'],
  \ 'header':  ['fg', 'Comment'] }

Command-local options

" [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'

Advanced customization using autoload functions

You can use autoload functions to define your own commands.

autocmd VimEnter * command! Colors
  \ call fzf#vim#colors({'left': '15%', 'options': '--reverse --margin 30%,0'})

Mappings

MappingDescription
<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 autoload functions
inoremap <expr> <c-x><c-k> fzf#vim#complete#word({'left': '15%'})

Completion helper

fzf#complete is a helper function for creating custom fuzzy completion using

  1. If the first parameter is a command string or a Vim list, it will be used
  2. the source.
" Replace the default dictionary completion with fzf-based fuzzy completion
inoremap <expr> <c-x><c-k> fzf#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 not allowed

Reducer example

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

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

Status line (neovim)

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

添加新评论