Adds new diff parser

Renames diff models for clarity

Author: eamodio

src/annotations/gutterChangesAnnotationProvider.ts

@@ -2,7 +2,7 @@ import type { CancellationToken, DecorationOptions, Disposable, TextDocument, Te
 import { Hover, languages, Position, Range, Selection, TextEditorRevealType } from 'vscode';
 import type { Container } from '../container';
 import type { GitCommit } from '../git/models/commit';
-import type { GitDiffFile } from '../git/models/diff';
+import type { ParsedGitDiffHunks } from '../git/models/diff';
 import { localChangesMessage } from '../hovers/hovers';
 import { configuration } from '../system/-webview/configuration';
 import { log } from '../system/decorators/log';
@@ -25,7 +25,7 @@ export interface ChangesAnnotationContext extends AnnotationContext {
 export class GutterChangesAnnotationProvider extends AnnotationProviderBase<ChangesAnnotationContext> {
 	private hoverProviderDisposable: Disposable | undefined;
 	private sortedHunkStarts: number[] | undefined;
-	private state: { commit: GitCommit | undefined; diffs: GitDiffFile[] } | undefined;
+	private state: { commit: GitCommit | undefined; diffs: ParsedGitDiffHunks[] } | undefined;
 
 	constructor(
 		container: Container,

src/env/node/git/localGitProvider.ts

@@ -35,7 +35,7 @@ import { isGitUri } from '../../../git/gitUri';
 import { encodeGitLensRevisionUriAuthority } from '../../../git/gitUri.authority';
 import type { GitBlame, GitBlameAuthor, GitBlameLine } from '../../../git/models/blame';
 import type { GitCommit } from '../../../git/models/commit';
-import type { GitDiffFile, GitDiffLine } from '../../../git/models/diff';
+import type { GitLineDiff, ParsedGitDiffHunks } from '../../../git/models/diff';
 import type { GitLog } from '../../../git/models/log';
 import type { GitBranchReference, GitReference } from '../../../git/models/reference';
 import type { GitRemote } from '../../../git/models/remote';
@@ -95,7 +95,7 @@ import { StatusGitSubProvider } from './sub-providers/status';
 import { TagsGitSubProvider } from './sub-providers/tags';
 import { WorktreesGitSubProvider } from './sub-providers/worktrees';
 
-const emptyPromise: Promise<GitBlame | GitDiffFile | GitLog | undefined> = Promise.resolve(undefined);
+const emptyPromise: Promise<GitBlame | ParsedGitDiffHunks | GitLog | undefined> = Promise.resolve(undefined);
 const slash = 47;
 
 const RepoSearchWarnings = {
@@ -1696,7 +1696,11 @@ export class LocalGitProvider implements GitProvider, Disposable {
 	}
 
 	@log()
-	async getDiffForFile(uri: GitUri, ref1: string | undefined, ref2?: string): Promise<GitDiffFile | undefined> {
+	async getDiffForFile(
+		uri: GitUri,
+		ref1: string | undefined,
+		ref2?: string,
+	): Promise<ParsedGitDiffHunks | undefined> {
 		const scope = getLogScope();
 
 		let key = 'diff';
@@ -1738,7 +1742,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 			Logger.debug(scope, `Cache add: '${key}'`);
 
 			const value: CachedDiff = {
-				item: promise as Promise<GitDiffFile>,
+				item: promise as Promise<ParsedGitDiffHunks>,
 			};
 			doc.state.setDiff(key, value);
 		}
@@ -1755,7 +1759,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 		document: TrackedGitDocument,
 		key: string,
 		scope: LogScope | undefined,
-	): Promise<GitDiffFile | undefined> {
+	): Promise<ParsedGitDiffHunks | undefined> {
 		const [relativePath, root] = splitPath(path, repoPath);
 
 		try {
@@ -1776,20 +1780,20 @@ export class LocalGitProvider implements GitProvider, Disposable {
 				Logger.debug(scope, `Cache replace (with empty promise): '${key}'`);
 
 				const value: CachedDiff = {
-					item: emptyPromise as Promise<GitDiffFile>,
+					item: emptyPromise as Promise<ParsedGitDiffHunks>,
 					errorMessage: msg,
 				};
 				document.state.setDiff(key, value);
 
-				return emptyPromise as Promise<GitDiffFile>;
+				return emptyPromise as Promise<ParsedGitDiffHunks>;
 			}
 
 			return undefined;
 		}
 	}
 
 	@log<LocalGitProvider['getDiffForFileContents']>({ args: { 1: '<contents>' } })
-	async getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<GitDiffFile | undefined> {
+	async getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<ParsedGitDiffHunks | undefined> {
 		const scope = getLogScope();
 
 		const key = `diff:${md5(contents)}`;
@@ -1825,7 +1829,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 			Logger.debug(scope, `Cache add: '${key}'`);
 
 			const value: CachedDiff = {
-				item: promise as Promise<GitDiffFile>,
+				item: promise as Promise<ParsedGitDiffHunks>,
 			};
 			doc.state.setDiff(key, value);
 		}
@@ -1842,7 +1846,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 		document: TrackedGitDocument,
 		key: string,
 		scope: LogScope | undefined,
-	): Promise<GitDiffFile | undefined> {
+	): Promise<ParsedGitDiffHunks | undefined> {
 		const [relativePath, root] = splitPath(path, repoPath);
 
 		try {
@@ -1861,12 +1865,12 @@ export class LocalGitProvider implements GitProvider, Disposable {
 				Logger.debug(scope, `Cache replace (with empty promise): '${key}'`);
 
 				const value: CachedDiff = {
-					item: emptyPromise as Promise<GitDiffFile>,
+					item: emptyPromise as Promise<ParsedGitDiffHunks>,
 					errorMessage: msg,
 				};
 				document.state.setDiff(key, value);
 
-				return emptyPromise as Promise<GitDiffFile>;
+				return emptyPromise as Promise<ParsedGitDiffHunks>;
 			}
 
 			return undefined;
@@ -1879,7 +1883,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 		editorLine: number, // 0-based, Git is 1-based
 		ref1: string | undefined,
 		ref2?: string,
-	): Promise<GitDiffLine | undefined> {
+	): Promise<GitLineDiff | undefined> {
 		try {
 			const diff = await this.getDiffForFile(uri, ref1, ref2);
 			if (diff == null) return undefined;

src/env/node/git/sub-providers/commits.ts

@@ -8,7 +8,7 @@ import type { GitCommitsSubProvider, LeftRightCommitCountResult } from '../../..
 import { GitUri } from '../../../../git/gitUri';
 import type { GitBlame } from '../../../../git/models/blame';
 import type { GitCommit, GitStashCommit } from '../../../../git/models/commit';
-import type { GitDiffFile } from '../../../../git/models/diff';
+import type { ParsedGitDiffHunks } from '../../../../git/models/diff';
 import type { GitFile } from '../../../../git/models/file';
 import { GitFileChange } from '../../../../git/models/fileChange';
 import type { GitFileStatus } from '../../../../git/models/fileStatus';
@@ -44,7 +44,7 @@ import type { Git } from '../git';
 import { gitLogDefaultConfigs, gitLogDefaultConfigsWithFiles } from '../git';
 import type { LocalGitProvider } from '../localGitProvider';
 
-const emptyPromise: Promise<GitBlame | GitDiffFile | GitLog | undefined> = Promise.resolve(undefined);
+const emptyPromise: Promise<GitBlame | ParsedGitDiffHunks | GitLog | undefined> = Promise.resolve(undefined);
 const reflogCommands = ['merge', 'pull'];
 
 export class CommitsGitSubProvider implements GitCommitsSubProvider {

src/git/gitProvider.ts

@@ -11,7 +11,14 @@ import type { GitBlame, GitBlameLine } from './models/blame';
 import type { GitBranch } from './models/branch';
 import type { GitCommit, GitCommitStats } from './models/commit';
 import type { GitContributor, GitContributorsStats } from './models/contributor';
-import type { GitDiff, GitDiffFile, GitDiffFiles, GitDiffFilter, GitDiffLine, GitDiffShortStat } from './models/diff';
+import type {
+	GitDiff,
+	GitDiffFiles,
+	GitDiffFilter,
+	GitDiffShortStat,
+	GitLineDiff,
+	ParsedGitDiffHunks,
+} from './models/diff';
 import type { GitFile } from './models/file';
 import type { GitFileChange } from './models/fileChange';
 import type { GitGraph } from './models/graph';
@@ -750,14 +757,14 @@ export interface GitProvider extends GitRepositoryProvider, Disposable {
 	 * @param ref1 Commit to diff from
 	 * @param ref2 Commit to diff to
 	 */
-	getDiffForFile(uri: GitUri, ref1: string | undefined, ref2?: string): Promise<GitDiffFile | undefined>;
+	getDiffForFile(uri: GitUri, ref1: string | undefined, ref2?: string): Promise<ParsedGitDiffHunks | undefined>;
 	/**
 	 * Returns a file diff between a commit and the specified contents
 	 * @param uri Uri of the file to diff
 	 * @param ref Commit to diff from
 	 * @param contents Contents to use for the diff
 	 */
-	getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<GitDiffFile | undefined>;
+	getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<ParsedGitDiffHunks | undefined>;
 	/**
 	 * Returns a line diff between two commits
 	 * @param uri Uri of the file to diff
@@ -770,7 +777,7 @@ export interface GitProvider extends GitRepositoryProvider, Disposable {
 		editorLine: number,
 		ref1: string | undefined,
 		ref2?: string,
-	): Promise<GitDiffLine | undefined>;
+	): Promise<GitLineDiff | undefined>;
 	hasUnsafeRepositories?(): boolean;
 	isTrackable(uri: Uri): boolean;
 	isTracked(uri: Uri): Promise<boolean>;

src/git/gitProviderService.ts

@@ -70,7 +70,7 @@ import { createSubProviderProxyForRepo } from './gitProvider';
 import type { GitUri } from './gitUri';
 import type { GitBlame, GitBlameLine } from './models/blame';
 import type { GitBranch } from './models/branch';
-import type { GitDiffFile, GitDiffLine } from './models/diff';
+import type { GitLineDiff, ParsedGitDiffHunks } from './models/diff';
 import type { GitFile } from './models/file';
 import type { GitBranchReference, GitReference } from './models/reference';
 import type { GitRemote } from './models/remote';
@@ -1691,7 +1691,7 @@ export class GitProviderService implements Disposable {
 	 * @param ref1 Commit to diff from
 	 * @param ref2 Commit to diff to
 	 */
-	getDiffForFile(uri: GitUri, ref1: string | undefined, ref2?: string): Promise<GitDiffFile | undefined> {
+	getDiffForFile(uri: GitUri, ref1: string | undefined, ref2?: string): Promise<ParsedGitDiffHunks | undefined> {
 		const { provider } = this.getProvider(uri);
 		return provider.getDiffForFile(uri, ref1, ref2);
 	}
@@ -1703,7 +1703,7 @@ export class GitProviderService implements Disposable {
 	 * @param ref Commit to diff from
 	 * @param contents Contents to use for the diff
 	 */
-	getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<GitDiffFile | undefined> {
+	getDiffForFileContents(uri: GitUri, ref: string, contents: string): Promise<ParsedGitDiffHunks | undefined> {
 		const { provider } = this.getProvider(uri);
 		return provider.getDiffForFileContents(uri, ref, contents);
 	}
@@ -1721,7 +1721,7 @@ export class GitProviderService implements Disposable {
 		editorLine: number,
 		ref1: string | undefined,
 		ref2?: string,
-	): Promise<GitDiffLine | undefined> {
+	): Promise<GitLineDiff | undefined> {
 		const { provider } = this.getProvider(uri);
 		return provider.getDiffForLine(uri, editorLine, ref1, ref2);
 	}

src/git/models/diff.ts

@@ -1,4 +1,4 @@
-import type { GitFileChange } from './fileChange';
+import type { GitFileChange, GitFileChangeShape } from './fileChange';
 import type { GitRevisionRangeNotation } from './revision';
 
 export interface GitDiff {
@@ -8,49 +8,56 @@ export interface GitDiff {
 	readonly notation: GitRevisionRangeNotation | undefined;
 }
 
-export interface GitDiffHunkLine {
-	current: string | undefined;
-	previous: string | undefined;
-	state: 'added' | 'changed' | 'removed' | 'unchanged';
-}
-
-export interface GitDiffHunk {
-	readonly contents: string;
-	readonly current: {
-		readonly count: number;
-		readonly position: { readonly start: number; readonly end: number };
-	};
-	readonly previous: {
-		readonly count: number;
-		readonly position: { readonly start: number; readonly end: number };
-	};
-	readonly lines: Map<number, GitDiffHunkLine>;
+export interface GitDiffFiles {
+	readonly files: GitFileChange[];
 }
 
-export interface GitDiffFile {
-	readonly hunks: GitDiffHunk[];
-	readonly contents?: string;
+export interface GitDiffFileStats {
+	readonly added: number;
+	readonly deleted: number;
+	readonly changed: number;
 }
 
-export interface GitDiffLine {
-	readonly hunk: GitDiffHunk;
-	readonly line: GitDiffHunkLine;
-}
+export type GitDiffFilter = 'A' | 'C' | 'D' | 'M' | 'R' | 'T' | 'U' | 'X' | 'B' | '*';
 
 export interface GitDiffShortStat {
 	readonly files: number;
 	readonly additions: number;
 	readonly deletions: number;
 }
 
-export interface GitDiffFiles {
-	readonly files: GitFileChange[];
+export interface GitLineDiff {
+	readonly hunk: ParsedGitDiffHunk;
+	readonly line: ParsedGitDiffHunkLine;
 }
 
-export interface GitDiffFileStats {
-	readonly added: number;
-	readonly deleted: number;
-	readonly changed: number;
+export interface ParsedGitDiff {
+	readonly files: ParsedGitDiffFile[];
+	readonly contents?: string;
 }
 
-export type GitDiffFilter = 'A' | 'C' | 'D' | 'M' | 'R' | 'T' | 'U' | 'X' | 'B' | '*';
+export interface ParsedGitDiffFile extends Omit<GitFileChangeShape, 'repoPath'>, ParsedGitDiffHunks {}
+
+export interface ParsedGitDiffHunks {
+	readonly hunks: ParsedGitDiffHunk[];
+	readonly contents?: string;
+}
+
+export interface ParsedGitDiffHunk {
+	readonly contents: string;
+	readonly current: {
+		readonly count: number;
+		readonly position: { readonly start: number; readonly end: number };
+	};
+	readonly previous: {
+		readonly count: number;
+		readonly position: { readonly start: number; readonly end: number };
+	};
+	readonly lines: Map<number, ParsedGitDiffHunkLine>;
+}
+
+export interface ParsedGitDiffHunkLine {
+	current: string | undefined;
+	previous: string | undefined;
+	state: 'added' | 'changed' | 'removed' | 'unchanged';
+}