fzfx.vim

DEPRECATE: this plugin is no longer actively developed, I created the next generation fzfx.nvim, written with lua and drop the support for VIM.

Sepecial thanks to Bram, VIM changed my life, VIM long live.

E(x)tended fzf commands missing in fzf.vim, focused on better usability and tiny improvements.

• Requirement
  • Rust commands
  • Git, mingw & coreutils (for Windows)
• Install
  • vim-plug
  • packer.nvim
  • lazy.nvim
• Usage
  • Key mapping
• Commands
  • FzfxFiles(UVW)
  • FzfxBuffers(VW)
  • FzfxLiveGrep(UVW)
  • FzfxBranches(VW)
  • FzfxHistoryFiles(VW)
  • FzfxCommands(VW)
• Config
• Credit

• For people using macOS + neovim, you can choose fzf-lua.
• For people working on small repository and don't have performance issue, you can choose telescope.nvim.

Requirement

• Vim ≥ 7.4.1304 or Neovim.
• fzf and fzf.vim.

Rust commands

Recommand to install rust, then install ripgrep, fd, bat via cargo:

cargo install ripgrep
cargo install fd-find
cargo install --locked bat

Git, mingw & coreutils (for Windows)

Since the cmd scripts on Windows are actually implemented by forwarding user input to linux shell scripts, thus we are relying on the embeded shell installed with scoop.

Run PowerShell commands:

# scoop
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

scoop bucket add extras
scoop install git
scoop install mingw
scoop install uutils-coreutils

After this step, git.exe and Linux built-in commands(sh.exe, cp.exe, mv.exe, ls.exe, etc) will be available in %PATH%.

Install

vim-plug

call plug#begin()

Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
Plug 'junegunn/fzf.vim'
Plug 'linrongbin16/fzfx.vim'

call plug#end()

packer.nvim

return require('packer').startup(function(use)

    use { "junegunn/fzf", run = ":call fzf#install()" }
    use { "junegunn/fzf.vim", requires = { "junegunn/fzf" } }
    use {
        "linrongbin16/fzfx.vim",
        requires = { "junegunn/fzf", "junegunn/fzf.vim" },
    }

end)

lazy.nvim

return {

    { "junegunn/fzf", build = ":call fzf#install()" },
    { "junegunn/fzf.vim", dependencies = { "junegunn/fzf" } },
    {
        "linrongbin16/fzfx.vim",
        dependencies = { "junegunn/fzf", "junegunn/fzf.vim" },
    },

}

Usage

Key mapping

For Vim:

" ======== files ========

" find files, filter hidden and ignored files
nnoremap <space>f :\<C-U>FzfxFiles<CR>
" find by visual selected
xnoremap <space>f :\<C-U>FzfxFilesV<CR>
" unrestrictly find files, include hidden and ignored files
nnoremap <space>uf :\<C-U>FzfxFilesU<CR>
" unrestrictly find by visual selected
xnoremap <space>uf :\<C-U>FzfxFilesUV<CR>

" find by cursor word
nnoremap <space>wf :\<C-U>FzfxFilesW<CR>
" unrestrictly find by cursor word
nnoremap <space>uwf :\<C-U>FzfxFilesUW<CR>

" ======== history files ========
nnoremap <space>hf :\<C-U>FzfxHistoryFiles<CR>
" by visual selected
xnoremap <space>hf :\<C-U>FzfxHistoryFilesV<CR>
" by cursor word
nnoremap <space>whf :\<C-U>FzfxHistoryFilesW<CR>

" ======== buffers ========

" find buffers
nnoremap <space>b :\<C-U>FzfxBuffers<CR>
" by visual selected
xnoremap <space>b :\<C-U>FzfxBuffersV<CR>
" by cursor word
nnoremap <space>wb :\<C-U>FzfxBuffersW<CR>

" ======== live grep ========

" live grep, filter hidden and ignored files
nnoremap <space>l :\<C-U>FzfxLiveGrep<CR>
" by visual selected
xnoremap <space>l :\<C-U>FzfxLiveGrepV<CR>
" unrestrictly live grep, include hidden and ignored files
nnoremap <space>ul :\<C-U>FzfxLiveGrepU<CR>
" unrestrictly by visual selected
xnoremap <space>ul :\<C-U>FzfxLiveGrepUV<CR>

" by cursor word
nnoremap <space>wl :\<C-U>FzfxLiveGrepW<CR>
" unrestrictly by cursor word
nnoremap <space>uwl :\<C-U>FzfxLiveGrepUW<CR>

" ======== git branches ========

" search git branches
nnoremap <space>gb :\<C-U>FzfxBranches<CR>
" by visual selected
xnoremap <space>gb :\<C-U>FzfxBranchesV<CR>
" by cursor word
nnoremap <space>wgb :\<C-U>FzfxBranchesW<CR>

" ======== vim commands ========

