Adds full commit message to blame annotations

Switches to use HoverProvider for hovers in file blames

Author: eamodio

CHANGELOG.md

@@ -6,12 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [5.0.1] - 2017-09-14
 ### Added
-- Adds an external link icon to the `details` hover annotation to run the `Open Commit in Remote` command (`gitlens.openCommitInRemote`)
+- Adds an external link icon to the `details` hover annotations to run the `Open Commit in Remote` command (`gitlens.openCommitInRemote`)
+- Adds full (multi-line) commit message to the `details` hover annotations
 
 ### Changed
 - Optimizes performance of the providing blame annotations, especially for large files (saw a ~61% improvement on some files)
 - Optimizes date handling (parsing and formatting) for better performance and reduced memory consumption
 
+### Removed
+- Removes `gitlens.annotations.file.recentChanges.hover.wholeLine` setting as it didn't really make sense
+
 ### Fixed
 
 ## [5.0.0] - 2017-09-12

README.md

@@ -332,7 +332,6 @@ GitLens is highly customizable and provides many configuration settings to allow
 |`gitlens.recentChanges.file.lineHighlight.locations`|Specifies where the highlights of the recently changed lines will be shown<br />`gutter` - adds a gutter glyph<br />`line` - adds a full-line highlight background color<br />`overviewRuler` - adds a decoration to the overviewRuler (scroll bar)
 |`gitlens.annotations.file.recentChanges.hover.details`|Specifies whether or not to provide a commit details hover annotation
 |`gitlens.annotations.file.recentChanges.hover.changes`|Specifies whether or not to provide a changes (diff) hover annotation
-|`gitlens.annotations.file.recentChanges.hover.wholeLine`|Specifies whether or not to trigger hover annotations over the whole line
 
 ### Code Lens Settings
 

package.json

@@ -132,11 +132,6 @@
                     "default": true,
                     "description": "Specifies whether or not to provide a changes (diff) hover annotation"
                 },
