Adds avatars to gutter and hover blame annotations

Author: eamodio

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [7.3.0-beta4] - 2018-01-11
 ### Added
+- Adds [Gravatar](https://en.gravatar.com/) support to gutter and hover blame annotations
+- Adds `gitlens.annotations.file.gutter.gravatars` setting to specify whether or not to show gravatar images in the gutter blame annotations
 - Adds support for providing blame annotations, code lens, etc on files with unsaved changes -- closes [#112](https://github.com/eamodio/vscode-gitlens/issues/112)
 - Adds `gitlens.defaultDateStyle` setting to specify how dates will be displayed by default -- closes [#89](https://github.com/eamodio/vscode-gitlens/issues/89)
 - Adds *Compare with Working* command (`gitlens.explorers.compareWithWorking`) to branch, tag, and revision (commit) nodes in the **GitLens** view to compare the current selection with the current working tree in the **GitLens Results** view
@@ -26,6 +28,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Renames *Open Changes with Working Tree* command (`gitlens.openChangesWithWorking`) to *Open Changes with Working File*
 - Renames *Compare Selected Ancestor with Working* command (`gitlens.compareSelectedAncestorWithWorking`) to *Compare Selected Ancestor with Working Tree*
 - Renames *Compare with Working* command (`gitlens.compareWithWorking`) to *Compare with Working Tree*
+- Deprecates `gitlens.gitExplorer.gravatarsDefault` setting, replaced by `gitlens.defaultGravatarsStyle`
+- Deprecates `gitlens.resultsExplorer.gravatarsDefault` setting, replaced by `gitlens.defaultGravatarsStyle`
 
 ### Fixed
 - Fixes issue where the **GitLens Results** view wouldn't properly update when replacing existing results

README.md

@@ -387,6 +387,7 @@ GitLens is highly customizable and provides many configuration settings to allow
 |-----|------------
 |`gitlens.defaultDateFormat`|Specifies how absolute dates will be formatted by default<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
 |`gitlens.defaultDateStyle`|Specifies how dates will be displayed by default
+|`gitlens.defaultGravatarsStyle`|Specifies the style of the gravatar default (fallback) images<br />`identicon` - a geometric pattern<br />`mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)<br />`monsterid` - a monster with different colors, faces, etc<br />`retro` - 8-bit arcade-style pixelated faces<br />`robohash` - a robot with different colors, faces, etc<br />`wavatar` - faces with differing features and backgrounds
 |`gitlens.insiders`|Opts into the insiders channel -- provides access to upcoming features
 |`gitlens.keymap`|Specifies the keymap to use for GitLens shortcut keys<br />`standard` - adds a standard set of shortcut keys<br />`chorded` - adds a chorded set of shortcut keys that all start with `Ctrl+Alt+G` (`⌥⌘G` on macOS)<br />`none` - no shortcut keys will be added
 |`gitlens.outputLevel`|Specifies how much (if any) output will be sent to the GitLens output channel
@@ -407,6 +408,7 @@ GitLens is highly customizable and provides many configuration settings to allow
 |`gitlens.annotations.file.gutter.format`|Specifies the format of the gutter blame annotations<br />Available tokens<br />`${id}` - commit id<br />`${author}` - commit author<br />`${message}` - commit message<br />`${ago}` - relative commit date (e.g. 1 day ago)<br />`${date}` - formatted commit date (format specified by `gitlens.annotations.file.gutter.dateFormat`)<br />`${authorAgo}` - commit author, relative commit date<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
 |`gitlens.annotations.file.gutter.dateFormat`|Specifies how to format absolute dates (using the `${date}` token) in gutter blame annotations<br />See https://momentjs.com/docs/#/displaying/format/ for valid formats
 |`gitlens.annotations.file.gutter.compact`|Specifies whether or not to compact (deduplicate) matching adjacent gutter blame annotations
+|`gitlens.annotations.file.gutter.gravatars`|Specifies whether or not to show gravatar images in the gutter blame annotations
 |`gitlens.annotations.file.gutter.heatmap.enabled`|Specifies whether or not to provide a heatmap indicator in the gutter blame annotations
 |`gitlens.annotations.file.gutter.heatmap.location`|Specifies where the heatmap indicators will be shown in the gutter blame annotations<br />`left` - adds a heatmap indicator on the left edge of the gutter blame annotations<br />`right` - adds a heatmap indicator on the right edge of the gutter blame annotations
 |`gitlens.annotations.file.gutter.hover.details`|Specifies whether or not to provide a commit details hover annotation over the gutter blame annotations
@@ -465,7 +467,6 @@ GitLens is highly customizable and provides many configuration settings to allow
 |`gitlens.gitExplorer.commitFormat`|Specifies the format of committed changes in the **GitLens** view<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${authorAgo} - commit author, relative commit date<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
 |`gitlens.gitExplorer.commitFileFormat`|Specifies the format of a committed file in the **GitLens** view<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path
 |`gitlens.gitExplorer.gravatars`|Specifies whether or not to show gravatar images instead of commit (or status) icons in the **GitLens** view
-|`gitlens.gitExplorer.gravatarsDefault`|Specifies the style of the gravatar default (fallback) images in the **GitLens** view<br />`identicon` - a geometric pattern<br />`mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)<br />`monsterid` - a monster with different colors, faces, etc<br />`retro` - 8-bit arcade-style pixelated faces<br />`robohash` - a robot with different colors, faces, etc<br />`wavatar` - faces with differing features and backgrounds
 |`gitlens.gitExplorer.includeWorkingTree`|Specifies whether or not to include working tree files inside the `Repository Status` node of the **GitLens** view
 |`gitlens.gitExplorer.showTrackingBranch`|Specifies whether or not to show the tracking branch when displaying local branches in the **GitLens** view"
 |`gitlens.gitExplorer.stashFormat`|Specifies the format of stashed changes in the **GitLens** view<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${authorAgo} - commit author, relative commit date<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
@@ -482,7 +483,6 @@ GitLens is highly customizable and provides many configuration settings to allow
 |`gitlens.resultsExplorer.commitFormat`|Specifies the format of committed changes in the **GitLens Results** view<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${authorAgo} - commit author, relative commit date<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
 |`gitlens.resultsExplorer.commitFileFormat`|Specifies the format of a committed file in the **GitLens Results** view<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path
 |`gitlens.resultsExplorer.gravatars`|Specifies whether or not to show gravatar images instead of commit (or status) icons in the **GitLens Results** view
-|`gitlens.resultsExplorer.gravatarsDefault`|Specifies the style of the gravatar default (fallback) images in the **GitLens Results** view<br />`identicon` - a geometric pattern<br />`mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)<br />`monsterid` - a monster with different colors, faces, etc<br />`retro` - 8-bit arcade-style pixelated faces<br />`robohash` - a robot with different colors, faces, etc<br />`wavatar` - faces with differing features and backgrounds
 |`gitlens.resultsExplorer.showTrackingBranch`|Specifies whether or not to show the tracking branch when displaying local branches in the **GitLens Results** view"
 |`gitlens.resultsExplorer.stashFormat`|Specifies the format of stashed changes in the **GitLens Results** view<br />Available tokens<br /> ${id} - commit id<br /> ${author} - commit author<br /> ${message} - commit message<br /> ${ago} - relative commit date (e.g. 1 day ago)<br /> ${date} - formatted commit date (format specified by `gitlens.statusBar.dateFormat`)<br /> ${authorAgo} - commit author, relative commit date<br />See https://github.com/eamodio/vscode-gitlens/wiki/Advanced-Formatting for advanced formatting
 |`gitlens.resultsExplorer.stashFileFormat`|Specifies the format of a stashed file in the **GitLens Results** view<br />Available tokens<br /> ${directory} - directory name<br /> ${file} - file name<br /> ${filePath} - formatted file name and path<br /> ${path} - full file path
@@ -516,10 +516,10 @@ GitLens is highly customizable and provides many configuration settings to allow
 
 |Name | Description
 |-----|------------
-|`gitlens.advanced.git`|Specifies the git path to use
 |`gitlens.advanced.blame.delayAfterEdit`|Specifies the time (in milliseconds) to wait before re-blaming an unsaved document after an edit. Use 0 to specify an infinite wait
 |`gitlens.advanced.blame.sizeThresholdAfterEdit`|Specifies the maximum document size (in lines) allowed to be re-blamed after an edit while still unsaved. Use 0 to specify no maximum
 |`gitlens.advanced.caching.enabled`|Specifies whether git output will be cached -- changing the default is not recommended
+|`gitlens.advanced.git`|Specifies the git path to use
 |`gitlens.advanced.maxListItems`|Specifies the maximum number of items to show in a list. Use 0 to specify no maximum
 |`gitlens.advanced.menus`|Specifies which commands will be added to which menus
 |`gitlens.advanced.messages`|Specifies which messages should be suppressed

package.json

@@ -102,6 +102,12 @@
                     "description": "Specifies whether or not to compact (deduplicate) matching adjacent gutter blame annotations",
                     "scope": "window"
                 },
+                "gitlens.annotations.file.gutter.gravatars": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Specifies whether or not to show gravatar images in the gutter blame annotations",
+                    "scope": "window"
+                },
                 "gitlens.annotations.file.gutter.heatmap.enabled": {
                     "type": "boolean",
                     "default": true,
@@ -488,6 +494,20 @@
                     "description": "Specifies how dates will be displayed by default",
                     "scope": "window"
                 },
+                "gitlens.defaultGravatarsStyle": {
+                    "type": "string",
+                    "default": "robohash",
+                    "enum": [
+                        "identicon",
+                        "mm",
+                        "monsterid",
+                        "retro",
+                        "robohash",
+                        "wavatar"
+                    ],
+                    "description": "Specifies the style of the gravatar default (fallback) images\n `identicon` - a geometric pattern\n `mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)\n `monsterid` - a monster with different colors, faces, etc\n `retro` - 8-bit arcade-style pixelated faces\n `robohash` - a robot with different colors, faces, etc\n `wavatar` - faces with differing features and backgrounds",
+                    "scope": "window"
+                },
                 "gitlens.gitExplorer.autoRefresh": {
                     "type": "boolean",
                     "default": true,
@@ -541,20 +561,6 @@
                     "description": "Specifies whether or not to show gravatar images instead of commit (or status) icons in the `GitLens` view",
                     "scope": "window"
                 },
