Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stsewd/fzf-checkout.vim
Manage branches and tags with fzf
https://github.com/stsewd/fzf-checkout.vim
branch fzf git hacktoberfest neovim-plugin tag vim-plugin
Last synced: 3 days ago
JSON representation
Manage branches and tags with fzf
- Host: GitHub
- URL: https://github.com/stsewd/fzf-checkout.vim
- Owner: stsewd
- License: mit
- Created: 2020-03-07T09:40:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-05T00:59:29.000Z (about 1 year ago)
- Last Synced: 2024-05-21T11:24:33.314Z (6 months ago)
- Topics: branch, fzf, git, hacktoberfest, neovim-plugin, tag, vim-plugin
- Language: Vim Script
- Homepage:
- Size: 76.2 KB
- Stars: 208
- Watchers: 5
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# fzf-checkout.vim
[](https://github.com/stsewd/fzf-checkout.vim/actions?query=workflow%3ACI+branch%3Amaster)
[](https://github.com/stsewd/fzf-checkout.vim/actions?query=workflow%3Alinter+branch%3Amaster)
Manage branches and tags with [fzf](https://github.com/junegunn/fzf).
https://user-images.githubusercontent.com/4975310/209593694-46901dd3-6d26-486f-aa66-12321b87145c.mov
# Requirements
- `fzf`, see
- `git >=2.13.7`
# Installation
Install using [vim-plug](https://github.com/junegunn/vim-plug).
Put this in your `init.vim`.
```vim
Plug 'stsewd/fzf-checkout.vim'
```
## Features
- The current branch or commit will be show at the bottom
- The first item on the list will be the previous branch/tag
- Press `alt-enter` to track a remote branch locally (`origin/foo` becomes `foo`)
- Press `ctrl-b` to create a branch or tag with the current query as name
- Press `ctrl-d` to delete a branch or tag
- Press `ctrl-e` to merge a branch
- Press `ctrl-r` to rebase a branch
- Ask for confirmation for irreversible actions like delete
- Asynchronously execution of commands (Neovim only)
- Define your own actions
# Usage
Call `:GBranches [action] [filter]` or `:GTags [action]` to execute an action over a branch or tag.
If no action is given, you can make use of defined keymaps to execute an action.
# Commands and settings
See [`:h fzf-checkout`](doc/fzf-checkout.txt) for a list of all available commands and settings.
If you have [fzf.vim](https://github.com/junegunn/fzf.vim) installed,
this plugin will respect your `g:fzf_command_prefix` setting.
# Examples
Prefix commands with `Fzf`, i.e, `FzfGBranches` and `FzfGTags`:
```vim
let g:fzf_command_prefix = 'Fzf'
```
Sort branches/tags by committer date. Minus sign to show in reverse order (recent first):
```vim
let g:fzf_checkout_git_options = '--sort=-committerdate'
```
Override the mapping to delete a branch with `ctrl-r`:
```vim
let g:fzf_branch_actions = {
\ 'delete': {'keymap': 'ctrl-r'},
\}
```
Use the bang command to checkout a tag:
```vim
let g:fzf_tag_actions = {
\ 'checkout': {'execute': '!{git} -C {cwd} checkout {branch}'},
\}
```
Define a _diff_ action using [fugitive](https://github.com/tpope/vim-fugitive).
You can use it with `:GBranches diff` or with `:GBranches` and pressing `ctrl-f`:
```vim
let g:fzf_branch_actions = {
\ 'diff': {
\ 'prompt': 'Diff> ',
\ 'execute': 'Git diff {branch}',
\ 'multiple': v:false,
\ 'keymap': 'ctrl-f',
\ 'required': ['branch'],
\ 'confirm': v:false,
\ },
\}
```
Define checkout as the only action for branches:
```vim
let g:fzf_checkout_merge_settings = v:false
let g:fzf_branch_actions = {
\ 'checkout': {
\ 'prompt': 'Checkout> ',
\ 'execute': function('fzf_checkout#run', ['{git} -C {cwd} checkout {branch}']),
\ 'multiple': v:false,
\ 'keymap': 'enter',
\ 'required': ['branch'],
\ 'confirm': v:false,
\ },
\}
```
List the branch/tag information in one line without preview:
```vim
let g:fzf_checkout_view_mode = 'inline'
```
Use `git diff` for preview instead of `git show`:
```vim
let g:fzf_checkout_preview_cmd = '{git} -C {cwd} diff --color=always {1} --'
```
Show the branch/tag name only:
```vim
let g:fzf_checkout_view_mode = 'inline'
let g:fzf_checkout_git_options = "--format='%(color:yellow)%(refname:short)'"
```