davidlgoldberg / gitgutter Goto Github PK

A sublime text 2/3 plugin to show an icon in the gutter area indicating whether a line has been inserted, modified or deleted.

You can install via Sublime Package Control
Or you can clone this repo into your Sublime Text 2/Packages

OSX

cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
git clone [email protected]:jisaacks/GitGutter.git

Ubuntu

cd ~/.config/sublime-text-2/Packages
git clone [email protected]:jisaacks/GitGutter.git

Windows

GitGutter assumes that the git command is available on the command line. If it's not, add the directory containing git.exe to your PATH environment variable. Then clone the repo:

cd "%APPDATA%\Sublime Text 2\Packages"
git clone git://github.com/jisaacks/GitGutter.git

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

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

By default, GitGutter runs in the same thread which can block if it starts to perform slowly. Usually this isn't a problem but depending on the size of your file or repo it can be. If you set non_blocking to true then GitGutter will run in a seperate thread and will not block. This does cause a slight delay between when you make a modification and when the icons update in the gutter. This is a Sublime Text 3 only feature, ST2 users can turn off live mode if performance is an issue.

By default, GitGutter detects changes every time the file is modified. If you experience performance issues you can set it to only run on save by setting live_mode to false.

If git is not in your PATH, you may need to set the git_binary setting to the location of the git binary, e.g. in a portable environment;

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

Sublime Text supports project-specific settings, allowing live_mode to be set differently for different repositories. To implement, use the Project > Edit Project menu and add the settings key as shown.

{
    "folders":
    [
        {
            "path": "src"
        }
    ],
    "settings":
    {
        "live_mode": false
    }
}

The colors come from your color scheme .tmTheme file. 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>diff.deleted</string>
  <key>scope</key>
  <string>markup.deleted</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#F92672</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>diff.inserted</string>
  <key>scope</key>
  <string>markup.inserted</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#A6E22E</string>
  </dict>
</dict>
<dict>
  <key>name</key>
  <string>diff.changed</string>
  <key>scope</key>
  <string>markup.changed</string>
  <key>settings</key>
  <dict>
    <key>foreground</key>
    <string>#967EFB</string>
  </dict>
</dict>

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

OSX

prev: command + shift + option + k
next: command + shift + option + j

Windows

prev: ctrl + shift + alt + k
next: ctrl + shift + alt + j

Don't use Sublime?

• Vim GitGutter
• Emacs GitGutter

Don't use Git?

• VcsGutter
• Modific Not a port/fork of GitGutter but similar