/vimagit

A new way to use git within vim

Primary LanguageVim Script

vimagit

This is a new (and hopefully very efficient) way to use git from vim.

From a very single vim buffer, you can perform all basic git operations. To name a few:

  • Visualize all diffs in your git repository.
  • Stage files/hunks/parts of hunks with single key S.
  • Write or amend your commit message and commit.

See a usage example: asciicast

This workflow is 100% inspired from magnificent emacs Magit plugin.

Take a look at TL;DR to start using it immediatly.

Outstanding features

  • See all your changes, staged changes, untracked/removed/renamed files in one unique buffer.
  • Staged/unstaged/discard changes with one key press, moving the cursor around. Stage at hunk or file level. Line and partial line staging are ongoing.
  • Stage part of hunks, by visual select, lines or selecting bunch of lines with marks.
  • Start to write the commit message in one key press, commit also in one key press.
  • Modify in line the content just before staging it.
  • Visualize stashes. Apply, pop, drop are on going.
  • Add file to .gitignore file.
  • Chase all corner cases. Please remember that vimagit is at an early development stage. If you try vimagit and nothing is working, please don't throw it, fill an issue on github ❤️ !

More to come:

  • Vizualize and checkout branches.
  • Go through history, cherry-pick changes.
  • Something is missing? Open an issue!

Why should I use vimagit, there are already plethora git plugins for vim?

  • fugitive is a very complete plugin, with a lot of functions. I use it for years, and it is a fundamental tool in my workflow. But visualize your changes and staged them in broad number of files is really a pain.
  • vim-gitgutter is very well integrated into vim, but without the ability to commit stages, it stays an informational plugin.

Integration

Branches master and next are continuously tested on travis when published on github.

vimagit is tested with various versions of vim on linux: vim 7.3.249, vim 7.4.273, and latest neovim version. It is also tested for macos X: vim, macvim and neovim. Anyway, if you feel that vimagit behaves oddly (slow refresh, weird display order...) please fill an issue.

For the most enthusiastic, you can try the branch next. It is quite stable, just check its travis status before fetching it.

Travis status:

TL;DR

This is the minimal required set of command you must know to start playing with vimagit. See Mapping for a complete description.

:Magit

Open magit buffer.

Enter,<CR>

All files diffs are hidden by default. To inspect changes in a file, move cursor to the filename line, and press 'Enter' in Normal mode. Diffs are displayed below the file name.

S

  • Modify a file, for example foo.c, in your repository.
  • Move the cursor the line 'modfied: foo.c' in "Unstage changes" section, press S in Normal mode: the file is stage, and appears in "Stage changes" section.
  • Move to the line 'modified: foo.c' in "Stage changes" section, press S in Normal mode: the file is unstage, and appears in "Unstaged changes" section.

More about S:

  • It works exactely the same for new/renamed/deleted files.
  • Stage/unstage by hunk is easy: display file diffs with Enter. If diffs are composed of multiple hnuks, move the cursor to a hunk, and press S to stage/unstage this hunk.

CC

Once you have stage all the required changes, press CC. A new section "Commit message" appears and cursor move to it. Type your commit message, in Insert mode this time. Once it's done, go back in Normal mode, and press CC: you created your first commit with vimagit!

Usage

Sections

IMPORTANT: mappings can have different meanings regarding the cursor position.

There are 5 sections:

  • Info: this section display some information about the git repository, like the current branch and the HEAD commit.
  • Commit message: this section appears in commit mode (see below). It contains the message to be commited.
  • Staged changes: this sections contains all staged files/hunks, ready to commit.
  • Unstaged changes: this section contains all unstaged and untracked files/hunks.
  • Stash list: this section contains all stahes.

Inline modifications

  • It is possible to modify the content to be staged or unstaged in magit buffer, with some limitations:
    • only lines starting with a + sign can be modified
    • no line can be deleted

Commands

magit#show_magit()

Function to open magit buffer. It takes 3 parameters:

  • orientation (mandatory): it can be
    • 'v', curent window is split vertically, and magit is displayed in new buffer
    • 'h', curent window is split horizontally, and magit is displayed in new buffer
    • 'c', magit is displayed in current buffer
  • show_all_files: define is file diffs are shown by default for this session (see g:magit_default_show_all_files)
  • foldlevel: set default magit buffer foldlevel for this session (see g:magit_default_fold_level)

