Major refactor/rework -- many new features and breaking changes

Adds all-new, beautiful, highly customizable and themeable, file blame annotations Adds all-new configurability and themeability to the current line blame annotations Adds all-new configurability to the status bar blame information Adds all-new configurability over which commands are added to which menus via the `gitlens.advanced.menus` setting Adds better configurability over where Git code lens will be shown -- both by default and per language Adds an all-new `changes` (diff) hover annotation to the current line - provides instant access to the line's previous version Adds `Toggle Line Blame Annotations` command (`gitlens.toggleLineBlame`) - toggles the current line blame annotations on and off Adds `Show Line Blame Annotations` command (`gitlens.showLineBlame`) - shows the current line blame annotations Adds `Toggle File Blame Annotations` command (`gitlens.toggleFileBlame`) - toggles the file blame annotations on and off Adds `Show File Blame Annotations` command (`gitlens.showFileBlame`) - shows the file blame annotations Adds `Open File in Remote` command (`gitlens.openFileInRemote`) to the `editor/title` context menu Adds `Open Repo in Remote` command (`gitlens.openRepoInRemote`) to the `editor/title` context menu Changes the position of the `Open File in Remote` command (`gitlens.openFileInRemote`) in the context menus - now in the `navigation` group Changes the `Toggle Git Code Lens` command (`gitlens.toggleCodeLens`) to always toggle the Git code lens on and off Removes the on-demand `trailing` file blame annotations -- didn't work out and just ended up with a ton of visual noise Removes `Toggle Blame Annotations` command (`gitlens.toggleBlame`) - replaced by the `Toggle File Blame Annotations` command (`gitlens.toggleFileBlame`) Removes `Show Blame Annotations` command (`gitlens.showBlame`) - replaced by the `Show File Blame Annotations` command (`gitlens.showFileBlame`)
2026-01-16 09:35:40 -05:00 · 2017-06-03 00:37:33 -04:00
parent e3e7605268
commit 37e48ded2d
40 changed files with 3389 additions and 2279 deletions
--- a/src/annotations/annotationProvider.ts
+++ b/src/annotations/annotationProvider.ts
@@ -0,0 +1,74 @@
+'use strict';
+import { Functions } from '../system';
+import { Disposable, ExtensionContext, TextDocument, TextEditor, TextEditorDecorationType, TextEditorSelectionChangeEvent, window, workspace } from 'vscode';
+import { TextDocumentComparer } from '../comparers';
+import { ExtensionKey, FileAnnotationType, IConfig } from '../configuration';
+import { WhitespaceController } from './whitespaceController';
+
+ export abstract class AnnotationProviderBase extends Disposable {
+
+    public annotationType: FileAnnotationType;
+    public document: TextDocument;
+
+    protected _config: IConfig;
+    protected _disposable: Disposable;
+
+    constructor(context: ExtensionContext, public editor: TextEditor, protected decoration: TextEditorDecorationType, protected highlightDecoration: TextEditorDecorationType | undefined, protected whitespaceController: WhitespaceController | undefined) {
+        super(() => this.dispose());
+
+        this.document = this.editor.document;
+
+        this._config = workspace.getConfiguration().get<IConfig>(ExtensionKey)!;
+
+        const subscriptions: Disposable[] = [];
+
+        subscriptions.push(window.onDidChangeTextEditorSelection(this._onTextEditorSelectionChanged, this));
+
+        this._disposable = Disposable.from(...subscriptions);
+    }
+
+    async dispose() {
+        await this.clear();
+
+        this._disposable && this._disposable.dispose();
+    }
+
+    private async _onTextEditorSelectionChanged(e: TextEditorSelectionChangeEvent) {
+        if (!TextDocumentComparer.equals(this.document, e.textEditor && e.textEditor.document)) return;
+
+        return this.selection(e.selections[0].active.line);
+    }
+
+    async clear() {
+        if (this.editor !== undefined) {
+            try {
+                this.editor.setDecorations(this.decoration, []);
+                this.highlightDecoration && this.editor.setDecorations(this.highlightDecoration, []);
+                // I have no idea why the decorators sometimes don't get removed, but if they don't try again with a tiny delay
+                if (this.highlightDecoration !== undefined) {
+                    await Functions.wait(1);
+
+                    if (this.highlightDecoration === undefined) return;
+
+                    this.editor.setDecorations(this.highlightDecoration, []);
+                }
+            }
+            catch (ex) { }
+        }
+
+        // HACK: Until https://github.com/Microsoft/vscode/issues/11485 is fixed -- restore whitespace
+        this.whitespaceController && await this.whitespaceController.restore();
+    }
+
+    async reset() {
+        await this.clear();
+
+        this._config = workspace.getConfiguration().get<IConfig>(ExtensionKey)!;
+
+        await this.provideAnnotation(this.editor === undefined ? undefined : this.editor.selection.active.line);
+    }
+
+    abstract async provideAnnotation(shaOrLine?: string | number): Promise<boolean>;
+    abstract async selection(shaOrLine?: string | number): Promise<void>;
+    abstract async validate(): Promise<boolean>;
+ }