A Sublime Text 2/3 plugin to see git diff in gutter
Python Ruby CSS Other
Latest commit 6c91ef4 May 18, 2017 @alfunx alfunx committed on GitHub Fixed a small typo
Permalink
Failed to load latest commit information.
.github Feature: Add support information module and ISSUE_TEMPLATE. May 12, 2017
modules Fixed a small typo May 18, 2017
release_messages Cut 1.6.0 Apr 29, 2017
tests Internal: Move promise.py into modules subdirectory. Feb 23, 2017
themes Fix: Default theme icon resolution and visibility May 14, 2017
.gitattributes Enhancement: Reduce package size May 13, 2017
.gitignore Internal: Fix some pylint errors and sort imports. Feb 25, 2017
Default (Linux).sublime-keymap Feature: Add 'Compare against file commit' and enable filtering by co… Jan 31, 2017
Default (OSX).sublime-keymap Feature: Add 'Compare against file commit' and enable filtering by co… Jan 31, 2017
Default (Windows).sublime-keymap Feature: Add 'Compare against file commit' and enable filtering by co… Jan 31, 2017
Default.sublime-commands Feature: Add support information module and ISSUE_TEMPLATE. May 12, 2017
GitGutter.sublime-settings Internal: Fix typo in GitGutter.sublime-settings Apr 22, 2017
LICENSE update license Dec 12, 2012
Main.sublime-menu Feature: Add support information module and ISSUE_TEMPLATE. May 12, 2017
README.md README: Add some information to the troubleshooting section. May 12, 2017
dependencies.json Readd dependencies to >=3080 entry Feb 4, 2017
gitgutter_popup.css Improve the css readability by directly writing the class Feb 23, 2017
makefile Create build tool for releases Jun 18, 2015
messages.json Cut 1.6.0 Apr 29, 2017
plugin.py Internal: Add module reloader. Apr 21, 2017
screenshot.png Add screenshot Dec 11, 2012
unittesting.json Revert a bunch of latest fixes due to missing review and some regress… Dec 4, 2016

README.md

Git Gutter

A Sublime Text 2/3 plug-in to show information about files in a git repository.

Main Features
  1. Gutter Icons indicating inserted, modified or deleted lines
  2. Diff Popup with details about modified lines
  3. Status Bar Text with information about file and repository
  4. Jumping Between Changes to easily navigate between modified lines

screenshot

Icon Description
inserted inserted line
changed modified line
deleted deleted region borders
ignored ignored file
untracked untracked file

💾 Installation

Package Control

It is highly recommended to install GitGutter with Package Control as it automatically installs required dependencies and keeps all packages up to date.

  1. Install Package Control if you haven't yet.
  2. Open the command palette (Ctrl+Shift+P for Windows/Linux, Cmd+Shift+P for Mac)
  3. Search for Package Control: Install Package and hit Enter.
  4. Type GitGutter and press Enter to install it.
Pre-Releases

If you are interested in testing bleeding edge features you can set up Package Control to install pre-releases by adding GitGutter to install_prereleases key in the Package Control.sublime-settings.

"install_prereleases":
[
  "GitGutter"
],
GitGutter-Edge

The GitGutter-Edge package is replaced by Pre-Releases.

This change was made ...

  1. to avoid issues with functions which depend on the package name.
  2. because branch based packages are deprecated by Package Control.
  3. to have more control about when to publish new features for testing.

👉 If you don't want to wait for Pre-Releases you can pull from master branch directly.

Manual Installation

You can clone this repository into your Sublime Text x/Packages

OSX
cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
git clone git://github.com/jisaacks/GitGutter.git
Linux
cd ~/.config/sublime-text-2/Packages
git clone git://github.com/jisaacks/GitGutter.git
Windows
cd "%APPDATA%\Sublime Text 2\Packages"
git clone git://github.com/jisaacks/GitGutter.git

👉 The git command must be available on the command line.

👉 You may need to add the directory containing git.exe to your PATH environment variable.

Dependencies

Some functions of GitGutter depend on the following external libraries to work properly. They are installed automatically for you by Package Control, so normally don't need to care about. But on setups without Package Control you need to make sure they are installed and available in the global namespace of Sublime Text's python interpreter on your own.

👉 On OSX you might need to install the package SublimeFixMacPath.

👉 To manually install pull from the linked repos into ST's Packages folder.

🔫 Troubleshooting

Is git working?

The most common reason for the icons to not show up is likely a problem with GitGutter finding the git executable on PATH.

To check, whether git is found and working properly ...

  1. Open the command palette (Ctrl+Shift+P for Windows/Linux, Cmd+Shift+P for Mac)
  2. Search for GitGutter: Support Info and hit Enter.

An dialog is displayed with version information of Sublime Text and all packages being used by GitGutter.

If git is working properly, the dialog contains a line like git version 2.10.0.windows.1. Otherwise some more detailed information about the reason for git not to work may be found in the console window, then.