:Magit

  • open magit buffer.

Mappings

For each mapping, user can redefine the behavior with its own mapping. Each variable is described in vimagit help like vimagit-g:magit_nameofmapping_mapping

Global mappings

Following mappings are broadly set, and are applied in all vim buffers.

<Leader>M Open Magit buffer

Local mappings

Following mappings are set locally, for magit buffer only, in normal mode.

Enter,<CR>

  • All files are folded by default. To see the changes in a file, move cursor to the filename line, and press Enter. You can close the changes display retyping Enter.

zo,zO

  • Typing zo on a file will unhide its diffs.

zc,zC

  • Typing zc on a file will hide its diffs.

S

  • If cursor is in a hunk, stage/unstage hunk at cursor position.
  • If cursor is in diff header, stage/unstage whole file at cursor position.
  • If some lines in the hunk are selected (using v), stage only visual selected lines (only works for staging).
  • If some lines in the hunk are marked (using M), stage only marked lines (only works for staging).
  • When cursor is in "Unstaged changes" section, it will stage the hunk/file.
  • On the other side, when cursor is in "Staged changes" section, it will unstage hunk/file.

F

  • Stage/unstage the whole file at cursor position.
  • When cursor is in "Unstaged changes" section, it will stage the file.
  • On the other side, when cursor is in "Staged changes" section, it will unstage file.

L

  • Stage the line under the cursor.

M

  • Mark the line under the cursor "to be staged".
  • If some lines in the hunk are selected (using v), mark selected lines "to be staged".
  • To staged marked lines in a hunk, move cursor to this hunk and press S.

DDD

  • If cursor is in a hunk, discard hunk at cursor position.
  • If cursor is in diff header, discard whole file at cursor position.
  • Only works in "Unstaged changes" section.

CC

  • If not in commit section, set commit mode to "New commit" and show "Commit message" section with brand new commit message.
  • If in commit section, commit the all staged changes in commit mode previously set.

:w

  • If in commit section, commit the all staged changes in commit mode previously set.

CA

  • If not in commit section, set commit mode to "Amend commit" and show "Commit message" section with previous commit message.
  • If in commit section, commit the staged changes in commit mode previously set.

CF

  • Amend the staged changes into the previous commit, without modifying previous commit message.

I

  • Add the file under the cursor in .gitgnore

R

  • Refresh magit buffer

q

  • Close the magit buffer

h

  • Toggle help showing in magit buffer

Options

User can define in its prefered |vimrc| some options.

g:magit_enabled

To enable or disable vimagit plugin. Default value is 1.

let g:magit_enabled=[01]

g:magit_show_help

To disable chatty inline help in magit buffer (default 1)

let g:magit_show_help=[01]

g:magit_default_show_all_files

When this variable is set to 0, all diff files are hidden by default. When this variable is set to 1, all diff files are shown by default. Default value is 0. NB: for repository with large number of differences, display may be slow.

let g:magit_default_show_all_files=[01]

g:magit_default_fold_level

Default foldlevel for magit buffer. When set to 0, both filenames and hunks are folded. When set to 1, filenames are unfolded and hunks are folded. When set to 2, filenames and hunks are unfolded. Default value is 1.

let g:magit_default_fold_level=[012]

g:magit_warning_max_lines

This variable is the maximum number of diff lines that vimagit will display without warning the user. If the number of diff lines to display is greater than this variable, vimagit will ask a confirmation to the user before refreshing the buffer. If user answer is 'yes', vimagit will display diff lines as expected. If user answer is 'no', vimagit will close all file diffs before refreshing. Default value is 10000.

let g:magit_warning_max_lines=val

Installation

The plugin hierarchy tree respects the vim plugin standard. It is compatible with pathogen (and most probably vundle).

To install:

cd ~/.vim/bundle
git clone https://github.com/jreybert/vimagit

Requirements

This part must be refined, I don't see any minimal version for git and vim, but for sure there should be one.

At least, it is tested with vim 7.3.249 and git 1.8.5.6 (see Integration).

License

Copyright (c) Jerome Reybert. Distributed under the same terms as Vim itself. See :help license.