Git - add git blame status bar item (microsoft#234302)

* Git - improve enabliment of the editor decoration

* Git - add git blame status bar item

Author: lszomoru

extensions/git/package.json

@@ -3197,6 +3197,15 @@
           "tags": [
             "experimental"
           ]
+        },
+        "git.blame.statusBarItem.enabled": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "%config.blameStatusBarItem.enabled%",
+          "scope": "resource",
+          "tags": [
+            "experimental"
+          ]
         }
       }
     },

extensions/git/package.nls.json

@@ -276,7 +276,8 @@
 	"config.publishBeforeContinueOn.never": "Never publish unpublished Git state when using Continue Working On from a Git repository",
 	"config.publishBeforeContinueOn.prompt": "Prompt to publish unpublished Git state when using Continue Working On from a Git repository",
 	"config.similarityThreshold": "Controls the threshold of the similarity index (the amount of additions/deletions compared to the file's size) for changes in a pair of added/deleted files to be considered a rename. **Note:** Requires Git version `2.18.0` or later.",
-	"config.blameEditorDecoration.enabled": "Controls whether to show git blame information in the editor using editor decorations",
+	"config.blameEditorDecoration.enabled": "Controls whether to show git blame information in the editor using editor decorations.",
+	"config.blameStatusBarItem.enabled": "Controls whether to show git blame information in the status bar.",
 	"submenu.explorer": "Git",
 	"submenu.commit": "Commit",
 	"submenu.commit.amend": "Amend",

extensions/git/src/blame.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { DecorationOptions, l10n, Position, Range, TextEditor, TextEditorChange, TextEditorDecorationType, TextEditorChangeKind, ThemeColor, Uri, window, workspace, EventEmitter, ConfigurationChangeEvent } from 'vscode';
+import { DecorationOptions, l10n, Position, Range, TextEditor, TextEditorChange, TextEditorDecorationType, TextEditorChangeKind, ThemeColor, Uri, window, workspace, EventEmitter, ConfigurationChangeEvent, StatusBarItem, StatusBarAlignment } from 'vscode';
 import { Model } from './model';
 import { dispose, fromNow, IDisposable, pathEquals } from './util';
 import { Repository } from './repository';
@@ -113,6 +113,7 @@ export class GitBlameController {
 
 	constructor(private readonly _model: Model) {
 		this._disposables.push(new GitBlameEditorDecoration(this));
+		this._disposables.push(new GitBlameStatusBarItem(this));
 
 		this._model.onDidOpenRepository(this._onDidOpenRepository, this, this._disposables);
 		this._model.onDidCloseRepository(this._onDidCloseRepository, this, this._disposables);
@@ -336,3 +337,78 @@ class GitBlameEditorDecoration {
 		this._disposables = dispose(this._disposables);
 	}
 }
+
+class GitBlameStatusBarItem {
+	private _statusBarItem: StatusBarItem | undefined;
+
+	private _disposables: IDisposable[] = [];
+
+	constructor(private readonly _controller: GitBlameController) {
+		workspace.onDidChangeConfiguration(this._onDidChangeConfiguration, this, this._disposables);
+		window.onDidChangeActiveTextEditor(this._onDidChangeActiveTextEditor, this, this._disposables);
+
+		this._controller.onDidChangeBlameInformation(e => this._updateStatusBarItem(e), this, this._disposables);
+	}
+
+	private _onDidChangeConfiguration(e: ConfigurationChangeEvent): void {
+		if (!e.affectsConfiguration('git.blame.statusBarItem.enabled')) {
+			return;
+		}
+
+		if (this._isEnabled()) {
+			if (window.activeTextEditor) {
+				this._updateStatusBarItem(window.activeTextEditor);
+			}
+		} else {
+			this._statusBarItem?.dispose();
+			this._statusBarItem = undefined;
+		}
+	}
+
+	private _onDidChangeActiveTextEditor(): void {
+		if (!this._isEnabled()) {
+			return;
+		}
+
+		if (window.activeTextEditor) {
+			this._updateStatusBarItem(window.activeTextEditor);
+		} else {
+			this._statusBarItem?.hide();
+		}
+	}
+
+	private _isEnabled(): boolean {
+		const config = workspace.getConfiguration('git');
+		return config.get<boolean>('blame.statusBarItem.enabled', false);
+	}
+
+	private _updateStatusBarItem(textEditor: TextEditor): void {
+		if (!this._isEnabled() || textEditor !== window.activeTextEditor) {
+			return;
+		}
+
+		if (!this._statusBarItem) {
+			this._statusBarItem = window.createStatusBarItem('git.blame', StatusBarAlignment.Right, 200);
+			this._disposables.push(this._statusBarItem);
+		}
+
+		const blameInformation = this._controller.textEditorBlameInformation.get(textEditor);
+		if (!blameInformation || blameInformation.length === 0) {
+			this._statusBarItem.hide();
+			return;
+		}
+
+		const statueBarItemText = blameInformation[0]
+			? typeof blameInformation[0].blameInformation === 'string'
+				? ` ${blameInformation[0].blameInformation}`
+				: ` ${blameInformation[0].blameInformation.authorName ?? ''} (${fromNow(blameInformation[0].blameInformation.date ?? new Date(), true, true)})`
+			: '';
+
+		this._statusBarItem.text = `$(git-commit)${statueBarItemText}`;
+		this._statusBarItem.show();
+	}
+
+	dispose() {
+		this._disposables = dispose(this._disposables);
+	}
+}