" search vim commands
nnoremap <space>cm :\<C-U>FzfxCommands<CR>
" by visual selected
xnoremap <space>cm :\<C-U>FzfxCommandsV<CR>
" by cursor word
nnoremap <space>wcm :\<C-U>FzfxCommandsW<CR>

For Neovim:

-- ======== files ========

-- find files, filter hidden and ignored files
vim.keymap.set('n', '<space>f', '<cmd>FzfxFiles<cr>',
        {silent=true, noremap=true, desc="Find files"})
-- by visual selected
vim.keymap.set('x', '<space>f', '<cmd>FzfxFilesV<CR>',
        {silent=true, noremap=true, desc="Find files"})
-- unrestrictly find files, include hidden and ignored files
vim.keymap.set('n', '<space>uf',
        '<cmd>FzfxFilesU<cr>',
        {silent=true, noremap=true, desc="Unrestricted find files"})
-- unrestrictly by visual selected
vim.keymap.set('x', '<space>uf',
        '<cmd>FzfxFilesUV<CR>',
        {silent=true, noremap=true, desc="Unrestricted find files"})

-- by cursor word
vim.keymap.set('n', '<space>wf', '<cmd>FzfxFilesW<cr>',
        {silent=true, noremap=true, desc="Find files by cursor word"})
-- unrestrictly by cursor word
vim.keymap.set('n', '<space>uwf', '<cmd>FzfxFilesUW<cr>',
        {silent=true, noremap=true, desc="Unrestricted find files by cursor word"})

-- ======== history files ========

-- find history files
vim.keymap.set('n', '<space>hf', '<cmd>FzfxHistoryFiles<cr>',
        {silent=true, noremap=true, desc="Find history files"})
-- by visual selected
vim.keymap.set('x', '<space>hf', '<cmd>FzfxHistoryFilesV<CR>',
        {silent=true, noremap=true, desc="Find history files"})
-- by cursor word
vim.keymap.set('n', '<space>whf', '<cmd>FzfxHistoryFilesW<CR>',
        {silent=true, noremap=true, desc="Find history files by cursor word"})

-- ======== buffers ========

-- find buffers
vim.keymap.set('n', '<space>b', '<cmd>FzfxBuffers<cr>',
        {silent=true, noremap=true, desc="Find buffers"})
-- by visual selected
vim.keymap.set('x', '<space>b', '<cmd>FzfxBuffersV<cr>',
        {silent=true, noremap=true, desc="Find buffers"})
-- by cursor word
vim.keymap.set('n', '<space>wb', '<cmd>FzfxBuffersW<cr>',
        {silent=true, noremap=true, desc="Find buffers by cursor word"})

-- ======== live grep ========

-- live grep, filter hidden and ignored files
vim.keymap.set('n', '<space>l',
        '<cmd>FzfxLiveGrep<cr>',
        {silent=true, noremap=true, desc="Live grep"})
-- by visual selected
vim.keymap.set('x', '<space>l',
        "<cmd>FzfxLiveGrepV<cr>",
        {silent=true, noremap=true, desc="Live grep"})
-- unrestrictly live grep, include hidden and ignored files
vim.keymap.set('n', '<space>ul',
        '<cmd>FzfxLiveGrepU<cr>',
        {silent=true, noremap=true, desc="Unrestricted live grep"})
-- unrestrictly by visual selected
vim.keymap.set('x', '<space>ul',
        "<cmd>FzfxLiveGrepUV<cr>",
        {silent=true, noremap=true, desc="Live grep"})

-- by cursor word
vim.keymap.set('n', '<space>wl',
        '<cmd>FzfxLiveGrepW<cr>',
        {silent=true, noremap=true, desc="Live grep under cursor word"})
-- unrestrictly by cursor word
vim.keymap.set('n', '<space>uwl',
        '<cmd>FzfxLiveGrepUW<cr>',
        {silent=true, noremap=true, desc="Unrestricted live grep under cursor word"})

-- ======== git branches ========

-- search git branches
vim.keymap.set('n', '<space>gb', '<cmd>FzfxBranches<cr>',
        {silent=true, noremap=true, desc="Search git branches"})
-- by visual selected
vim.keymap.set('x', '<space>gb', '<cmd>FzfxBranchesV<cr>',
        {silent=true, noremap=true, desc="Search git branches"})
-- by cursor word
vim.keymap.set('n', '<space>wgb', '<cmd>FzfxBranchesW<cr>',
        {silent=true, noremap=true, desc="Search git branches by cursor word"})

-- ======== vim commands ========

-- search vim commands
vim.keymap.set('n', '<space>cm', '<cmd>FzfxCommands<cr>',
        {silent=true, noremap=true, desc="Search vim commands"})
-- by visual selected
vim.keymap.set('x', '<space>cm', '<cmd>FzfxCommandsV<cr>',
        {silent=true, noremap=true, desc="Search vim commands"})
