Browse Source
Adds support for git commands on scheme=git
Rewrites blame annotation controller and provider - fixes whitespace issues, reduces overhead, and provides better performance Rewrites status bar blame support - reduces overhead and provides better performance Adds showFileHistory command to status bar Renames showHistory to showFileHistory Fixes log to use iso 8601 for datesmain
Eric Amodio
8 years ago
29 changed files with 615 additions and 282 deletions
Split View
Diff Options
-
+7 -2CHANGELOG.md
-
+3 -3README.md
-
+19 -11package.json
-
+154 -34src/blameAnnotationController.ts
-
+70 -33src/blameAnnotationProvider.ts
-
+73 -23src/blameStatusBarController.ts
-
+15 -10src/commands/diffLineWithPrevious.ts
-
+16 -11src/commands/diffLineWithWorking.ts
-
+14 -10src/commands/diffWithPrevious.ts
-
+16 -11src/commands/diffWithWorking.ts
-
+8 -15src/commands/showBlame.ts
-
+4 -2src/commands/showBlameHistory.ts
-
+7 -5src/commands/showFileHistory.ts
-
+8 -15src/commands/toggleBlame.ts
-
+42 -0src/comparers.ts
-
+8 -4src/configuration.ts
-
+2 -2src/constants.ts
-
+4 -4src/extension.ts
-
+4 -4src/git/enrichers/blameParserEnricher.ts
-
+5 -5src/git/enrichers/logParserEnricher.ts
-
+3 -3src/git/git.ts
-
+1 -0src/git/gitLocator.ts
-
+1 -1src/gitBlameCodeLensProvider.ts
-
+7 -7src/gitCodeLensProvider.ts
-
+16 -5src/gitContentProvider.ts
-
+72 -34src/gitProvider.ts
-
+1 -0src/system.ts
-
+7 -0src/system/iterable.ts
+ 7
- 2
CHANGELOG.md
View File
+ 3
- 3
README.md
View File
+ 19
- 11
package.json
View File
+ 154
- 34
src/blameAnnotationController.ts
View File
| @ -1,64 +1,184 @@ | |||
| 'use strict'; | |||
| import { Disposable, ExtensionContext, TextEditor, workspace } from 'vscode'; | |||
| import { Functions, IDeferred } from './system'; | |||
| import { commands, Disposable, ExtensionContext, TextDocument, TextEditor, TextEditorViewColumnChangeEvent, window, workspace } from 'vscode'; | |||
| import { BlameAnnotationProvider } from './blameAnnotationProvider'; | |||
| import { TextDocumentComparer, TextEditorComparer } from './comparers'; | |||
| import { BuiltInCommands } from './constants'; | |||
| import GitProvider from './gitProvider'; | |||
| import { Logger } from './logger'; | |||
| export default class BlameAnnotationController extends Disposable { | |||
| private _disposable: Disposable; | |||
| private _annotationProvider: BlameAnnotationProvider | undefined; | |||
| private _annotationProviders: Map<number, BlameAnnotationProvider> = new Map(); | |||
| private _blameAnnotationsDisposable: Disposable; | |||
| private _pendingWhitespaceToggleDisposable: Disposable; | |||
| private _pendingClearAnnotations: Map<number, (() => void) & IDeferred> = new Map(); | |||
| private _pendingWhitespaceToggles: Set<number> = new Set(); | |||
| private _visibleColumns: Set<number>; | |||
| constructor(private context: ExtensionContext, private git: GitProvider) { | |||
| super(() => this.dispose()); | |||
| } | |||
| const subscriptions: Disposable[] = []; | |||
| dispose() { | |||
| for (const fn of this._pendingClearAnnotations.values()) { | |||
| fn.cancel(); | |||
| } | |||
| this._annotationProviders.forEach(async (p, i) => await this.clear(i)); | |||
| this._blameAnnotationsDisposable && this._blameAnnotationsDisposable.dispose(); | |||
| this._pendingWhitespaceToggleDisposable && this._pendingWhitespaceToggleDisposable.dispose(); | |||
| } | |||
| // subscriptions.push(window.onDidChangeActiveTextEditor(e => { | |||
| // if (!e || !this._controller || this._controller.editor === e) return; | |||
| // this.clear(); | |||
| // })); | |||
| async clear(column: number, toggleRenderWhitespace: boolean = true) { | |||
| const provider = this._annotationProviders.get(column); | |||
| if (!provider) return; | |||
| subscriptions.push(workspace.onDidCloseTextDocument(d => { | |||
| if (!this._annotationProvider || this._annotationProvider.uri.fsPath !== d.uri.fsPath) return; | |||
| this.clear(); | |||
| })); | |||
| this._annotationProviders.delete(column); | |||
| await provider.dispose(toggleRenderWhitespace); | |||
| this._disposable = Disposable.from(...subscriptions); | |||
| if (this._annotationProviders.size === 0) { | |||
| Logger.log(`Remove listener registrations for blame annotations`); | |||
| this._blameAnnotationsDisposable && this._blameAnnotationsDisposable.dispose(); | |||
| this._blameAnnotationsDisposable = undefined; | |||
| } | |||
| } | |||
| dispose() { | |||
| this.clear(); | |||
| this._disposable && this._disposable.dispose(); | |||
| async showBlameAnnotation(editor: TextEditor, shaOrLine?: string | number): Promise<boolean> { | |||
| if (!editor || !editor.document) return false; | |||
| if (!this._blameAnnotationsDisposable && this._annotationProviders.size === 0) { | |||
| Logger.log(`Add listener registrations for blame annotations`); | |||
| const subscriptions: Disposable[] = []; | |||
| subscriptions.push(window.onDidChangeVisibleTextEditors(Functions.debounce(this._onVisibleTextEditorsChanged, 100), this)); | |||
| subscriptions.push(window.onDidChangeTextEditorViewColumn(this._onTextEditorViewColumnChanged, this)); | |||
| subscriptions.push(workspace.onDidCloseTextDocument(this._onTextDocumentClosed, this)); | |||
| this._blameAnnotationsDisposable = Disposable.from(...subscriptions); | |||
| this._visibleColumns = this._getVisibleColumns(window.visibleTextEditors); | |||
| } | |||
| let provider = this._annotationProviders.get(editor.viewColumn); | |||
| if (provider) { | |||
| if (TextEditorComparer.equals(provider.editor, editor)) { | |||
| await provider.setSelection(shaOrLine); | |||
| return true; | |||
| } | |||
| await this.clear(provider.editor.viewColumn, false); | |||
| } | |||
| provider = new BlameAnnotationProvider(this.context, this.git, editor); | |||
| this._annotationProviders.set(editor.viewColumn, provider); | |||
| return provider.provideBlameAnnotation(shaOrLine); | |||
| } | |||
| clear() { | |||
| this._annotationProvider && this._annotationProvider.dispose(); | |||
| this._annotationProvider = undefined; | |||
| async toggleBlameAnnotation(editor: TextEditor, shaOrLine?: string | number): Promise<boolean> { | |||
| if (!editor || !editor.document) return false; | |||
| let provider = this._annotationProviders.get(editor.viewColumn); | |||
| if (!provider) return this.showBlameAnnotation(editor, shaOrLine); | |||
| await this.clear(provider.editor.viewColumn); | |||
| return false; | |||
| } | |||
| get annotated() { | |||
| return this._annotationProvider !== undefined; | |||
| private _getVisibleColumns(editors: TextEditor[]): Set<number> { | |||
| const set: Set<number> = new Set(); | |||
| for (const e of editors) { | |||
| if (e.viewColumn === undefined) continue; | |||
| set.add(e.viewColumn); | |||
| } | |||
| return set; | |||
| } | |||
| showBlameAnnotation(editor: TextEditor, sha?: string): Promise<void> { | |||
| if (!editor || !editor.document || editor.document.isUntitled) { | |||
| this.clear(); | |||
| return Promise.resolve(); | |||
| private _onActiveTextEditorChanged(e: TextEditor) { | |||
| if (e.viewColumn === undefined || this._pendingWhitespaceToggles.size === 0) return; | |||
| if (this._pendingWhitespaceToggles.has(e.viewColumn)) { | |||
| Logger.log('ActiveTextEditorChanged:', `Remove pending whitespace toggle for column ${e.viewColumn}`); | |||
| this._pendingWhitespaceToggles.delete(e.viewColumn); | |||
| // HACK: Until https://github.com/Microsoft/vscode/issues/11485 is fixed -- toggle whitespace back on | |||
| Logger.log('ActiveTextEditorChanged:', `Toggle whitespace rendering on`); | |||
| commands.executeCommand(BuiltInCommands.ToggleRenderWhitespace); | |||
| } | |||
| if (!this._annotationProvider) { | |||
| this._annotationProvider = new BlameAnnotationProvider(this.context, this.git, editor); | |||
| return this._annotationProvider.provideBlameAnnotation(sha); | |||
| if (this._pendingWhitespaceToggles.size === 0) { | |||
| Logger.log('ActiveTextEditorChanged:', `Remove listener registrations for pending whitespace toggles`); | |||
| this._pendingWhitespaceToggleDisposable.dispose(); | |||
| this._pendingWhitespaceToggleDisposable = undefined; | |||
| } | |||
| } | |||
| private _onTextDocumentClosed(e: TextDocument) { | |||
| for (const [key, p] of this._annotationProviders) { | |||
| if (!TextDocumentComparer.equals(p.document, e)) continue; | |||
| Logger.log('TextDocumentClosed:', `Add pending clear of blame annotations for column ${key}`); | |||
| // Since we don't know if a whole column is going away -- we don't know if we should reset the whitespace | |||
| // So defer until onDidChangeVisibleTextEditors fires | |||
| const fn = Functions.debounce(() => { | |||
| this._pendingClearAnnotations.delete(key); | |||
| this.clear(key); | |||
| }, 250); | |||
| this._pendingClearAnnotations.set(key, fn); | |||
| fn(); | |||
| } | |||
| } | |||
| private async _onTextEditorViewColumnChanged(e: TextEditorViewColumnChangeEvent) { | |||
| this._visibleColumns = this._getVisibleColumns(window.visibleTextEditors); | |||
| return Promise.resolve(); | |||
| Logger.log('TextEditorViewColumnChanged:', `Clear blame annotations for column ${e.viewColumn}`); | |||
| await this.clear(e.viewColumn); | |||
| for (const [key, p] of this._annotationProviders) { | |||
| if (!TextEditorComparer.equals(p.editor, e.textEditor)) continue; | |||
| Logger.log('TextEditorViewColumnChanged:', `Clear blame annotations for column ${key}`); | |||
| await this.clear(key, false); | |||
| } | |||
| } | |||
| toggleBlameAnnotation(editor: TextEditor, sha?: string): Promise<void> { | |||
| if (!editor || !editor.document || editor.document.isUntitled || this._annotationProvider) { | |||
| this.clear(); | |||
| return Promise.resolve(); | |||
| private async _onVisibleTextEditorsChanged(e: TextEditor[]) { | |||
| if (e.every(_ => _.document.uri.scheme === 'inmemory')) return; | |||
| this._visibleColumns = this._getVisibleColumns(e); | |||
| for (const [key, fn] of this._pendingClearAnnotations) { | |||
| Logger.log('VisibleTextEditorsChanged:', `Remove pending blame annotations for column ${key}`); | |||
| fn.cancel(); | |||
| this._pendingClearAnnotations.delete(key); | |||
| // Clear and reset the whitespace depending on if the column went away | |||
| Logger.log('VisibleTextEditorsChanged:', `Clear blame annotations for column ${key}`); | |||
| await this.clear(key, this._visibleColumns.has(key)); | |||
| } | |||
| return this.showBlameAnnotation(editor, sha); | |||
| for (const [key, p] of this._annotationProviders) { | |||
| if (e.some(_ => TextEditorComparer.equals(p.editor, _))) continue; | |||
| Logger.log('VisibleTextEditorsChanged:', `Clear blame annotations for column ${key}`); | |||
| const editor = window.activeTextEditor; | |||
| if (p.requiresRenderWhitespaceToggle && (editor && editor.viewColumn !== key)) { | |||
| this.clear(key, false); | |||
| if (!this._pendingWhitespaceToggleDisposable) { | |||
| Logger.log('VisibleTextEditorsChanged:', `Add listener registrations for pending whitespace toggles`); | |||
| this._pendingWhitespaceToggleDisposable = window.onDidChangeActiveTextEditor(this._onActiveTextEditorChanged, this); | |||
| } | |||
| Logger.log('VisibleTextEditorsChanged:', `Add pending whitespace toggle for column ${key}`); | |||
| this._pendingWhitespaceToggles.add(key); | |||
| } | |||
| else { | |||
| this.clear(key); | |||
| } | |||
| } | |||
| } | |||
| } | |||
+ 70
- 33
src/blameAnnotationProvider.ts
View File
+ 73
- 23
src/blameStatusBarController.ts
View File
+ 15
- 10
src/commands/diffLineWithPrevious.ts
View File
+ 16
- 11
src/commands/diffLineWithWorking.ts
View File
+ 14
- 10
src/commands/diffWithPrevious.ts
View File
+ 16
- 11
src/commands/diffWithWorking.ts
View File
+ 8
- 15
src/commands/showBlame.ts
View File
+ 4
- 2
src/commands/showBlameHistory.ts
View File
src/commands/showHistory.ts → src/commands/showFileHistory.ts
View File
+ 8
- 15
src/commands/toggleBlame.ts
View File
+ 42
- 0
src/comparers.ts
View File
| @ -0,0 +1,42 @@ | |||
| 'use strict'; | |||
| import { TextDocument, TextEditor, Uri } from 'vscode'; | |||
| abstract class Comparer<T> { | |||
| abstract equals(lhs: T, rhs: T): boolean; | |||
| } | |||
| class UriComparer extends Comparer<Uri> { | |||
| equals(lhs: Uri, rhs: Uri) { | |||
| if (!lhs && !rhs) return true; | |||
| if ((lhs && !rhs) || (!lhs && rhs)) return false; | |||
| return lhs.scheme === rhs.scheme && lhs.fsPath === rhs.fsPath; | |||
| } | |||
| } | |||
| class TextDocumentComparer extends Comparer<TextDocument> { | |||
| equals(lhs: TextDocument, rhs: TextDocument) { | |||
| if (!lhs && !rhs) return true; | |||
| if ((lhs && !rhs) || (!lhs && rhs)) return false; | |||
| return uriComparer.equals(lhs.uri, rhs.uri); | |||
| } | |||
| } | |||
| class TextEditorComparer extends Comparer<TextEditor> { | |||
| equals(lhs: TextEditor, rhs: TextEditor) { | |||
| if (!lhs && !rhs) return true; | |||
| if ((lhs && !rhs) || (!lhs && rhs)) return false; | |||
| return textDocumentComparer.equals(lhs.document, rhs.document); | |||
| } | |||
| } | |||
| const textDocumentComparer = new TextDocumentComparer(); | |||
| const textEditorComparer = new TextEditorComparer(); | |||
| const uriComparer = new UriComparer(); | |||
| export { | |||
| textDocumentComparer as TextDocumentComparer, | |||
| textEditorComparer as TextEditorComparer, | |||
| uriComparer as UriComparer | |||
| }; | |||
+ 8
- 4
src/configuration.ts
View File
+ 2
- 2
src/constants.ts
View File
+ 4
- 4
src/extension.ts
View File
+ 4
- 4
src/git/enrichers/blameParserEnricher.ts
View File
+ 5
- 5
src/git/enrichers/logParserEnricher.ts
View File
+ 3
- 3
src/git/git.ts
View File
+ 1
- 0
src/git/gitLocator.ts
View File
+ 1
- 1
src/gitBlameCodeLensProvider.ts
View File
+ 7
- 7
src/gitCodeLensProvider.ts
View File
+ 16
- 5
src/gitContentProvider.ts
View File
| @ -1,18 +1,29 @@ | |||
| 'use strict'; | |||
| import { ExtensionContext, TextDocumentContentProvider, Uri } from 'vscode'; | |||
| import { ExtensionContext, TextDocumentContentProvider, Uri, window } from 'vscode'; | |||
| import { DocumentSchemes } from './constants'; | |||
| import GitProvider from './gitProvider'; | |||
| import { Logger } from './logger'; | |||
| import * as path from 'path'; | |||
| export default class GitContentProvider implements TextDocumentContentProvider { | |||
| static scheme = DocumentSchemes.Git; | |||
| constructor(context: ExtensionContext, private git: GitProvider) { } | |||
| provideTextDocumentContent(uri: Uri): string | Thenable<string> { | |||
| async provideTextDocumentContent(uri: Uri): Promise<string> { | |||
| const data = GitProvider.fromGitUri(uri); | |||
| return this.git.getVersionedFileText(data.originalFileName || data.fileName, data.repoPath, data.sha) | |||
| .then(text => data.decoration ? `${data.decoration}\n${text}` : text) | |||
| .catch(ex => Logger.error('[GitLens.GitContentProvider]', 'getVersionedFileText', ex)); | |||
| const fileName = data.originalFileName || data.fileName; | |||
| try { | |||
| let text = await this.git.getVersionedFileText(fileName, data.repoPath, data.sha); | |||
| if (data.decoration) { | |||
| text = `${data.decoration}\n${text}`; | |||
| } | |||
| return text; | |||
| } | |||
| catch (ex) { | |||
| Logger.error('[GitLens.GitContentProvider]', 'getVersionedFileText', ex); | |||
| await window.showErrorMessage(`Unable to show Git revision ${data.sha} of '${path.relative(data.repoPath, fileName)}'`); | |||
| return undefined; | |||
| } | |||
| } | |||
| } | |||