Browse Source
Overhauls recent change annotations
Renamed to Gutter Changes Provides local changes if any, or recent commit changes Distinguishes between added, changed, and removed lines Shows a hover for the full diff hunk Shows diff even with unsaved changesmain
Eric Amodio
4 years ago
30 changed files with 1199 additions and 837 deletions
Split View
Diff Options
-
+19 -19README.md
-
+45 -48package.json
-
+37 -69src/annotations/annotationProvider.ts
-
+5 -5src/annotations/annotations.ts
-
+49 -131src/annotations/blameAnnotationProvider.ts
-
+98 -93src/annotations/fileAnnotationController.ts
-
+60 -11src/annotations/gutterBlameAnnotationProvider.ts
-
+283 -0src/annotations/gutterChangesAnnotationProvider.ts
-
+13 -11src/annotations/gutterHeatmapBlameAnnotationProvider.ts
-
+0 -142src/annotations/recentChangesAnnotationProvider.ts
-
+1 -1src/commands/common.ts
-
+6 -6src/commands/toggleFileAnnotations.ts
-
+19 -16src/config.ts
-
+5 -5src/container.ts
-
+5 -0src/extension.ts
-
+1 -7src/git/formatters/commitFormatter.ts
-
+76 -10src/git/git.ts
-
+125 -17src/git/gitService.ts
-
+21 -5src/git/models/diff.ts
-
+22 -6src/git/parsers/diffParser.ts
-
+43 -0src/git/parsers/logParser.ts
-
+96 -52src/hovers/hovers.ts
-
+6 -5src/hovers/lineHoverController.ts
-
+4 -0src/views/nodes/viewNode.ts
-
+2 -2src/views/viewCommands.ts
-
+2 -2src/webviews/apps/settings/partials/blame.ejs
-
+19 -37src/webviews/apps/settings/partials/changes.ejs
-
+8 -8src/webviews/apps/settings/settings.ejs
+ 19
- 19
README.md
View File
+ 45
- 48
package.json
View File
+ 37
- 69
src/annotations/annotationProvider.ts
View File
+ 5
- 5
src/annotations/annotations.ts
View File
+ 49
- 131
src/annotations/blameAnnotationProvider.ts
View File
+ 98
- 93
src/annotations/fileAnnotationController.ts
View File
+ 60
- 11
src/annotations/gutterBlameAnnotationProvider.ts
View File
+ 283
- 0
src/annotations/gutterChangesAnnotationProvider.ts
View File
| @ -0,0 +1,283 @@ | |||
| 'use strict'; | |||
| import { | |||
| CancellationToken, | |||
| DecorationOptions, | |||
| Disposable, | |||
| Hover, | |||
| languages, | |||
| Position, | |||
| Range, | |||
| Selection, | |||
| TextDocument, | |||
| TextEditor, | |||
| TextEditorDecorationType, | |||
| TextEditorRevealType, | |||
| } from 'vscode'; | |||
| import { AnnotationProviderBase } from './annotationProvider'; | |||
| import { FileAnnotationType } from '../configuration'; | |||
| import { Container } from '../container'; | |||
| import { Decorations } from './fileAnnotationController'; | |||
| import { GitDiff, GitLogCommit } from '../git/git'; | |||
| import { Hovers } from '../hovers/hovers'; | |||
| import { Logger } from '../logger'; | |||
| import { log, Strings } from '../system'; | |||
| import { GitDocumentState, TrackedDocument } from '../trackers/gitDocumentTracker'; | |||
| export class GutterChangesAnnotationProvider extends AnnotationProviderBase { | |||
| private state: { commit: GitLogCommit | undefined; diffs: GitDiff[] } | undefined; | |||
| private hoverProviderDisposable: Disposable | undefined; | |||
| constructor(editor: TextEditor, trackedDocument: TrackedDocument<GitDocumentState>) { | |||
| super(editor, trackedDocument); | |||
| } | |||
| clear() { | |||
| this.state = undefined; | |||
| if (this.hoverProviderDisposable != null) { | |||
| this.hoverProviderDisposable.dispose(); | |||
| this.hoverProviderDisposable = undefined; | |||
| } | |||
| super.clear(); | |||
| } | |||
| selection(_shaOrLine?: string | number): Promise<void> { | |||
| return Promise.resolve(); | |||
| } | |||
| validate(): Promise<boolean> { | |||
| return Promise.resolve(true); | |||
| } | |||
| @log() | |||
| async onProvideAnnotation(shaOrLine?: string | number): Promise<boolean> { | |||
| const cc = Logger.getCorrelationContext(); | |||
| this.annotationType = FileAnnotationType.Changes; | |||
| let ref1 = this.trackedDocument.uri.sha; | |||
| let ref2; | |||
| if (typeof shaOrLine === 'string') { | |||
| if (shaOrLine !== this.trackedDocument.uri.sha) { | |||
| ref2 = `${shaOrLine}^`; | |||
| } | |||
| } | |||
| let commit: GitLogCommit | undefined; | |||
| let localChanges = ref1 == null && ref2 == null; | |||
| if (localChanges) { | |||
| let ref = await Container.git.getOldestUnpushedRefForFile( | |||
| this.trackedDocument.uri.repoPath!, | |||
| this.trackedDocument.uri.fsPath, | |||
| ); | |||
| if (ref != null) { | |||
| ref = `${ref}^`; | |||
| commit = await Container.git.getCommitForFile( | |||
| this.trackedDocument.uri.repoPath, | |||
| this.trackedDocument.uri.fsPath, | |||
| { ref: ref }, | |||
| ); | |||
| if (commit != null) { | |||
| if (ref2 != null) { | |||
| ref2 = ref; | |||
| } else { | |||
| ref1 = ref; | |||
| ref2 = ''; | |||
| } | |||
| } else { | |||
| localChanges = false; | |||
| } | |||
| } else { | |||
| const status = await Container.git.getStatusForFile( | |||
| this.trackedDocument.uri.repoPath!, | |||
| this.trackedDocument.uri.fsPath, | |||
| ); | |||
| const commits = await status?.toPsuedoCommits(); | |||
| if (commits?.length) { | |||
| commit = await Container.git.getCommitForFile( | |||
| this.trackedDocument.uri.repoPath, | |||
| this.trackedDocument.uri.fsPath, | |||
| ); | |||
| ref1 = 'HEAD'; | |||
| } else if (this.trackedDocument.dirty) { | |||
| ref1 = 'HEAD'; | |||
| } else { | |||
| localChanges = false; | |||
| } | |||
| } | |||
| } | |||
| if (!localChanges) { | |||
| commit = await Container.git.getCommitForFile( | |||
| this.trackedDocument.uri.repoPath, | |||
| this.trackedDocument.uri.fsPath, | |||
| { | |||
| ref: ref2 ?? ref1, | |||
| }, | |||
| ); | |||
| if (commit == null) return false; | |||
| if (ref2 != null) { | |||
| ref2 = commit.ref; | |||
| } else { | |||
| ref1 = commit.ref; | |||
| ref2 = `${commit.ref}^`; | |||
| } | |||
| } | |||
| const diffs = ( | |||
| await Promise.all( | |||
| ref2 == null && this.editor.document.isDirty | |||
| ? [ | |||
| Container.git.getDiffForFileContents( | |||
| this.trackedDocument.uri, | |||
| ref1!, | |||
| this.editor.document.getText(), | |||
| ), | |||
| Container.git.getDiffForFile(this.trackedDocument.uri, ref1, ref2), | |||
| ] | |||
| : [Container.git.getDiffForFile(this.trackedDocument.uri, ref1, ref2)], | |||
| ) | |||
| ).filter(Boolean) as GitDiff[]; | |||
| if (!diffs?.length) return false; | |||
| let start = process.hrtime(); | |||
| const decorationsMap = new Map< | |||
| string, | |||
| { decorationType: TextEditorDecorationType; rangesOrOptions: DecorationOptions[] } | |||
| >(); | |||
| let selection: Selection | undefined; | |||
| for (const diff of diffs) { | |||
| for (const hunk of diff.hunks) { | |||
| // Subtract 2 because editor lines are 0-based and we will be adding 1 in the first iteration of the loop | |||
| let count = Math.max(hunk.current.position.start - 2, -1); | |||
| let index = -1; | |||
| for (const hunkLine of hunk.lines) { | |||
| index++; | |||
| count++; | |||
| if (hunkLine.current?.state === 'unchanged') continue; | |||
| const range = this.editor.document.validateRange( | |||
| new Range(new Position(count, 0), new Position(count, Number.MAX_SAFE_INTEGER)), | |||
| ); | |||
| if (selection == null) { | |||
| selection = new Selection(range.start, range.end); | |||
| } | |||
| let state; | |||
| if (hunkLine.current == null) { | |||
| const previous = hunk.lines[index - 1]; | |||
| if (hunkLine.previous != null && (previous == null || previous.current != null)) { | |||
| // Check if there are more deleted lines than added lines show a deleted indicator | |||
| if (hunk.previous.count > hunk.current.count) { | |||
| state = 'removed'; | |||
| } else { | |||
| continue; | |||
| } | |||
| } else { | |||
| continue; | |||
| } | |||
| } else if (hunkLine.current?.state === 'added') { | |||
| if (hunkLine.previous?.state === 'removed') { | |||
| state = 'changed'; | |||
| } else { | |||
| state = 'added'; | |||
| } | |||
| } else if (hunkLine?.current.state === 'removed') { | |||
| // Check if there are more deleted lines than added lines show a deleted indicator | |||
| if (hunk.previous.count > hunk.current.count) { | |||
| state = 'removed'; | |||
| } else { | |||
| continue; | |||
| } | |||
| } else { | |||
| state = 'changed'; | |||
| } | |||
| let decoration = decorationsMap.get(state); | |||
| if (decoration == null) { | |||
| decoration = { | |||
| decorationType: (state === 'added' | |||
| ? Decorations.changesLineAddedAnnotation | |||
| : state === 'removed' | |||
| ? Decorations.changesLineDeletedAnnotation | |||
| : Decorations.changesLineChangedAnnotation)!, | |||
| rangesOrOptions: [{ range: range }], | |||
| }; | |||
| decorationsMap.set(state, decoration); | |||
| } else { | |||
| decoration.rangesOrOptions.push({ range: range }); | |||
| } | |||
| } | |||
| } | |||
| } | |||
| Logger.log(cc, `${Strings.getDurationMilliseconds(start)} ms to compute recent changes annotations`); | |||
| if (decorationsMap.size) { | |||
| start = process.hrtime(); | |||
| this.setDecorations([...decorationsMap.values()]); | |||
| Logger.log(cc, `${Strings.getDurationMilliseconds(start)} ms to apply recent changes annotations`); | |||
| if (selection != null) { | |||
| this.editor.selection = selection; | |||
| this.editor.revealRange(selection, TextEditorRevealType.InCenterIfOutsideViewport); | |||
| } | |||
| } | |||
| this.state = { commit: commit, diffs: diffs }; | |||
| this.registerHoverProvider(); | |||
| return true; | |||
| } | |||
| registerHoverProvider() { | |||
| if (!Container.config.hovers.enabled || !Container.config.hovers.annotations.enabled) { | |||
| return; | |||
| } | |||
| this.hoverProviderDisposable = languages.registerHoverProvider( | |||
| { pattern: this.document.uri.fsPath }, | |||
| { | |||
| provideHover: (document, position, token) => this.provideHover(document, position, token), | |||
| }, | |||
| ); | |||
| } | |||
| provideHover(document: TextDocument, position: Position, _token: CancellationToken): Hover | undefined { | |||
| if (this.state == null) return undefined; | |||
| if (Container.config.hovers.annotations.over !== 'line' && position.character !== 0) return undefined; | |||
| const { commit, diffs } = this.state; | |||
| for (const diff of diffs) { | |||
| for (const hunk of diff.hunks) { | |||
| // If we have a "mixed" diff hunk, check if we have more deleted lines than added, to include a trailing line for the deleted indicator | |||
| const hasMoreDeletedLines = hunk.state === 'changed' && hunk.previous.count > hunk.current.count; | |||
| if ( | |||
| position.line >= hunk.current.position.start - 1 && | |||
| position.line <= hunk.current.position.end - (hasMoreDeletedLines ? 0 : 1) | |||
| ) { | |||
| return new Hover( | |||
| Hovers.localChangesMessage(commit, this.trackedDocument.uri, position.line, hunk), | |||
| document.validateRange( | |||
| new Range( | |||
| hunk.current.position.start - 1, | |||
| 0, | |||
| hunk.current.position.end - (hasMoreDeletedLines ? 0 : 1), | |||
| Number.MAX_SAFE_INTEGER, | |||
| ), | |||
| ), | |||
| ); | |||
| } | |||
| } | |||
| } | |||
| return undefined; | |||
| } | |||
| } | |||
src/annotations/heatmapBlameAnnotationProvider.ts → src/annotations/gutterHeatmapBlameAnnotationProvider.ts
View File
+ 0
- 142
src/annotations/recentChangesAnnotationProvider.ts
View File
| @ -1,142 +0,0 @@ | |||
| 'use strict'; | |||
| import { | |||
| MarkdownString, | |||
| Position, | |||
| Range, | |||
| Selection, | |||
| TextEditor, | |||
| TextEditorDecorationType, | |||
| TextEditorRevealType, | |||
| } from 'vscode'; | |||
| import { AnnotationProviderBase } from './annotationProvider'; | |||
| import { FileAnnotationType } from '../configuration'; | |||
| import { Container } from '../container'; | |||
| import { GitUri } from '../git/gitUri'; | |||
| import { Hovers } from '../hovers/hovers'; | |||
| import { Logger } from '../logger'; | |||
| import { log, Strings } from '../system'; | |||
| import { GitDocumentState, TrackedDocument } from '../trackers/gitDocumentTracker'; | |||
| export class RecentChangesAnnotationProvider extends AnnotationProviderBase { | |||
| private readonly _uri: GitUri; | |||
| constructor( | |||
| editor: TextEditor, | |||
| trackedDocument: TrackedDocument<GitDocumentState>, | |||
| decoration: TextEditorDecorationType, | |||
| highlightDecoration: TextEditorDecorationType | undefined, | |||
| ) { | |||
| super(editor, trackedDocument, decoration, highlightDecoration); | |||
| this._uri = trackedDocument.uri; | |||
| } | |||
| @log() | |||
| async onProvideAnnotation(shaOrLine?: string | number): Promise<boolean> { | |||
| const cc = Logger.getCorrelationContext(); | |||
| this.annotationType = FileAnnotationType.RecentChanges; | |||
| let ref1 = this._uri.sha; | |||
| let ref2; | |||
| if (typeof shaOrLine === 'string') { | |||
| if (shaOrLine !== this._uri.sha) { | |||
| ref2 = `${shaOrLine}^`; | |||
| } | |||
| } | |||
| const commit = await Container.git.getCommitForFile(this._uri.repoPath, this._uri.fsPath, { | |||
| ref: ref2 ?? ref1, | |||
| }); | |||
| if (commit === undefined) return false; | |||
| if (ref2 !== undefined) { | |||
| ref2 = commit.ref; | |||
| } else { | |||
| ref1 = commit.ref; | |||
| } | |||
| const diff = await Container.git.getDiffForFile(this._uri, ref1, ref2); | |||
| if (diff === undefined) return false; | |||
| let start = process.hrtime(); | |||
| const cfg = Container.config; | |||
| const dateFormat = cfg.defaultDateFormat; | |||
| this.decorations = []; | |||
| let selection: Selection | undefined; | |||
| for (const hunk of diff.hunks) { | |||
| // Subtract 2 because editor lines are 0-based and we will be adding 1 in the first iteration of the loop | |||
| let count = hunk.currentPosition.start - 2; | |||
| for (const hunkLine of hunk.lines) { | |||
| if (hunkLine.current === undefined) continue; | |||
| count++; | |||
| if (hunkLine.current.state === 'unchanged') continue; | |||
| const range = this.editor.document.validateRange( | |||
| new Range(new Position(count, 0), new Position(count, Number.MAX_SAFE_INTEGER)), | |||
| ); | |||
| if (selection === undefined) { | |||
| selection = new Selection(range.start, range.end); | |||
| } | |||
| let message: MarkdownString | undefined = undefined; | |||
| if (cfg.hovers.enabled && cfg.hovers.annotations.enabled) { | |||
| if (cfg.hovers.annotations.details) { | |||
| this.decorations.push({ | |||
| hoverMessage: await Hovers.detailsMessage( | |||
| commit, | |||
| await GitUri.fromUri(this.editor.document.uri), | |||
| count, | |||
| dateFormat, | |||
| this.annotationType, | |||
| ), | |||
| range: range, | |||
| }); | |||
| } | |||
| if (cfg.hovers.annotations.changes) { | |||
| message = await Hovers.changesMessage(commit, this._uri, count, hunkLine); | |||
| if (message === undefined) continue; | |||
| } | |||
| } | |||
| this.decorations.push({ | |||
| hoverMessage: message, | |||
| range: range, | |||
| }); | |||
| } | |||
| } | |||
| Logger.log(cc, `${Strings.getDurationMilliseconds(start)} ms to compute recent changes annotations`); | |||
| if (this.decoration != null && this.decorations.length) { | |||
| start = process.hrtime(); | |||
| this.editor.setDecorations(this.decoration, this.decorations); | |||
| Logger.log(cc, `${Strings.getDurationMilliseconds(start)} ms to apply recent changes annotations`); | |||
| if (selection !== undefined) { | |||
| this.editor.selection = selection; | |||
| this.editor.revealRange(selection, TextEditorRevealType.InCenterIfOutsideViewport); | |||
| } | |||
| } | |||
| return true; | |||
| } | |||
| selection(_shaOrLine?: string | number): Promise<void> { | |||
| return Promise.resolve(undefined); | |||
| } | |||
| validate(): Promise<boolean> { | |||
| return Promise.resolve(true); | |||
| } | |||
| } | |||