Git works in shell but is not found by GitGutter!

Some operating systems (especially OSX) may not run Sublime Text within the login shell. As a result Sublime Text and all its packages don't have access to some of the user's environment variables including the PATH to git.

In some cases the package providing git, simply required some user confirmation due to license changes and thus simply refuses to run git.

With SublimeFixMacPath package Sublime Text loads the PATH environment from the login shell. If git is working there, it will be found by GitGutter, too, then.

GitGutter can work with a certain binary, too. Please read the section on the git_binary setting.

GitGutter no longer works after upgrade

Please check if GitGutter works after restarting Sublime Text.

All modules of GitGutter were moved to modules sub directory to present them to Sublime Text as one package to avoid creating multiple instances of some modules and objects and reduce package loading time by about 50%.

GitGutter handles Package Control's post_upgrade event to reload all its submodules once after upgrading. In rare cases some modules might not be recovered properly and thus require a restart of ST to make GitGutter work again.

🚀 Advanced Features

Diff Popup

The diff popup appears by hovering the mouse over the gutter changes on Sublime Text 3 or can be called from command palette by GitGutter: Show Diff Popup or via a key binding.

popups require Sublime Text 3 Build 3080+

mouse hover feature requires Sublime Text 3 Build 3116+

diff_popup_screenshot

symbol meaning of the symbol
× close the popup
jump to first change
jump to previous change
jump to next change
≈, ≉ enable/disable difference highlighting
copy the content of the git state
revert changes to the state in git

Comparing against different commits/branches/tags

GitGutter compares the working copy against the HEAD by default. This behavior can be changed through the command palette.