-                "gitlens.gitExplorer.gravatarsDefault": {
-                    "type": "string",
-                    "default": "robohash",
-                    "enum": [
-                        "identicon",
-                        "mm",
-                        "monsterid",
-                        "retro",
-                        "robohash",
-                        "wavatar"
-                    ],
-                    "description": "Specifies the style of the gravatar default (fallback) images in the `GitLens` view\n `identicon` - a geometric pattern\n `mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)\n `monsterid` - a monster with different colors, faces, etc\n `retro` - 8-bit arcade-style pixelated faces\n `robohash` - a robot with different colors, faces, etc\n `wavatar` - faces with differing features and backgrounds",
-                    "scope": "window"
-                },
                 "gitlens.gitExplorer.includeWorkingTree": {
                     "type": "boolean",
                     "default": true,
@@ -730,20 +736,6 @@
                     "description": "Specifies whether or not to show gravatar images instead of commit (or status) icons in the `GitLens Results` view",
                     "scope": "window"
                 },
-                "gitlens.resultsExplorer.gravatarsDefault": {
-                    "type": "string",
-                    "default": "robohash",
-                    "enum": [
-                        "identicon",
-                        "mm",
-                        "monsterid",
-                        "retro",
-                        "robohash",
-                        "wavatar"
-                    ],
-                    "description": "Specifies the style of the gravatar default (fallback) images in the `GitLens Results` view\n `identicon` - a geometric pattern\n `mm` - (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)\n `monsterid` - a monster with different colors, faces, etc\n `retro` - 8-bit arcade-style pixelated faces\n `robohash` - a robot with different colors, faces, etc\n `wavatar` - faces with differing features and backgrounds",
-                    "scope": "window"
-                },
                 "gitlens.resultsExplorer.showTrackingBranch": {
                     "type": "boolean",
                     "default": true,

src/annotations/annotationProvider.ts

@@ -17,29 +17,29 @@ export abstract class AnnotationProviderBase extends Disposable {
     public correlationKey: TextEditorCorrelationKey;
     public document: TextDocument;
 
-    protected _decorations: DecorationOptions[] | undefined;
-    protected _disposable: Disposable;
+    protected decorations: DecorationOptions[] | undefined;
+    protected disposable: Disposable;
 
     constructor(
         public editor: TextEditor,
         protected readonly trackedDocument: TrackedDocument<GitDocumentState>,
-        protected _decoration: TextEditorDecorationType | undefined,
-        protected _highlightDecoration: TextEditorDecorationType | undefined
+        protected decoration: TextEditorDecorationType | undefined,
+        protected highlightDecoration: TextEditorDecorationType | undefined
     ) {
         super(() => this.dispose());
 
         this.correlationKey = AnnotationProviderBase.getCorrelationKey(this.editor);
         this.document = this.editor.document;
 
-        this._disposable = Disposable.from(
+        this.disposable = Disposable.from(
             window.onDidChangeTextEditorSelection(this.onTextEditorSelectionChanged, this)
         );
     }
 
     async dispose() {
         await this.clear();
 
-        this._disposable && this._disposable.dispose();
+        this.disposable && this.disposable.dispose();
     }
 
     private async onTextEditorSelectionChanged(e: TextEditorSelectionChangeEvent) {
@@ -58,16 +58,32 @@ export abstract class AnnotationProviderBase extends Disposable {
         return this.editor.document.uri;
     }
 
+    protected decorationTypes: TextEditorDecorationType[] | undefined;
+
     async clear() {
-        if (this.editor !== undefined) {
+        if (this.editor === undefined || this.decorationTypes === undefined || this.decorationTypes.length === 0) return;
+
+        if (this.decoration !== undefined) {
             try {
-                if (this._highlightDecoration !== undefined) {
-                    this.editor.setDecorations(this._highlightDecoration, []);
-                }
+                this.editor.setDecorations(this.decoration, []);
+            }
+            catch { }
+        }
 
-                if (this._decoration !== undefined) {
-                    this.editor.setDecorations(this._decoration, []);
+        if (this.decorationTypes !== undefined && this.decorationTypes.length > 0) {
+            for (const dt of this.decorationTypes) {
+                try {
+                    this.editor.setDecorations(dt, []);
                 }
+                catch { }
+            }
+
+            this.decorationTypes = undefined;
+        }
+
+        if (this.highlightDecoration !== undefined) {
+            try {
+                this.editor.setDecorations(this.highlightDecoration, []);
             }
             catch { }
         }
@@ -87,8 +103,8 @@ export abstract class AnnotationProviderBase extends Disposable {
         if (changes !== undefined) {
             await this.clear();
 
-            this._decoration = changes.decoration;
-            this._highlightDecoration = changes.highlightDecoration;
+            this.decoration = changes.decoration;
+            this.highlightDecoration = changes.highlightDecoration;
         }
 
         await this.provideAnnotation(this.editor === undefined ? undefined : this.editor.selection.active.line);
@@ -103,8 +119,8 @@ export abstract class AnnotationProviderBase extends Disposable {
         this.correlationKey = AnnotationProviderBase.getCorrelationKey(editor);
         this.document = editor.document;
 
-        if (this._decorations !== undefined && this._decorations.length) {
-            this.editor.setDecorations(this._decoration!, this._decorations);
+        if (this.decorations !== undefined && this.decorations.length) {
+            this.editor.setDecorations(this.decoration!, this.decorations);
         }
     }
 

src/annotations/annotations.ts

@@ -89,7 +89,7 @@ export class Annotations {
             showCommitDetailsCommand = `\`${commit.shortSha}\``;
         }
 
-        const markdown = new MarkdownString(`${showCommitDetailsCommand}   __${commit.author}__, ${commit.fromNow()}   _(${commit.formatDate(dateFormat)})_ ${message}${commandBar}`);
+        const markdown = new MarkdownString(`${showCommitDetailsCommand}   ![](${commit.getGravatarUri(Container.config.defaultGravatarsStyle).toString()})  __${commit.author}__, ${commit.fromNow()}   _(${commit.formatDate(dateFormat)})_ ${message}${commandBar}`);
         markdown.isTrusted = true;
         return markdown;
     }