-                "gitlens.annotations.file.recentChanges.hover.wholeLine": {
-                    "type": "boolean",
-                    "default": true,
-                    "description": "Specifies whether or not to trigger hover annotations over the whole line"
-                },
                 "gitlens.annotations.line.hover.details": {
                     "type": "boolean",
                     "default": true,

src/annotations/annotationController.ts

@@ -222,7 +222,7 @@ export class AnnotationController extends Disposable {
     }
 
     getProvider(editor: TextEditor | undefined): AnnotationProviderBase | undefined {
-        if (!editor || !editor.document || !this.git.isEditorBlameable(editor)) return undefined;
+        if (editor === undefined || editor.document === undefined || !this.git.isEditorBlameable(editor)) return undefined;
 
         return this._annotationProviders.get(editor.viewColumn || -1);
     }
@@ -233,7 +233,7 @@ export class AnnotationController extends Disposable {
         if (!editor || !editor.document || !this.git.isEditorBlameable(editor)) return false;
 
         const currentProvider = this._annotationProviders.get(editor.viewColumn || -1);
-        if (currentProvider && TextEditorComparer.equals(currentProvider.editor, editor)) {
+        if (currentProvider !== undefined && TextEditorComparer.equals(currentProvider.editor, editor)) {
             await currentProvider.selection(shaOrLine);
             return true;
         }

src/annotations/annotations.ts

@@ -187,11 +187,12 @@ export class Annotations {
         } as IRenderOptions;
     }
 
-    static hover(commit: GitCommit, renderOptions: IRenderOptions, heatmap: boolean, dateFormat: string | null, hasRemotes: boolean): DecorationOptions {
-        return {
-            hoverMessage: this.getHoverMessage(commit, dateFormat, hasRemotes),
-            renderOptions: heatmap ? { before: { ...renderOptions.before } } : undefined
+    static hover(commit: GitCommit, renderOptions: IRenderOptions, now: number): DecorationOptions {
+        const decoration = {
+            renderOptions: { before: { ...renderOptions.before } }
         } as DecorationOptions;
+        this.applyHeatmap(decoration, commit.date, now);
+        return decoration;
     }
 
     static hoverRenderOptions(cfgTheme: IThemeConfig, heatmap: IHeatmapConfig): IRenderOptions {

src/annotations/blameAnnotationProvider.ts

@@ -1,20 +1,27 @@
 'use strict';
 import { Iterables } from '../system';
-import { ExtensionContext, Range, TextEditor, TextEditorDecorationType } from 'vscode';
+import { CancellationToken, Disposable, ExtensionContext, Hover, HoverProvider, languages, Position, Range, TextDocument, TextEditor, TextEditorDecorationType } from 'vscode';
 import { AnnotationProviderBase } from './annotationProvider';
-import { GitBlame, GitService, GitUri } from '../gitService';
+import { Annotations, endOfLineIndex } from './annotations';
+import { GitBlame, GitCommit, GitService, GitUri } from '../gitService';
 import { WhitespaceController } from './whitespaceController';
 
-export abstract class BlameAnnotationProviderBase extends AnnotationProviderBase {
+export abstract class BlameAnnotationProviderBase extends AnnotationProviderBase implements HoverProvider {
 
     protected _blame: Promise<GitBlame | undefined>;
+    protected _hoverProviderDisposable: Disposable;
 
     constructor(context: ExtensionContext, editor: TextEditor, decoration: TextEditorDecorationType | undefined, highlightDecoration: TextEditorDecorationType | undefined, whitespaceController: WhitespaceController | undefined, protected git: GitService, protected uri: GitUri) {
         super(context, editor, decoration, highlightDecoration, whitespaceController);
 
         this._blame = this.git.getBlameForFile(this.uri);
     }
 
+    async clear() {
+        this._hoverProviderDisposable && this._hoverProviderDisposable.dispose();
+        super.clear();
+    }
+
     async selection(shaOrLine?: string | number, blame?: GitBlame) {
         if (!this.highlightDecoration) return;
 
@@ -56,6 +63,7 @@ export abstract class BlameAnnotationProviderBase extends AnnotationProviderBase
         const blame = await this._blame;
         return blame !== undefined && blame.lines.length !== 0;
     }
+
     protected async getBlame(requiresWhitespaceHack: boolean): Promise<GitBlame | undefined> {
         let whitespacePromise: Promise<void> | undefined;
         // HACK: Until https://github.com/Microsoft/vscode/issues/11485 is fixed -- override whitespace (turn off)
@@ -64,18 +72,47 @@ export abstract class BlameAnnotationProviderBase extends AnnotationProviderBase
         }
 
         let blame: GitBlame | undefined;
-        if (whitespacePromise) {
+        if (whitespacePromise !== undefined) {
             [blame] = await Promise.all([this._blame, whitespacePromise]);
         }
         else {
             blame = await this._blame;
         }
 
-        if (blame === undefined || !blame.lines.length) {
+        if (blame === undefined || blame.lines.length === 0) {
             this.whitespaceController && await this.whitespaceController.restore();
             return undefined;
         }
 
         return blame;
     }
+
+    registerHoverProvider() {
+        this._hoverProviderDisposable = languages.registerHoverProvider({ pattern: this.uri.fsPath }, this);
+    }
+
+    async provideHover(document: TextDocument, position: Position, token: CancellationToken): Promise<Hover | undefined> {
+        // Avoid double annotations if we are showing the whole-file hover blame annotations
+        if (this._config.blame.line.enabled && this.editor.selection.start.line === position.line) return undefined;
+
+        const cfg = this._config.annotations.file.gutter;
+        if (!cfg.hover.wholeLine && position.character !== 0) return undefined;
+
+        const blame = await this.getBlame(true);
+        if (blame === undefined) return undefined;
+
+        const line = blame.lines[position.line - this.uri.offset];
+
+        const commit = blame.commits.get(line.sha);
+        if (commit === undefined) return undefined;
+
+        // Get the full commit message -- since blame only returns the summary
+        let logCommit: GitCommit | undefined = undefined;
+        if (!commit.isUncommitted) {
+            logCommit = await this.git.getLogCommit(commit.repoPath, commit.uri.fsPath, commit.sha);
+        }
+
+        const message = Annotations.getHoverMessage(logCommit || commit, this._config.defaultDateFormat, this.git.hasRemotes(commit.repoPath));
+        return new Hover(message, document.validateRange(new Range(position.line, 0, position.line, endOfLineIndex)));
+    }
 }

src/annotations/gutterBlameAnnotationProvider.ts

@@ -2,7 +2,7 @@
 import { Strings } from '../system';
 import { DecorationOptions, Range } from 'vscode';
 import { FileAnnotationType } from './annotationController';
-import { Annotations, endOfLineIndex } from './annotations';
+import { Annotations } from './annotations';
 import { BlameAnnotationProviderBase } from './blameAnnotationProvider';
 import { GlyphChars } from '../constants';
 import { GitBlameCommit, ICommitFormatOptions } from '../gitService';
@@ -35,18 +35,14 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
         const now = Date.now();
         const offset = this.uri.offset;
         const renderOptions = Annotations.gutterRenderOptions(this._config.theme, cfg.heatmap);
-        const dateFormat = this._config.defaultDateFormat;
         const separateLines = this._config.theme.annotations.file.gutter.separateLines;
 
         const decorations: DecorationOptions[] = [];
-        const decorationsMap: { [sha: string]: DecorationOptions } = Object.create(null);
-        const document = this.document;
+        const decorationsMap: { [sha: string]: DecorationOptions | undefined } = Object.create(null);
 
         let commit: GitBlameCommit | undefined;
         let compacted = false;
-        let details: DecorationOptions | undefined;
         let gutter: DecorationOptions | undefined;
-        let hasRemotes: boolean | undefined;
         let previousSha: string | undefined;
 
         for (const l of blame.lines) {
@@ -55,63 +51,50 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
             if (previousSha === l.sha) {
                 // Use a shallow copy of the previous decoration options
                 gutter = { ...gutter } as DecorationOptions;
+
                 if (cfg.compact && !compacted) {
                     // Since we are wiping out the contextText make sure to copy the objects
-                    gutter.renderOptions = { ...gutter.renderOptions };
-                    gutter.renderOptions.before = {
-                        ...gutter.renderOptions.before,
-                        ...{ contentText: GlyphChars.Space.repeat(Strings.getWidth(gutter.renderOptions!.before!.contentText!)) }
+                    gutter.renderOptions = {
+                        ...gutter.renderOptions,
+                        before: {
+                            ...gutter.renderOptions!.before,
+                            contentText: GlyphChars.Space.repeat(Strings.getWidth(gutter.renderOptions!.before!.contentText!))
+                        }
                     };
 
                     if (separateLines) {
-                        gutter.renderOptions.dark = { ...gutter.renderOptions.dark };
-                        gutter.renderOptions.dark.before = { ...gutter.renderOptions.dark.before, ...{ textDecoration: 'none' } };
-                        gutter.renderOptions.light = { ...gutter.renderOptions.light };
-                        gutter.renderOptions.light.before = { ...gutter.renderOptions.light.before, ...{ textDecoration: 'none' } };
+                        gutter.renderOptions.dark = {
+                            ...gutter.renderOptions.dark,
+                            before: { ...gutter.renderOptions.dark!.before, textDecoration: 'none' }
+                        };
+                        gutter.renderOptions.light = {
+                            ...gutter.renderOptions.light,
+                            before: { ...gutter.renderOptions.light!.before, textDecoration: 'none' }
+                        };
                     }
 
                     compacted = true;
                 }
 
-                const endIndex = document.lineAt(line).firstNonWhitespaceCharacterIndex;
-                gutter.range = new Range(line, 0, line, endIndex);
+                gutter.range = new Range(line, 0, line, 0);
 
                 decorations.push(gutter);
 
-                if (details !== undefined) {
-                    details = { ...details } as DecorationOptions;
-                    details.range = cfg.hover.wholeLine
-                        ? document.validateRange(new Range(line, 0, line, endOfLineIndex))
-                        : gutter.range;
-
-                    decorations.push(details);
-                }
-
                 continue;
             }
 
             compacted = false;
             previousSha = l.sha;
 
             gutter = decorationsMap[l.sha];
-
             if (gutter !== undefined) {
-                gutter = { ...gutter } as DecorationOptions;
-
-                const endIndex = document.lineAt(line).firstNonWhitespaceCharacterIndex;
-                gutter.range = new Range(line, 0, line, endIndex);
+                gutter = {
+                    ...gutter,
+                    range: new Range(line, 0, line, 0)
+                } as DecorationOptions;
 
                 decorations.push(gutter);
 
-                if (details !== undefined) {
-                    details = { ...details } as DecorationOptions;
-                    details.range = cfg.hover.wholeLine
-                        ? document.validateRange(new Range(line, 0, line, endOfLineIndex))
-                        : gutter.range;
-
-                    decorations.push(details);
-                }
-
                 continue;
             }
 
@@ -124,24 +107,10 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
                 Annotations.applyHeatmap(gutter, commit.date, now);
             }
 
-            const endIndex = document.lineAt(line).firstNonWhitespaceCharacterIndex;
-            gutter.range = new Range(line, 0, line, endIndex);
+            gutter.range = new Range(line, 0, line, 0);
 
             decorations.push(gutter);
             decorationsMap[l.sha] = gutter;
-
-            if (cfg.hover.details) {
-                if (hasRemotes === undefined) {
-                    hasRemotes = this.git.hasRemotes(commit.repoPath);
-                }
-
-                details = Annotations.detailsHover(commit, dateFormat, hasRemotes);
-                details.range = cfg.hover.wholeLine
-                    ? document.validateRange(new Range(line, 0, line, endOfLineIndex))
-                    : gutter.range;
-
-                decorations.push(details);
-            }
         }
 
         if (decorations.length) {
@@ -151,6 +120,10 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
         const duration = process.hrtime(start);
         Logger.log(`${(duration[0] * 1000) + Math.floor(duration[1] / 1000000)} ms to compute gutter blame annotations`);
 
+        if (cfg.hover.details) {
+            this.registerHoverProvider();
+        }
+
         this.selection(shaOrLine, blame);
         return true;
     }