@gitkraken/core-gitlens 0.1.0

package/src/git/parsers/rebaseTodoParser.ts

@@ -0,0 +1,169 @@
+import { maybeStopWatch } from '../../utils/stopwatch.js';
+import { iterateByDelimiter } from '../../utils/string.js';
+import type { ParsedRebaseTodo, RebaseTodoAction, RebaseTodoEntry, RebaseTodoInfo } from '../models/rebase.js';
+
+const rebaseActionsMap = new Map<string, RebaseTodoAction>([
+	// Standard commit commands
+	['p', 'pick'],
+	['pick', 'pick'],
+	['r', 'reword'],
+	['reword', 'reword'],
+	['e', 'edit'],
+	['edit', 'edit'],
+	['s', 'squash'],
+	['squash', 'squash'],
+	['f', 'fixup'],
+	['fixup', 'fixup'],
+	['d', 'drop'],
+	['drop', 'drop'],
+	// Special commands
+	['b', 'break'],
+	['break', 'break'],
+	['x', 'exec'],
+	['exec', 'exec'],
+	['l', 'label'],
+	['label', 'label'],
+	['t', 'reset'],
+	['reset', 'reset'],
+	['m', 'merge'],
+	['merge', 'merge'],
+	['u', 'update-ref'],
+	['update-ref', 'update-ref'],
+	// No-op command (auto-generated by Git for empty rebases)
+	['noop', 'noop'],
+]);
+
+const rebaseHeaderRegex = /^\s?#\s?Rebase\s([0-9a-f]+)(?:\.\.([0-9a-f]+))?\sonto\s([0-9a-f]+)\s.*$/im;
+const mergeCommentSplitRegex = /\s*#\s*/;
+
+// Optimized: Single regex that matches all command types
+// Groups: (action)(sha?)(message/command/ref?)(merge-sha?)(merge-message?)
+const commandRegex =
+	/^(p|pick|r|reword|e|edit|s|squash|f|fixup|d|drop|b|break|x|exec|l|label|t|reset|m|merge|u|update-ref|noop)(?:\s+(?:(-[Cc])\s+)?([0-9a-f]+|\S+))?(?:\s+(?:#\s*)?(.*))?$/;
+
+/**
+ * Parses a git-rebase-todo file content into structured entries
+ *
+ * Supports all Git rebase commands:
+ * - Commit commands: pick, reword, edit, squash, fixup (with -c/-C flags), drop
+ * - Control commands: break, exec, noop
+ * - Label commands: label, reset, merge (with -c/-C flags)
+ * - Ref commands: update-ref
+ *
+ * @param data The content of the git-rebase-todo file
+ * @returns Parsed rebase todo entries with line numbers and optional rebase info
+ */
+export function parseRebaseTodo(data: string | undefined): ParsedRebaseTodo {
+	using sw = maybeStopWatch('Git.parseRebaseTodo', { log: { onlyExit: true, level: 'debug' } });
+
+	if (!data) {
+		sw?.stop({ suffix: ' no data' });
+		return { entries: [] };
+	}
+
+	// Try to extract rebase info from header comment
+	let info: RebaseTodoInfo | undefined;
+	const headerMatch = rebaseHeaderRegex.exec(data);
+	if (headerMatch) {
+		const [, from, to, onto] = headerMatch;
+		info = { from: from || undefined, to: to || undefined, onto: onto };
+	}
+
+	const entries: RebaseTodoEntry[] = [];
+
+	let count = -1;
+	for (let line of iterateByDelimiter(data, '\n')) {
+		count++;
+		line = line.trim();
+
+		// Skip comments and blank lines
+		if (!line || line.startsWith('#')) continue;
+
+		const match = commandRegex.exec(line);
+		if (!match) continue;
+
+		const [, actionStr, mergeFlag, arg1, arg2] = match;
+		const action = rebaseActionsMap.get(actionStr);
+		if (!action) continue;
+
+		// Build entry based on action type
+		let entry: RebaseTodoEntry;
+
+		switch (action) {
+			case 'pick':
+			case 'reword':
+			case 'edit':
+			case 'squash':
+			case 'drop':
+				// Format: action sha message
+				entry = { line: count, action: action, sha: arg1, message: arg2 || '' };
+				break;
+
+			case 'fixup':
+				// Format: fixup [-c|-C] sha message
+				if (mergeFlag) {
+					entry = { line: count, action: action, sha: arg1, message: arg2 || '', flag: mergeFlag };
+				} else {
+					entry = { line: count, action: action, sha: arg1, message: arg2 || '' };
+				}
+				break;
+
+			case 'break':
+			case 'noop':
+				// Format: break or noop (no arguments)
+				entry = { line: count, action: action };
+				break;
+
+			case 'exec': {
+				// Format: exec command
+				// Extract command directly from line to preserve # characters in shell commands
+				const prefixLen = line.startsWith('x ') ? 2 : 5; // 'x ' or 'exec '
+				entry = { line: count, action: action, command: line.slice(prefixLen) };
+				break;
+			}
+
+			case 'label':
+			case 'reset':
+			case 'update-ref':
+				// Format: label ref, reset ref, or update-ref ref
+				entry = { line: count, action: action, ref: arg1 };
+				break;
+
+			case 'merge': {
+				// Format: merge [-C sha] ref [# message]
+				if (mergeFlag && arg1 && arg2) {
+					// merge -C sha ref [# message]
+					const parts = arg2.split(mergeCommentSplitRegex);
+					entry = {
+						line: count,
+						action: action,
+						sha: arg1,
+						ref: parts[0],
+						message: parts[1],
+						flag: mergeFlag,
+					};
+				} else if (arg1) {
+					// merge ref [# message]
+					const parts = arg1.split(mergeCommentSplitRegex);
+					entry = {
+						line: count,
+						action: action,
+						ref: parts[0],
+						message: parts[1],
+					};
+				} else {
+					continue;
+				}
+				break;
+			}
+			default:
+				continue;
+		}
+
+		entries.push(entry);
+	}
+
+	sw?.stop({ suffix: ` parsed ${entries.length} entries` });
+
+	return { entries: entries, info: info };
+}

package/src/git/providers/blame.ts

@@ -0,0 +1,40 @@
+import type { GitBlame, GitBlameLine, ProgressiveGitBlame } from '../models/blame.js';
+import type { DiffRange } from './types.js';
+
+export interface GitBlameOptions {
+	readonly args?: string[] | null;
+	readonly ignoreWhitespace?: boolean;
+}
+
+export interface GitBlameSubProvider {
+	getBlame(
+		repoPath: string,
+		path: string,
+		rev?: string,
+		contents?: string,
+		options?: GitBlameOptions,
+	): Promise<GitBlame | undefined>;
+	getBlameForLine(
+		repoPath: string,
+		path: string,
+		editorLine: number,
+		rev?: string,
+		contents?: string,
+		options?: { forceSingleLine?: boolean } & GitBlameOptions,
+	): Promise<GitBlameLine | undefined>;
+	getBlameForRange(
+		repoPath: string,
+		path: string,
+		range: DiffRange,
+		rev?: string,
+		contents?: string,
+		options?: GitBlameOptions,
+	): Promise<GitBlame | undefined>;
+	getProgressiveBlame?(
+		repoPath: string,
+		path: string,
+		rev?: string,
+		contents?: string,
+		options?: GitBlameOptions,
+	): Promise<ProgressiveGitBlame | undefined>;
+}

package/src/git/providers/branches.ts

@@ -0,0 +1,111 @@
+import type { PagedResult, PagingOptions } from '../../utils/paging.js';
+import type { BranchDisposition, GitBranch } from '../models/branch.js';
+import type { GitCommitStats } from '../models/commit.js';
+import type { GitContributor } from '../models/contributor.js';
+import type { ConflictDetectionResult } from '../models/mergeConflicts.js';
+import type { PullRequest } from '../models/pullRequest.js';
+import type { GitBranchReference } from '../models/reference.js';
+import type { BranchSortOptions } from '../utils/sorting.js';
+
+export interface BranchContributionsOverview extends GitCommitStats<number> {
+	readonly repoPath: string;
+	readonly branch: string;
+	readonly mergeTarget: string;
+	readonly mergeBase: string;
+
+	readonly commits: number;
+	readonly latestCommitDate: Date | undefined;
+	readonly firstCommitDate: Date | undefined;
+
+	readonly contributors: GitContributor[];
+}
+
+export type MergeDetectionConfidence = 'highest' | 'high' | 'medium';
+
+export type GitBranchMergedStatus =
+	| { merged: false }
+	| { merged: true; confidence: MergeDetectionConfidence; localBranchOnly?: GitBranchReference };
+
+export interface GitBranchesSubProvider {
+	getBranch(repoPath: string, name?: string, cancellation?: AbortSignal): Promise<GitBranch | undefined>;
+	getBranches(
+		repoPath: string,
+		options?: {
+			filter?: ((b: GitBranch) => boolean) | undefined;
+			ordering?: 'date' | 'author-date' | 'topo' | null;
+			paging?: PagingOptions | undefined;
+			sort?: boolean | BranchSortOptions | undefined;
+		},
+		cancellation?: AbortSignal,
+	): Promise<PagedResult<GitBranch>>;
+	getBranchContributionsOverview(
+		repoPath: string,
+		ref: string,
+		options?: { associatedPullRequest?: Promise<PullRequest | undefined> },
+		cancellation?: AbortSignal,
+	): Promise<BranchContributionsOverview | undefined>;
+	getBranchesWithCommits(
+		repoPath: string,
+		shas: string[],
+		branch?: string,
+		options?:
+			| { all?: boolean; commitDate?: Date; mode?: 'contains' | 'pointsAt' }
+			| { commitDate?: Date; mode?: 'contains' | 'pointsAt'; remotes?: boolean },
+		cancellation?: AbortSignal,
+	): Promise<string[]>;
+	getDefaultBranchName(
+		repoPath: string | undefined,
+		remote?: string,
+		cancellation?: AbortSignal,
+	): Promise<string | undefined>;
+
+	/**
+	 * Creates a new local branch.
+	 * @param ref SHA or ref (branch, tag, remote-tracking ref) the new branch will point at.
+	 */
+	createBranch?(repoPath: string, name: string, ref: string, options?: { noTracking?: boolean }): Promise<void>;
+	deleteLocalBranch?(repoPath: string, names: string | string[], options?: { force?: boolean }): Promise<void>;
+	deleteRemoteBranch?(repoPath: string, names: string | string[], remote: string): Promise<void>;
+	getBranchMergedStatus?(
+		repoPath: string,
+		branch: GitBranchReference,
+		into: GitBranchReference,
+		cancellation?: AbortSignal,
+	): Promise<GitBranchMergedStatus>;
+	/** @internal not intended to be used outside of the sub-providers */
+	getCurrentBranchReference?(repoPath: string, cancellation?: AbortSignal): Promise<GitBranchReference | undefined>;
+	getLocalBranchByUpstream?(
+		repoPath: string,
+		remoteBranchName: string,
+		cancellation?: AbortSignal,
+	): Promise<GitBranch | undefined>;
+	getPotentialApplyConflicts?(
+		repoPath: string,
+		targetBranch: string,
+		shas: string[],
+		options?: { stopOnFirstConflict?: boolean },
+		cancellation?: AbortSignal,
+	): Promise<ConflictDetectionResult>;
+	getPotentialMergeConflicts?(
+		repoPath: string,
+		branch: string,
+		targetBranch: string,
+		cancellation?: AbortSignal,
+	): Promise<ConflictDetectionResult>;
+	getBaseBranchName?(repoPath: string, ref: string, cancellation?: AbortSignal): Promise<string | undefined>;
+	getStoredMergeTargetBranchName?(repoPath: string, ref: string): Promise<string | undefined>;
+	getStoredDetectedMergeTargetBranchName?(repoPath: string, ref: string): Promise<string | undefined>;
+	getStoredUserMergeTargetBranchName?(repoPath: string, ref: string): Promise<string | undefined>;
+	onCurrentBranchAccessed?(repoPath: string): Promise<void>;
+	onCurrentBranchModified?(repoPath: string): Promise<void>;
+	renameBranch?(repoPath: string, oldName: string, newName: string): Promise<void>;
+	setUpstreamBranch?(repoPath: string, name: string, upstream: string | undefined): Promise<void>;
+	setBranchDisposition?(
+		repoPath: string,
+		branchName: string,
+		disposition: BranchDisposition | undefined,
+	): Promise<void>;
+	storeBaseBranchName?(repoPath: string, ref: string, base: string): Promise<void>;
+	storeMergeTargetBranchName?(repoPath: string, ref: string, target: string): Promise<void>;
+	storeUserMergeTargetBranchName?(repoPath: string, ref: string, target: string | undefined): Promise<void>;
+}

package/src/git/providers/commits.ts

@@ -0,0 +1,147 @@
+import type { Uri } from '../../utils/uri.js';
+import type { GitCommit, GitStashCommit } from '../models/commit.js';
+import type { GitDiffFilter } from '../models/diff.js';
+import type { GitFileChange } from '../models/fileChange.js';
+import type { GitLog } from '../models/log.js';
+import type { GitReflog } from '../models/reflog.js';
+import type { GitRevisionRange } from '../models/revision.js';
+import type { SearchQuery } from '../models/search.js';
+import type { CommitSignature } from '../models/signature.js';
+import type { GitUser } from '../models/user.js';
+import type { DiffRange } from './types.js';
+
+export interface LeftRightCommitCountResult {
+	left: number;
+	right: number;
+}
+
+export interface SearchCommitsResult {
+	readonly search: SearchQuery;
+	readonly log: GitLog | undefined;
+}
+
+interface GitLogOptionsBase {
+	cursor?: string;
+	limit?: number;
+	ordering?: 'date' | 'author-date' | 'topo' | null;
+	/** Similarity threshold for rename detection (0-100). `null` means use Git's default. */
+	similarityThreshold?: number | null;
+}
+
+export interface GitLogOptions extends GitLogOptionsBase {
+	all?: boolean;
+	authors?: GitUser[];
+	/** Whether to include file details in commit results. Defaults to `true`. */
+	includeFiles?: boolean;
+	merges?: boolean | 'first-parent';
+	since?: number | string;
+	stashes?: boolean | Map<string, GitStashCommit>;
+	until?: number | string;
+}
+
+export interface GitLogForPathOptions extends Omit<GitLogOptions, 'stashes'> {
+	filters?: GitDiffFilter[];
+	isFolder?: boolean;
+	range?: DiffRange;
+	renames?: boolean;
+}
+
+export interface GitLogShasOptions extends GitLogOptionsBase {
+	all?: boolean;
+	authors?: GitUser[];
+	merges?: boolean | 'first-parent';
+	pathOrUri?: string | Uri;
+	reverse?: boolean;
+	since?: number | string;
+}
+
+export interface GitSearchCommitsOptions extends GitLogOptionsBase {
+	skip?: number;
+	/** Telemetry source metadata — passed by callers, ignored by library implementations. */
+	source?: { source: string; detail?: string };
+}
+
+export interface IncomingActivityOptions extends GitLogOptionsBase {
+	all?: boolean;
+	branch?: string;
+	skip?: number;
+}
+
+export interface GitCommitReachability {
+	readonly refs: (
+		| { readonly refType: 'branch'; readonly name: string; readonly remote: boolean; readonly current?: boolean }
+		| { readonly refType: 'tag'; readonly name: string; readonly current?: never }
+	)[];
+}
+
+export interface GitCommitsSubProvider {
+	getCommit(repoPath: string, rev: string, cancellation?: AbortSignal): Promise<GitCommit | undefined>;
+	getCommitCount(repoPath: string, rev: string, cancellation?: AbortSignal): Promise<number | undefined>;
+	getCommitFiles(repoPath: string, rev: string, cancellation?: AbortSignal): Promise<GitFileChange[]>;
+	getCommitForFile(
+		repoPath: string,
+		pathOrUri: string | Uri,
+		rev?: string,
+		options?: { firstIfNotFound?: boolean },
+		cancellation?: AbortSignal,
+	): Promise<GitCommit | undefined>;
+	getIncomingActivity?(
+		repoPath: string,
+		options?: IncomingActivityOptions,
+		cancellation?: AbortSignal,
+	): Promise<GitReflog | undefined>;
+	getInitialCommitSha?(repoPath: string, cancellation?: AbortSignal): Promise<string | undefined>;
+	getLeftRightCommitCount(
+		repoPath: string,
+		range: GitRevisionRange,
+		options?: { authors?: GitUser[]; excludeMerges?: boolean },
+		cancellation?: AbortSignal,
+	): Promise<LeftRightCommitCountResult | undefined>;
+	getLog(
+		repoPath: string,
+		rev?: string,
+		options?: GitLogOptions,
+		cancellation?: AbortSignal,
+	): Promise<GitLog | undefined>;
+	getLogForPath(
+		repoPath: string,
+		pathOrUri: string | Uri,
+		rev?: string,
+		options?: GitLogForPathOptions,
+		cancellation?: AbortSignal,
+	): Promise<GitLog | undefined>;
+	getLogShas(
+		repoPath: string,
+		rev?: string,
+		options?: GitLogShasOptions,
+		cancellation?: AbortSignal,
+	): Promise<Iterable<string>>;
+	getOldestUnpushedShaForPath(
+		repoPath: string,
+		pathOrUri: string | Uri,
+		cancellation?: AbortSignal,
+	): Promise<string | undefined>;
+	isAncestorOf(repoPath: string, rev1: string, rev2: string, cancellation?: AbortSignal): Promise<boolean>;
+	hasCommitBeenPushed(repoPath: string, rev: string, cancellation?: AbortSignal): Promise<boolean>;
+	searchCommits(
+		repoPath: string,
+		search: SearchQuery,
+		options?: GitSearchCommitsOptions,
+		cancellation?: AbortSignal,
+	): Promise<SearchCommitsResult>;
+
+	createUnreachableCommitFromTree?(
+		repoPath: string,
+		tree: string,
+		parent: string,
+		message: string,
+		cancellation?: AbortSignal,
+	): Promise<string>;
+	getCommitReachability?(
+		repoPath: string,
+		rev: string,
+		cancellation?: AbortSignal,
+	): Promise<GitCommitReachability | undefined>;
+	getCommitSignature?(repoPath: string, sha: string): Promise<CommitSignature | undefined>;
+	isCommitSigned?(repoPath: string, sha: string): Promise<boolean>;
+}

package/src/git/providers/config.ts

@@ -0,0 +1,104 @@
+import type { GitDir } from '../models/repository.js';
+import type { SigningConfig, ValidationResult } from '../models/signature.js';
+import type { GitUser } from '../models/user.js';
+
+export type GitCoreConfigKeys =
+	| 'commit.gpgsign'
+	| 'core.excludesFile'
+	| 'diff.guitool'
+	| 'diff.tool'
+	| 'gpg.format'
+	| 'gpg.program'
+	| 'gpg.ssh.program'
+	| 'gpg.ssh.allowedSignersFile'
+	| 'init.defaultBranch'
+	| 'user.email'
+	| 'user.name'
+	| 'user.signingkey';
+
+export type GitConfigKeys =
+	| GitCoreConfigKeys
+	/** `vscode-merge-base` — value determined by VS Code that is used to determine the merge base for the current branch. Once `gk-merge-base` is determined, we stop using `vscode-merge-base` */
+	| `branch.${string}.vscode-merge-base`
+	/** `github-pr-owner-number` — value determined by VS Code/GitHub PR extension that is used to determine the PR number for the current branch */
+	| `branch.${string}.github-pr-owner-number`;
+
+export type GkConfigKeys =
+	/** `gk-merge-base` — the branch that the current branch was created from (the original base at branch creation time) */
+	| `branch.${string}.gk-merge-base`
+	/** `gk-merge-target` — the auto-detected branch that the current branch will likely be merged into (used for comparisons, PR targets, etc.) */
+	| `branch.${string}.gk-merge-target`
+	/** `gk-merge-target-user` — user-specified merge target branch; takes precedence over auto-detected `gk-merge-target` */
+	| `branch.${string}.gk-merge-target-user`
+	/** `gk-associated-issues` — JSON array of issue/PR entity identifiers linked to this branch */
+	| `branch.${string}.gk-associated-issues`
+	/** `gk-last-accessed` — ISO 8601 timestamp of when the branch was last checked out or viewed */
+	| `branch.${string}.gk-last-accessed`
+	/** `gk-last-modified` — ISO 8601 timestamp of when the branch last received a commit */
+	| `branch.${string}.gk-last-modified`
+	/** `gk-disposition` — user-assigned branch disposition: 'starred' or 'archived' */
+	| `branch.${string}.gk-disposition`
+	/** `gk.defaultRemote` — the user-designated default remote for the repository */
+	| 'gk.defaultRemote';
+
+export type DeprecatedGkConfigKeys = `branch.${string}.gk-target-base`;
+
+export type GitConfigType = 'bool' | 'int' | 'bool-or-int' | 'path' | 'expiry-date' | 'color';
+
+export interface GitConfigSubProvider {
+	getConfig?(
+		repoPath: string | undefined,
+		key: GitConfigKeys,
+		options?: {
+			global?: boolean;
+			runGitLocally?: boolean;
+			type?: GitConfigType;
+		},
+	): Promise<string | undefined>;
+	getConfigRegex?(
+		repoPath: string | undefined,
+		pattern: string,
+		options?: {
+			global?: boolean;
+			runGitLocally?: boolean;
+		},
+	): Promise<Map<string, string>>;
+	setConfig?(
+		repoPath: string | undefined,
+		key: GitConfigKeys,
+		value: string | undefined,
+		options?: {
+			global?: boolean;
+			runGitLocally?: boolean;
+		},
+	): Promise<void>;
+
+	getCurrentUser(repoPath: string): Promise<GitUser | undefined>;
+	getDefaultWorktreePath?(repoPath: string): Promise<string | undefined>;
+	getGitDir?(repoPath: string): Promise<GitDir | undefined>;
+	getRepositoryInfo?(
+		cwd: string,
+	): Promise<
+		| { repoPath: string; gitDir: string; commonGitDir: string | undefined; superprojectPath: string | undefined }
+		| [safe: true, repoPath: string]
+		| [safe: false]
+		| []
+	>;
+
+	getGkConfig?(
+		repoPath: string,
+		key: GkConfigKeys | DeprecatedGkConfigKeys,
+		options?: { type?: GitConfigType },
+	): Promise<string | undefined>;
+	getGkConfigRegex?(repoPath: string, pattern: string): Promise<Map<string, string>>;
+	setGkConfig?(
+		repoPath: string,
+		key: GkConfigKeys | DeprecatedGkConfigKeys,
+		value: string | undefined,
+	): Promise<void>;
+
+	getSigningConfig?(repoPath: string): Promise<SigningConfig>;
+	getSigningConfigFlags?(config: SigningConfig): string[];
+	setSigningConfig?(repoPath: string, config: Partial<SigningConfig>, options?: { global?: boolean }): Promise<void>;
+	validateSigningSetup?(repoPath: string): Promise<ValidationResult>;
+}

package/src/git/providers/contributors.ts

@@ -0,0 +1,34 @@
+import type { GitContributor, GitContributorsStats } from '../models/contributor.js';
+
+export interface GitContributorsResult {
+	readonly contributors: GitContributor[];
+	readonly cancelled?: { reason: 'cancelled' | 'timedout' } | undefined;
+}
+
+export interface GitContributorsSubProvider {
+	getContributors(
+		repoPath: string,
+		rev?: string,
+		options?: {
+			all?: boolean;
+			merges?: boolean | 'first-parent';
+			pathspec?: string;
+			since?: string;
+			stats?: boolean;
+		},
+		cancellation?: AbortSignal,
+		timeout?: number,
+	): Promise<GitContributorsResult>;
+	getContributorsLite(
+		repoPath: string,
+		rev?: string,
+		options?: { all?: boolean; merges?: boolean | 'first-parent'; since?: string },
+		cancellation?: AbortSignal,
+	): Promise<GitContributor[]>;
+	getContributorsStats(
+		repoPath: string,
+		options?: { merges?: boolean | 'first-parent'; since?: string },
+		cancellation?: AbortSignal,
+		timeout?: number,
+	): Promise<GitContributorsStats | undefined>;
+}