Seburath / fzf-checkout.vim

Checkout branches and tags with fzf

fzf-checkout.vim

Checkout branches and tags with fzf.

Installation

Install using vim-plug. Put this in your init.vim.

Plug 'stsewd/fzf-checkout.vim'

Note: You need to have fzf installed in addition to use this plugin. See https://github.com/junegunn/fzf/blob/master/README-VIM.md#installation.

Usage

Call :GCheckout or GCheckoutTag to checkout to a branch or tag.

Features

• The current branch or commit will be show at the bottom
• The first item on the list will be the previous branch
• Press alt-enter to track a remote branch locally (origin/foo becomes foo)
• Press ctrl-n to create a branch or tag with the current query as name
• Press ctrl-d to delete a branch or tag

Configuration

If you have fzf.vim installed, this plugin will respect your g:fzf_command_prefix setting.

g:fzf_checkout_git_bin

Name of the git binary.

let g:fzf_checkout_git_bin = 'git'

g:fzf_checkout_git_options

Additional options to pass to the git command. It is not recommended to change the --color and --format parameters, as they are used by the plugin and changing them may break something.

let g:fzf_checkout_git_options = ''

g:fzf_checkout_track_key

Key used to track the remote branch locally (git checkout --track branch).

let g:fzf_checkout_track_key = 'alt-enter'

g:fzf_checkout_create_key

Key used to create a branch (git checkout -b branch).

let g:fzf_checkout_create_key = 'ctrl-n'

g:fzf_checkout_delete_key

Key used to delete a branch (git branch -D branch).

let g:fzf_checkout_delete_key = 'ctrl-d'

g:fzf_checkout_previous_ref_first

Display previously used branch first independent of specified sorting.

let g:fzf_checkout_previous_ref_first = v:true

g:fzf_checkout_execute

Command used to execute the checkout, options are:

• system: Uses the system() function (default).
• terminal: Uses the terminal command (it works on Neovim only).
• bang: Makes use of !command.

let g:fzf_checkout_execute = 'system'

If you provide a different string as the option, it will be executed to checkout the branch or tag. {git} and {branch} are replaced with the g:fzf_checkout_git_bin and the branch or tag to checkout.

let g:fzf_checkout_execute = 'echo system("{git} checkout {branch}")'

g:fzf_checkout_track_execute

Same as g:fzf_checkout_execute, but it's used when tracking a branch.

let g:fzf_checkout_track_execute = 'system'

This is the same as:

let g:fzf_checkout_track_execute = 'echo system("{git} checkout --track {branch}")'

g:fzf_checkout_create_execute

Same as g:fzf_checkout_execute, but used to create a branch.

let g:fzf_checkout_create_execute = 'system'

This is the same as:

let g:fzf_checkout_create_execute = 'echo system("{git} checkout -b {branch}")'

g:fzf_checkout_create_tag_execute

Same as g:fzf_checkout_execute, but used to create a tag.

let g:fzf_checkout_create_tag_execute = 'system'

This is the same as:

let g:fzf_checkout_create_tag_execute = 'echo system("{git} tag {branch}")'

g:fzf_checkout_delete_execute

Same as g:fzf_checkout_execute, but used to delete a branch.

let g:fzf_checkout_delete_execute = 'system'

This is the same as:

let g:fzf_checkout_delete_execute = 'echo system("{git} branch -D {branch}")'

g:fzf_checkout_delete_tag_execute

Same as g:fzf_checkout_execute, but used to delete a tag.

let g:fzf_checkout_delete_tag_execute = 'system'

This is the same as:

let g:fzf_checkout_delete_tag_execute = 'echo system("{git} tag -d {branch}")'

Examples

Prefix commands with Fzf, i.e, FzfGCheckout and FzfGCheckoutTag.

let g:fzf_command_prefix = 'Fzf'

Sort branches/tags by committer date. Minus sign to show in reverse order (recent first).

let g:fzf_checkout_git_options = '--sort=-committerdate'