ryu1kn/vscode-annotator

[![Build Status](https://travis-ci.org/ryu1kn/vscode-annotator.svg?branch=master)](https://travis-ci.org/ryu1kn/vscode-annotator) [![Code Climate](https://codeclimate.com/github/ryu1kn/vscode-annotator/badges/gpa.svg)](https://codeclimate.com/github/ryu1kn/vscode-annotator)

# Annotator

## Features

* Display the annotation view (git blame) of the current file.
* Display the diff of a particular commit by selecting the annotation of a line.
* From the commit diff view, you can:
  * Open the annotation view of the file just before the commit, and trace back the history.
  * Open the diff of another file in the same commit.
* The vertical colour bar is coloured darker for older commits and lighter for more recent commits (or the other way around, depending on the colours you specified).
* Highlight the annotations with same commit hash when hovering over them.

Blame the current file and open the diff of a particular commit:

![Annotate and view diff](https://raw.githubusercontent.com/ryu1kn/vscode-annotator/master/images/animations/annotate-code.gif)

The annotation is opened in a separate tab; simply close that tab when you are done with it.

From the commit diff, annotate the contents of the left side of the diff view:

![Annotate the file contents before the commit](https://raw.githubusercontent.com/ryu1kn/vscode-annotator/master/images/animations/annotate-contents-of-before-selected-commit.gif)

From the commit diff, open the diff of another file in the same commit:

![Open the diff of another file in the same commit](https://raw.githubusercontent.com/ryu1kn/vscode-annotator/master/images/animations/open-diff-of-another-file.gif)

Annotation with different colour settings, etc.:

![Annotation with different colour settings](https://raw.githubusercontent.com/ryu1kn/vscode-annotator/master/images/screencaptures/light-theme.png)

## Request Features or Report Bugs

Feature requests and bug reports are very welcome: https://github.com/ryu1kn/vscode-annotator/issues

A couple of requests from me when you raise an github issue.

* **Requesting a feature:** Please try to provide the context of why you want the feature. Such as, in what situation the feature could help you and how, or how the lack of the feature is causing an inconvenience to you. I can't think of introducing it until I understand how it helps you 🙂
* **Reporting a bug:** Please include environment information (OS name/version, the editor version). Also consider providing screenshots (or even videos) where appropriate. They are often very very helpful!

## Commands

* `Annotator: Annotate the Current File or the File Before the Commit (if on Commit Diff)`
    * *Command ID:* `annotator.annotate`
* `Annotator: Show Diff of Another File Changed in the Same Commit`
    * *Command ID:* `annotator.switchDiffWithinCommit`

## Configurations

* `annotator.annotationColumnWidth`: Width of the annotation column
* `annotator.annotationCommitColorRange`: Range of colours to be used for colouring each commit. Specify intermediate colours by giving more than 2 colours
* `annotator.annotationCommitColorBarWidth`: Width of the commit colour bar
* `annotator.annotationFontColor`: Font colour of the annotation text
* `annotator.annotationHighlightColor`: Highlight colour when hovering over the annotation text
* `annotator.annotationTooltipWidth`: Width of the annotation tooltip
* `annotator.annotationTooltipBackgroundColor`: Background colour of the annotation tooltip
* `annotator.git.ignoreWhitespaceOnBlame`: Ignore whitespace when `git blame` by specifying [`-w` option](https://www.git-scm.com/docs/git-blame#git-blame--w).

## Prerequisite

`git` command must be available. You need to either make `git` available in your `PATH` or set `git.path` in your settings.

## Changelog

* https://github.com/ryu1kn/vscode-annotator/blob/master/CHANGELOG.md