The following options are available:

  • Compare against HEAD
  • Compare against particular branch
  • Compare against particular tag
  • Compare against specific commit
  • Compare against specific file commit (current file's history)
  • Compare against origin

To change the compare option:

  1. Open the command palette (Ctrl+Shift+P for Windows/Linux, Cmd+Shift+P for Mac)
  2. Start typing GitGutter: Compare against
  3. You'll see the 5 options listed above, select one with the keyboard and press Enter.
  4. Choose the branch/tag/commit to compare against.

👉 The changes apply temporarily to the whole repository.

Jumping Between Changes

There are commands to jump between modifications. The default key bindings for these commands are:

OS X Windows / Linux Description
Cmd+Shift+Option+k Ctrl+Shift+Alt+k Previous
Cmd+Shift+Option+j Ctrl+Shift+Alt+j Next

⚙ Settings

Settings are accessed via the Preferences > Package Settings > GitGutter menu.

Default settings should not be modified, as they are overwritten when GitGutter updates. Copy the relevant settings into GitGutter's user settings file instead.

Enable/Disable Evaluation

"enable": true

GitGutter evaluates changes every time the file is loaded, saved, activated or modified by default. Set false to disable evaluation and hide all gutter icons, status message and minimap markers.

Debounce Delay

"debounce_delay": 1000

Delays update of gutter icons by the following amount (in milliseconds). Useful for performance issues. Default 1000 (1 second).

Focus Change Mode

"focus_change_mode": true

GitGutter evaluates changes every time a view gets the focus by default. Set false to disable evaluation when changing views.

👉 This setting has effect with "live_mode": false only.

👉 GitGutter always evaluates changes after loading and saving a document.

Live Mode

"live_mode": true

GitGutter evaluates changes every time the file is modified by default. Set false to disable evaluation after each input.

👉 GitGutter always evaluates changes after loading and saving a document.

Hover Diff Popup

"enable_hover_diff_popup": true

requires Sublime Text 3 Build 3116+

GitGutter shows a diff popup, when hovering over changes in the gutter. Set false to disable this popup. You can still open it with a key binding and from the command palette.

Diff Popup Default Mode

"diff_popup_default_mode": "default"

requires Sublime Text 3 Build 3080+

The popup displays the previous state of the content under the cursor by "default" but can be set to "diff" to highlight the differences between the git state and the editor state.

Diff Popup Appearance

requires Sublime Text 3 Build 3080+

The popup uses the mdpopups library and the corresponding settings are global and not only for GitGutter. Syntax highlighting can be set to match the active color scheme by adding "mdpopups.use_sublime_highlighter": true to the User settings.

👉 Other settings can be found at mdpopups settings homepage.

👉 User style settings by adding a gitgutter_popup.css the User directory.

👉 User style settings are accessible via the settings menu.

Untracked Files

"show_markers_on_untracked_file": true

GitGutter shows icons on each line for untracked and ignored files by default. Set to false to hide those icons.

You may need to add scopes (markup.ignored.git_gutter and markup.untracked.git_gutter) to your color scheme to color the icons.

Minimap

"show_in_minimap": 1

GitGutter shows diffs in the minimap on Sublime Text 3 by default. Change show_in_minimap to one of the following values to disable this feature or change the width of the markers.

value description
=0 hide markers
>1 width of markers
-1 highlight full line

Git path

"git_binary": ""

If git is not found on PATH by GitGutter the git_binary setting can be set to the location of the git binary. The value may be either a direct string to a git binary:

"git_binary": "E:\\Portable\\git\\bin\\git.exe"

or it may be a dictionary keyed off what sublime.platform() returns, so it may be customized on a per-platform basis:

"git_binary": {
  "default": "",
  "linux": "/usr/bin/git",
  "windows": "C:/Program Files/Git/cmd/git.exe"
}

It is valid to use environment variables in the setting value, and they will be expanded appropriately.

In a POSIX environment you can run which git to find the path to git if it is in your path. On Windows, you can use where git to do the equivalent.

Ignore Whitespace

"ignore_whitespace": "none"

GitGutter includes all whitespace when evaluating modifications by default. Set ignore_whitespace to one of the following values to change this behavior.

value description
"none" don't ignore any whitespace changes
"eol" ignore whitespace changes at the end of line
"space" ignore changed amount of whitespace
"all" ignore all whitespace

👉 The value determines which command line argument to pass to git diff.

Protected Regions

"protected_regions": [
  "sublimelinter-warning-gutter-marks",
  "sublimelinter-error-gutter-marks",
  "bookmarks"
],

To avoid GitGutter from overriding more important gutter icons a list of protected regions can be created, which GitGutter won't add gutter icons to.

👉 You will need to figure out the names of the regions to protect.

Show Status Bar Text

"show_status_bar_text": true

GitGutter displays status information about open files in the status bar by default. Set to false to hide the information.

Status Bar Text Template

"status_bar_text": [
  "In {{repo}} on {{branch}}",
  "{% if compare != 'HEAD' %}, Comparing against {{compare}}{% endif %}",
  ", File is {{state}}",
  "{% if deleted != 0 %}, {{deleted}}-{% endif %}",
  "{% if inserted != 0 %}, {{inserted}}+{% endif %}",
  "{% if modified != 0 %}, {{modified}}≠{% endif %}"
]

The Status Bar Text is rendered using a fully customizable template from status_bar_text. The setting is organized as an array of strings for better readability. It is joined and then passed to jinja2.

GitGutter provides the following variables to be used in the template.

Variable Description
{{repo}} repository name / folder name containing the .git directory
{{branch}} checked out branch you are working on
{{compare}} commit/branch/HEAD the file is compared to
{{state}} One of committed/modified/ignored/untracked
{{deleted}} number of deleted regions
{{inserted}} number of inserted lines
{{modified}} number of modified lines

Themes

"theme": "Default.gitgutter-theme"

GitGutter provides support for custom gutter icons and diff popup style sheets coming with theme packages. Set theme to a valid theme file name to activate a different icon set.

GitGutter includes following themes:

  • Bars.gitgutter-theme
  • Bars Thin.gitgutter-theme
  • Default.gitgutter-theme
  • Default HiDPI.gitgutter-theme

To provide a custom theme developers need to add a folder with all required icons and an optional gitgutter_popup.css file to their package. An empty JSON file <ThemeName>.gitgutter-theme must exist to mark this folder a resource for GitGutter icons.

Per-project and Per-syntax Settings

All GitGutter settings can be placed in any of Sublime Text's settings files to provide syntax-, user-, project- or view-specific setups.

The setting keys need to be prefixed using git_gutter_ to do that.

To modify GitGutter settings for an open Project just open Project > Edit Project menu and add the settings key as shown.

{
    "folders":
    [
        {
            "path": "src"
        }
    ],
    "settings":
    {
        // git_binary is the only setting not being prefixed
        "git_binary": "/path/to/project/specific/git"

        // git_gutter settings
        "git_gutter_live_mode": false,
        "git_gutter_ignore_whitespace": "space"
    }
}

👉 All correctly prefixed settings can be placed into Preferences.sublime-settings instead of GitGutter.sublime-settings.

👉 Settings can be modified temporarily per view by calls like view.settings().set("git_gutter_enable", False)

🖌 Icon Coloring

The colors come from your color scheme .tmTheme file.

Required Color Scheme Entries

If your color scheme file does not define the appropriate colors (or you want to edit them) add an entry that looks like this:

<dict>
  <key>name</key>
  <string>GitGutter deleted</string>
  <key>scope</key>
  <string>markup.deleted.git_gutter</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#F92672</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>GitGutter inserted</string>
  <key>scope</key>
  <string>markup.inserted.git_gutter</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#A6E22E</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>GitGutter changed</string>
  <key>scope</key>
  <string>markup.changed.git_gutter</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#967EFB</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>GitGutter ignored</string>
  <key>scope</key>
  <string>markup.ignored.git_gutter</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#565656</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>GitGutter untracked</string>
  <key>scope</key>
  <string>markup.untracked.git_gutter</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#565656</string>
  </dict>
</dict>

Supported Color Schemes

Color schemes that already have support for GitGutter include:

⮱ Alternatives

Check out the collection of GitGutter(ish) packages for various editors