-- by cursor word
vim.keymap.set('n', '<space>wcm', '<cmd>FzfxCommandsW<cr>',
        {silent=true, noremap=true, desc="Search vim commands by cursor word"})

Commands

The variants are named following below rules:

• Unrestricted searching (include hidden and ignored files) variants use U suffix.
• Searching by visual selection variants use V suffix.
• Searching by cursor word variants use W suffix.

FzfxFiles(UVW)

https://github.com/linrongbin16/fzfx.vim/assets/6496887/4bc44577-345c-4b71-bd2f-f262d39bff9b

• FzfxFiles is almost the same with (Fzf)Files, except it's using fd command:

  # short version
  fd -cnever -tf -tl -L -i
  # e.g.
  fd --color=never --type f --type symlink --follow --ignore-case
  

  It also respect git ignored files and hidden files (start with .).

• FzfxFilesU is a variant of FzfxFiles, except it searches everything include git ignored and hidden files.

• FzfxFiles(U)V is a variant of FzfxFiles(U), except it searches by visual selection.

• FzfxFiles(U)W is a variant of FzfxFiles(U), except it searches by cursor word, e.g. expand('<cword>').

• FzfxResumeFiles can resume last files search (include all above variants).

Note: in following sections, no more duplicated writings on U, V and W since they work almost the same way.

FzfxBuffers(VW)

https://github.com/linrongbin16/fzfx.vim/assets/6496887/1864fde1-0cba-40d2-8e53-b72140fb7675

• FzfxBuffers(VW) is almost the same with (Fzf)Buffers, except it's using ctrl-d to delete buffers.

FzfxLiveGrep(UVW)

https://github.com/linrongbin16/fzfx.vim/assets/6496887/24f936fe-50cc-48fe-b8e5-c0847c5f546a

• FzfxLiveGrep(UVW) is almost the same with (Fzf)RG, except:

  1. it's using rg command:

     rg --column -n --no-heading --color=always -S
     # e.g.
     rg --column --line-number --no-heading --color=always --smart-case
     

     Note: the unrestricted variants add -uu options.

  2. it allows user add rg's raw options by parsing -- flag, treat the left part as query content, the right side as rg's raw options. A most common use case is searching by file type (via --glob or --iglob option), for example input fzf -- -g '*.lua' will search on lua files.

• FzfxResumeLiveGrep can resume last live grep (include all above variants).

FzfxBranches(VW)

https://github.com/linrongbin16/fzfx.vim/assets/6496887/e4b3e4b9-9b38-4fd7-bb8b-b7946fc49232

• FzfxBranches(VW) can search git branches, and use ENTER to switch to the selected branch.

FzfxHistoryFiles(VW)

• FzfxHistoryFiles(VW) is almost the same with (Fzf)History, except it add highlight colors and last modified time.

FzfxCommands(VW)

https://github.com/linrongbin16/fzfx.vim/assets/6496887/c67c404e-06c7-4e00-b10e-d2cc9d0e8966

• FzfxCommands(VW) is almost the same with (Fzf)Commands, except it can preview lua function defined commands for Neovim.

Config

Here're some global variables that you can speicify:

""" enable debug
let g:_fzfx_enable_debug = 0

""" files
let g:fzfx_find_command = (executable('fd') ? 'fd' : 'fdfind').' . --color=never --type f --type symlink --follow --ignore-case'
let g:fzfx_unrestricted_find_command = (executable('fd') ? 'fd' : 'fdfind').' . --color=never --type f --type symlink --follow --ignore-case --unrestricted'

""" live grep
let g:fzfx_grep_command = 'rg --column --line-number --no-heading --color=always --smart-case'
let g:fzfx_unrestricted_grep_command = 'rg --column --line-number --no-heading --color=always --smart-case --unrestricted --unrestricted'
" live grep action keys
let g:fzfx_live_grep_fzf_mode_action = 'ctrl-f'
let g:fzfx_live_grep_rg_mode_action = 'ctrl-r'

""" git branches
let g:fzfx_git_branch_command = 'git branch -a --color'

""" buffers
let g:fzfx_buffers_close_action = 'ctrl-d'

""" history files
let g:fzfx_ignored_history_filetypes = {
    \ 'NvimTree': 1,
    \ 'neo-tree': 1,
    \ 'CHADTree': 1,
    \ 'undotree': 1,
    \ 'diff': 1,
    \ 'vista': 1,
    \ 'qf': 1,
    \ }

""" resume cache dir
let g:fzfx_resume_cache_dir = has('nvim') ? stdpath('data').'/fzfx.vim' : '~/.cache/vim/fzfx.vim'

Credit

• fzf.vim: Things you can do with fzf and Vim.
• fzf-lua: Improved fzf.vim written in lua.

Contribute

Please open issue/PR for anything about fzfx.vim.

Like fzfx.vim? Consider