@gitkraken/core-gitlens 0.6.0 → 0.7.1

package/src/git/errors.ts

@@ -1,1168 +0,0 @@
-import { pluralize } from '../utils/string.js';
-import type { GitPausedOperationStatus } from './models/pausedOperationStatus.js';
-
-/**
- * stderr patterns git emits that are EXPECTED rather than exceptional — an empty repo, a path that doesn't
- * exist at a revision, a branch with no upstream. The exec layer matches these to decide a command "warned"
- * rather than failed.
- *
- * Matching one does NOT mean the empty output is a valid answer: `noCommits` on a fresh repo genuinely means
- * "no commits", while `notARepository` means the read never happened. Callers must branch on which key
- * matched — see `GitRunCompletion`. Pure patterns with no environment dependency, so this lives here rather
- * than in the CLI provider, where the shared run contract couldn't reference it.
- */
-export const GitWarnings = {
-	notARepository: /Not a git repository/i,
-	outsideRepository: /is outside repository/i,
-	noPath: /no such path/i,
-	noCommits: /does not have any commits/i,
-	notFound: /Path '.*?' does not exist in/i,
-	foundButNotInRevision: /Path '.*?' exists on disk, but not in/i,
-	headNotABranch: /HEAD does not point to a branch/i,
-	noUpstream: /no upstream configured for branch '(.*?)'/i,
-	unknownRevision:
-		/ambiguous argument '.*?': unknown revision or path not in the working tree|not stored as a remote-tracking branch/i,
-	mustRunInWorkTree: /this operation must be run in a work tree/i,
-	patchWithConflicts: /Applied patch to '.*?' with conflicts/i,
-	noRemoteRepositorySpecified: /No remote repository specified\./i,
-	remoteConnectionError: /Could not read from remote repository/i,
-	notAGitCommand: /'.+' is not a git command/i,
-	tipBehind: /tip of your current branch is behind/i,
-} as const;
-
-export type GitWarningKey = keyof typeof GitWarnings;
-
-export interface GitCommandContext {
-	readonly repoPath: string;
-	readonly args: readonly (string | undefined)[];
-}
-
-export abstract class GitCommandError<Details extends { gitCommand?: GitCommandContext }> extends Error {
-	static is(ex: unknown): ex is GitCommandError<any> {
-		return ex instanceof GitCommandError;
-	}
-
-	private _details!: Details;
-	get details(): Details {
-		return this._details;
-	}
-	private set details(details: Details) {
-		this._details = details;
-		this.message = this.buildErrorMessage(details);
-	}
-
-	readonly original?: Error;
-
-	constructor(message: string, details: Details, original: Error | undefined) {
-		super(message);
-		this.original = original;
-		this.details = details;
-		Error.captureStackTrace?.(this, new.target);
-	}
-
-	protected abstract buildErrorMessage(details: Details): string;
-
-	update(changes: Details): this {
-		this.details = { ...this.details, ...changes };
-		return this;
-	}
-}
-
-export type GitSearchErrorReason = 'invalidPattern' | 'invalidRef';
-
-export class GitSearchError extends Error {
-	static is(ex: unknown): ex is GitSearchError {
-		return ex instanceof GitSearchError;
-	}
-
-	constructor(
-		public readonly original: Error,
-		public readonly reason?: GitSearchErrorReason,
-		public readonly detail?: string,
-	) {
-		super(original.message);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export type ApplyPatchCommitErrorReason =
-	| 'appliedWithConflicts'
-	| 'applyFailed'
-	| 'checkoutFailed'
-	| 'createWorktreeFailed'
-	| 'stashFailed'
-	| 'wouldOverwriteChanges';
-interface ApplyPatchCommitErrorDetails {
-	reason?: ApplyPatchCommitErrorReason;
-	branch?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class ApplyPatchCommitError extends GitCommandError<ApplyPatchCommitErrorDetails> {
-	static override is(ex: unknown): ex is ApplyPatchCommitError;
-	static override is<R extends ApplyPatchCommitErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is ApplyPatchCommitError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: ApplyPatchCommitErrorReason): boolean {
-		return ex instanceof ApplyPatchCommitError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: ApplyPatchCommitErrorDetails, original?: Error) {
-		super('Unable to apply patch', details, original);
-	}
-
-	override buildErrorMessage(details: ApplyPatchCommitErrorDetails): string {
-		const baseMessage = 'Unable to apply patch';
-		switch (details.reason) {
-			case 'applyFailed':
-				return `${baseMessage}${this.original instanceof CherryPickError ? `. ${this.original.message}` : ''}`;
-			case 'appliedWithConflicts':
-				return 'Patch applied with conflicts';
-			case 'checkoutFailed':
-				return `${baseMessage} as we were unable to checkout the branch '${details.branch}'${
-					this.original instanceof CheckoutError ? `. ${this.original.message}` : ''
-				}`;
-			case 'createWorktreeFailed':
-				return `${baseMessage} as we were unable to create a worktree${
-					this.original instanceof WorktreeCreateError ? `. ${this.original.message}` : ''
-				}`;
-			case 'stashFailed':
-				return `${baseMessage} as we were unable to stash your working changes${
-					this.original instanceof StashPushError ? `. ${this.original.message}` : ''
-				}`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} as some local changes would be overwritten`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type CommitErrorReason = 'nothingToCommit' | 'conflicts' | 'noUserNameConfigured' | 'other';
-interface CommitErrorDetails {
-	reason?: CommitErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class CommitError extends GitCommandError<CommitErrorDetails> {
-	static override is(ex: unknown): ex is CommitError;
-	static override is<R extends CommitErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is CommitError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: CommitErrorReason): boolean {
-		return ex instanceof CommitError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: CommitErrorDetails, original?: Error) {
-		super('Unable to commit', details, original);
-	}
-
-	protected override buildErrorMessage(details: CommitErrorDetails): string {
-		const baseMessage = 'Unable to commit';
-		switch (details.reason) {
-			case 'nothingToCommit':
-				return `${baseMessage} because there are no staged changes`;
-			case 'conflicts':
-				return `${baseMessage} because there are unresolved merge conflicts`;
-			case 'noUserNameConfigured':
-				return 'Please configure your git user name and email before committing';
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export class BlameIgnoreRevsFileError extends Error {
-	static is(ex: unknown): ex is BlameIgnoreRevsFileError {
-		return ex instanceof BlameIgnoreRevsFileError;
-	}
-
-	constructor(
-		public readonly fileName: string,
-		public readonly original?: Error,
-	) {
-		super(`Invalid blame.ignoreRevsFile: '${fileName}'`);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export class BlameIgnoreRevsFileBadRevisionError extends Error {
-	static is(ex: unknown): ex is BlameIgnoreRevsFileBadRevisionError {
-		return ex instanceof BlameIgnoreRevsFileBadRevisionError;
-	}
-
-	constructor(
-		public readonly revision: string,
-		public readonly original?: Error,
-	) {
-		super(`Invalid revision in blame.ignoreRevsFile: '${revision}'`);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export type BranchErrorReason = 'alreadyExists' | 'notFullyMerged' | 'invalidName' | 'noRemoteReference' | 'other';
-interface BranchErrorDetails {
-	reason?: BranchErrorReason;
-	action?: string;
-	branch?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class BranchError extends GitCommandError<BranchErrorDetails> {
-	static override is(ex: unknown): ex is BranchError;
-	static override is<R extends BranchErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is BranchError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: BranchErrorReason): boolean {
-		return ex instanceof BranchError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: BranchErrorDetails, original?: Error) {
-		super('Unable to perform action on branch', details, original);
-	}
-
-	protected override buildErrorMessage(details: BranchErrorDetails): string {
-		let baseMessage: string;
-		if (details.action != null) {
-			baseMessage = `Unable to ${details.action} branch ${details.branch ? `'${details.branch}'` : ''}`;
-		} else {
-			baseMessage = `Unable to perform action ${details.branch ? `with branch '${details.branch}'` : 'on branch'}`;
-		}
-		switch (details.reason) {
-			case 'alreadyExists':
-				return `${baseMessage} because it already exists`;
-			case 'notFullyMerged':
-				return `${baseMessage} because it is not fully merged`;
-			case 'invalidName':
-				return `${baseMessage} because the branch name is invalid`;
-			case 'noRemoteReference':
-				return `${baseMessage} because the remote reference does not exist`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type CheckoutErrorReason = 'invalidRef' | 'pathspecNotFound' | 'wouldOverwriteChanges' | 'other';
-interface CheckoutErrorDetails {
-	reason?: CheckoutErrorReason;
-	ref?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class CheckoutError extends GitCommandError<CheckoutErrorDetails> {
-	static override is(ex: unknown): ex is CheckoutError;
-	static override is<R extends CheckoutErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is CheckoutError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: CheckoutErrorReason): boolean {
-		return ex instanceof CheckoutError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: CheckoutErrorDetails, original?: Error) {
-		super('Unable to checkout', details, original);
-	}
-
-	protected override buildErrorMessage(details: CheckoutErrorDetails): string {
-		const baseMessage = `Unable to checkout${details.ref ? ` '${details.ref}'` : ''}`;
-		switch (details.reason) {
-			case 'invalidRef':
-				return `${baseMessage} because the reference is invalid`;
-			case 'pathspecNotFound':
-				return `${baseMessage} because the path or reference does not exist`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage}. Your local changes would be overwritten. Please commit or stash your changes before switching branches.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type CherryPickErrorReason =
-	| 'aborted'
-	| 'alreadyInProgress'
-	| 'conflicts'
-	| 'emptyCommit'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface CherryPickErrorDetails {
-	reason?: CherryPickErrorReason;
-	revs?: string[];
-	gitCommand?: GitCommandContext;
-}
-
-export class CherryPickError extends GitCommandError<CherryPickErrorDetails> {
-	static override is(ex: unknown): ex is CherryPickError;
-	static override is<R extends CherryPickErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is CherryPickError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: CherryPickErrorReason): boolean {
-		return ex instanceof CherryPickError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: CherryPickErrorDetails, original?: Error) {
-		super('Unable to cherry-pick', details, original);
-	}
-
-	protected override buildErrorMessage(details: CherryPickErrorDetails): string {
-		const baseMessage = `Unable to cherry-pick${
-			details.revs?.length
-				? details.revs.length === 1
-					? ` commit '${details.revs[0]}'`
-					: ` ${pluralize('commit', details.revs.length)}`
-				: ''
-		}`;
-
-		switch (details.reason) {
-			case 'aborted':
-				return `${baseMessage} as it was aborted.`;
-			case 'alreadyInProgress':
-				return `${baseMessage} as a cherry-pick is already in progress.`;
-			case 'conflicts':
-				return `${baseMessage} due to conflicts.`;
-			case 'emptyCommit':
-				return `${baseMessage} because it is an empty commit.`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} as some local changes would be overwritten.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type FetchErrorReason = 'noFastForward' | 'noRemote' | 'remoteConnectionFailed' | 'other';
-interface FetchErrorDetails {
-	reason?: FetchErrorReason;
-	branch?: string;
-	remote?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class FetchError extends GitCommandError<FetchErrorDetails> {
-	static override is(ex: unknown): ex is FetchError;
-	static override is<R extends FetchErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is FetchError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: FetchErrorReason): boolean {
-		return ex instanceof FetchError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: FetchErrorDetails, original?: Error) {
-		super('Unable to fetch', details, original);
-	}
-
-	protected override buildErrorMessage(details: FetchErrorDetails): string {
-		const baseMessage = `Unable to fetch${details.branch ? ` branch '${details.branch}'` : ''}${
-			details.remote ? ` from ${details.remote}` : ''
-		}`;
-		switch (details.reason) {
-			case 'noFastForward':
-				return `${baseMessage} as it cannot be fast-forwarded`;
-			case 'noRemote':
-				return `${baseMessage} without a remote repository specified.`;
-			case 'remoteConnectionFailed':
-				return `${baseMessage}. Could not connect to the remote repository.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type MergeErrorReason =
-	| 'aborted'
-	| 'alreadyInProgress'
-	| 'conflicts'
-	| 'uncommittedChanges'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface MergeErrorDetails {
-	reason?: MergeErrorReason;
-	ref?: string;
-	gitCommand?: GitCommandContext;
-}
-export class MergeError extends GitCommandError<MergeErrorDetails> {
-	static override is(ex: unknown): ex is MergeError;
-	static override is<R extends MergeErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is MergeError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: MergeErrorReason): boolean {
-		return ex instanceof MergeError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: MergeErrorDetails, original?: Error) {
-		super('Unable to merge', details, original);
-	}
-
-	protected override buildErrorMessage(details: MergeErrorDetails): string {
-		const baseMessage = `Unable to merge${details.ref ? ` '${details.ref}'` : ''}`;
-
-		switch (details.reason) {
-			case 'aborted':
-				return `Merge${details.ref ? ` of '${details.ref}'` : ''} was aborted`;
-			case 'alreadyInProgress':
-				return `${baseMessage} because a merge is already in progress`;
-			case 'conflicts':
-				return `${baseMessage} due to conflicts. Resolve the conflicts first and continue the merge`;
-			case 'uncommittedChanges':
-				return `${baseMessage} because there are uncommitted changes`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} because some local changes would be overwritten`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type PausedOperationAbortErrorReason = 'nothingToAbort';
-interface PausedOperationAbortErrorDetails {
-	reason?: PausedOperationAbortErrorReason;
-	operation: GitPausedOperationStatus;
-	gitCommand?: GitCommandContext;
-}
-
-export class PausedOperationAbortError extends GitCommandError<PausedOperationAbortErrorDetails> {
-	static override is(ex: unknown): ex is PausedOperationAbortError;
-	static override is<R extends PausedOperationAbortErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is PausedOperationAbortError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: PausedOperationAbortErrorReason): boolean {
-		return ex instanceof PausedOperationAbortError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: PausedOperationAbortErrorDetails, original?: Error) {
-		super('Unable to abort operation', details, original);
-	}
-
-	protected override buildErrorMessage(details: PausedOperationAbortErrorDetails): string {
-		switch (details.reason) {
-			case 'nothingToAbort':
-				return `Cannot abort as there is no ${details.operation.type} operation in progress`;
-			default:
-				return `Unable to abort the ${details.operation.type} operation${this.original ? `: ${this.original.message}` : ''}`;
-		}
-	}
-}
-
-export type PausedOperationContinueErrorReason =
-	| 'conflicts'
-	| 'emptyCommit'
-	| 'messageEditFailed'
-	| 'nothingToContinue'
-	| 'uncommittedChanges'
-	| 'unmergedFiles'
-	| 'unstagedChanges'
-	| 'wouldOverwriteChanges';
-interface PausedOperationContinueErrorDetails {
-	reason?: PausedOperationContinueErrorReason;
-	operation: GitPausedOperationStatus;
-	skip?: boolean;
-	gitCommand?: GitCommandContext;
-}
-
-export class PausedOperationContinueError extends GitCommandError<PausedOperationContinueErrorDetails> {
-	static override is(ex: unknown): ex is PausedOperationContinueError;
-	static override is<R extends PausedOperationContinueErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is PausedOperationContinueError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: PausedOperationContinueErrorReason): boolean {
-		return ex instanceof PausedOperationContinueError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: PausedOperationContinueErrorDetails, original?: Error) {
-		super('Unable to continue operation', details, original);
-	}
-
-	protected override buildErrorMessage(details: PausedOperationContinueErrorDetails): string {
-		switch (details.reason) {
-			case 'conflicts':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as there are unresolved conflicts`;
-			case 'emptyCommit':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as the previous commit is empty`;
-			case 'messageEditFailed':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as a commit message needs to be edited and the editor could not be opened`;
-			case 'nothingToContinue':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as there is no ${details.operation.type} in progress`;
-			case 'uncommittedChanges':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as there are uncommitted changes`;
-			case 'unmergedFiles':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as there are unmerged files`;
-			case 'unstagedChanges':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as there are unstaged changes`;
-			case 'wouldOverwriteChanges':
-				return `Cannot ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation as some local changes would be overwritten`;
-			default:
-				return `Unable to ${details.skip ? 'skip' : 'continue'} the ${details.operation.type} operation${this.original ? `: ${this.original.message}` : ''}`;
-		}
-	}
-}
-
-export type PullErrorReason =
-	| 'conflict'
-	| 'gitIdentity'
-	| 'rebaseMultipleBranches'
-	| 'refLocked'
-	| 'remoteConnectionFailed'
-	| 'tagConflict'
-	| 'uncommittedChanges'
-	| 'unmergedFiles'
-	| 'unstagedChanges'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface PullErrorDetails {
-	reason?: PullErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class PullError extends GitCommandError<PullErrorDetails> {
-	static override is(ex: unknown): ex is PullError;
-	static override is<R extends PullErrorReason>(ex: unknown, reason: R): ex is PullError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: PullErrorReason): boolean {
-		return ex instanceof PullError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: PullErrorDetails, original?: Error) {
-		super('Unable to pull', details, original);
-	}
-
-	protected override buildErrorMessage(details: PullErrorDetails): string {
-		const baseMessage = 'Unable to pull';
-		switch (details.reason) {
-			case 'conflict':
-				return 'Unable to complete pull due to conflicts which must be resolved.';
-			case 'gitIdentity':
-				return `${baseMessage} because you have not yet set up your Git identity.`;
-			case 'rebaseMultipleBranches':
-				return `${baseMessage} because you are trying to rebase onto multiple branches.`;
-			case 'refLocked':
-				return `${baseMessage} because a local ref could not be updated.`;
-			case 'remoteConnectionFailed':
-				return `${baseMessage} because the remote repository could not be reached.`;
-			case 'tagConflict':
-				return `${baseMessage} because a local tag would be overwritten.`;
-			case 'uncommittedChanges':
-				return `${baseMessage} because you have uncommitted changes.`;
-			case 'unmergedFiles':
-				return `${baseMessage} because you have unmerged files.`;
-			case 'unstagedChanges':
-				return `${baseMessage} because you have unstaged changes.`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} because local changes to some files would be overwritten.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type PushErrorReason =
-	| 'noUpstream'
-	| 'permissionDenied'
-	| 'rejected'
-	| 'rejectedRefDoesNotExist'
-	| 'rejectedWithLease'
-	| 'rejectedWithLeaseIfIncludes'
-	| 'remoteAhead'
-	| 'remoteConnectionFailed'
-	| 'tipBehind'
-	| 'other';
-interface PushErrorDetails {
-	reason?: PushErrorReason;
-	branch?: string;
-	remote?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class PushError extends GitCommandError<PushErrorDetails> {
-	static override is(ex: unknown): ex is PushError;
-	static override is<R extends PushErrorReason>(ex: unknown, reason: R): ex is PushError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: PushErrorReason): boolean {
-		return ex instanceof PushError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: PushErrorDetails, original?: Error) {
-		super('Unable to push', details, original);
-	}
-
-	protected override buildErrorMessage(details: PushErrorDetails): string {
-		const baseMessage = `Unable to push${details.branch ? ` branch '${details.branch}'` : ''}${
-			details.remote ? ` to ${details.remote}` : ''
-		}`;
-		switch (details.reason) {
-			case 'noUpstream':
-				return `${baseMessage} because it has no upstream branch.`;
-			case 'permissionDenied':
-				return `${baseMessage} because you don't have permission to push to this remote repository.`;
-			case 'rejected':
-				return `${baseMessage} because some refs failed to push or the push was rejected. Try pulling first.`;
-			case 'rejectedRefDoesNotExist':
-				return `Unable to delete remote branch${details.branch ? ` '${details.branch}'` : ''}${
-					details.remote ? ` from ${details.remote}` : ''
-				}, the remote reference does not exist`;
-			case 'rejectedWithLease':
-			case 'rejectedWithLeaseIfIncludes':
-				return `Unable to force push${details.branch ? ` branch '${details.branch}'` : ''}${
-					details.remote ? ` to ${details.remote}` : ''
-				} because some refs failed to push or the push was rejected. The tip of the remote-tracking branch has been updated since the last checkout. Try pulling first.`;
-			case 'remoteAhead':
-				return `${baseMessage} because the remote contains work that you do not have locally. Try fetching first.`;
-			case 'remoteConnectionFailed':
-				return `${baseMessage} because the remote repository could not be reached.`;
-			case 'tipBehind':
-				return `${baseMessage} as it is behind its remote counterpart. Try pulling first.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type RebaseErrorReason =
-	| 'aborted'
-	| 'alreadyInProgress'
-	| 'conflicts'
-	| 'uncommittedChanges'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface RebaseErrorDetails {
-	reason?: RebaseErrorReason;
-	upstream?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class RebaseError extends GitCommandError<RebaseErrorDetails> {
-	static override is(ex: unknown): ex is RebaseError;
-	static override is<R extends RebaseErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is RebaseError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: RebaseErrorReason): boolean {
-		return ex instanceof RebaseError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: RebaseErrorDetails, original?: Error) {
-		super('Unable to rebase', details, original);
-	}
-
-	protected override buildErrorMessage(details: RebaseErrorDetails): string {
-		const baseMessage = `Unable to rebase${details.upstream ? ` onto '${details.upstream}'` : ''}`;
-
-		switch (details.reason) {
-			case 'aborted':
-				return `Rebase${details.upstream ? ` onto '${details.upstream}'` : ''} was aborted`;
-			case 'alreadyInProgress':
-				return `${baseMessage} because a rebase is already in progress`;
-			case 'conflicts':
-				return `${baseMessage} due to conflicts. Resolve the conflicts first and continue the rebase`;
-			case 'uncommittedChanges':
-				return `${baseMessage} because there are uncommitted changes`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} because some local changes would be overwritten`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type ResetErrorReason =
-	| 'ambiguousArgument'
-	| 'notUpToDate'
-	| 'detachedHead'
-	| 'permissionDenied'
-	| 'refLocked'
-	| 'unmergedChanges'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface ResetErrorDetails {
-	reason?: ResetErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class ResetError extends GitCommandError<ResetErrorDetails> {
-	static override is(ex: unknown): ex is ResetError;
-	static override is<R extends ResetErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is ResetError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: ResetErrorReason): boolean {
-		return ex instanceof ResetError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: ResetErrorDetails, original?: Error) {
-		super('Unable to reset', details, original);
-	}
-
-	protected override buildErrorMessage(details: ResetErrorDetails): string {
-		const baseMessage = 'Unable to reset';
-		switch (details.reason) {
-			case 'ambiguousArgument':
-				return `${baseMessage} because the argument is ambiguous`;
-			case 'detachedHead':
-				return `${baseMessage} because you are in a detached HEAD state`;
-			case 'notUpToDate':
-				return `${baseMessage} because the index is not up to date (you may have unresolved merge conflicts)`;
-			case 'permissionDenied':
-				return `${baseMessage} because you don't have permission to modify affected files`;
-			case 'refLocked':
-				return `${baseMessage} because the ref is locked`;
-			case 'unmergedChanges':
-				return `${baseMessage} because there are unmerged changes`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} because your local changes would be overwritten`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type RevertErrorReason =
-	| 'aborted'
-	| 'alreadyInProgress'
-	| 'conflicts'
-	| 'uncommittedChanges'
-	| 'wouldOverwriteChanges'
-	| 'other';
-interface RevertErrorDetails {
-	reason?: RevertErrorReason;
-	refs?: string[];
-	gitCommand?: GitCommandContext;
-}
-
-export class RevertError extends GitCommandError<RevertErrorDetails> {
-	static override is(ex: unknown): ex is RevertError;
-	static override is<R extends RevertErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is RevertError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: RevertErrorReason): boolean {
-		return ex instanceof RevertError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: RevertErrorDetails, original?: Error) {
-		super('Unable to revert', details, original);
-	}
-
-	protected override buildErrorMessage(details: RevertErrorDetails): string {
-		const baseMessage = `Unable to revert${details.refs?.length ? ` ${details.refs.join(', ')}` : ''}`;
-
-		switch (details.reason) {
-			case 'aborted':
-				return `Revert${details.refs?.length ? ` of ${details.refs.join(', ')}` : ''} was aborted`;
-			case 'alreadyInProgress':
-				return `${baseMessage} because a revert is already in progress`;
-			case 'conflicts':
-				return `${baseMessage} due to conflicts. Resolve the conflicts first and continue the revert`;
-			case 'uncommittedChanges':
-				return `${baseMessage} because there are uncommitted changes`;
-			case 'wouldOverwriteChanges':
-				return `${baseMessage} because some local changes would be overwritten`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type StashApplyErrorReason = 'uncommittedChanges' | 'other';
-interface StashApplyErrorDetails {
-	reason?: StashApplyErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class StashApplyError extends GitCommandError<StashApplyErrorDetails> {
-	static override is(ex: unknown): ex is StashApplyError;
-	static override is<R extends StashApplyErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is StashApplyError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: StashApplyErrorReason): boolean {
-		return ex instanceof StashApplyError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: StashApplyErrorDetails, original?: Error) {
-		super('Unable to apply stash', details, original);
-	}
-
-	protected override buildErrorMessage(details: StashApplyErrorDetails): string {
-		switch (details.reason) {
-			case 'uncommittedChanges':
-				return 'Unable to apply stash. Your working tree changes would be overwritten. Please commit or stash your changes before trying again';
-			default:
-				return 'Unable to apply stash';
-		}
-	}
-}
-
-export type StashPushErrorReason = 'conflictingStagedAndUnstagedLines' | 'nothingToSave' | 'other';
-interface StashPushErrorDetails {
-	reason?: StashPushErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class StashPushError extends GitCommandError<StashPushErrorDetails> {
-	static override is(ex: unknown): ex is StashPushError;
-	static override is<R extends StashPushErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is StashPushError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: StashPushErrorReason): boolean {
-		return ex instanceof StashPushError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: StashPushErrorDetails, original?: Error) {
-		super('Unable to stash', details, original);
-	}
-
-	protected override buildErrorMessage(details: StashPushErrorDetails): string {
-		switch (details.reason) {
-			case 'conflictingStagedAndUnstagedLines':
-				return 'Changes were stashed, but the working tree cannot be updated because at least one file has staged and unstaged changes on the same line(s)';
-			case 'nothingToSave':
-				return 'No files to stash';
-			default:
-				return 'Unable to stash';
-		}
-	}
-}
-
-export type ShowErrorReason = 'invalidObject' | 'invalidRevision' | 'notFound' | 'notInRevision' | 'other';
-interface ShowErrorDetails {
-	reason?: ShowErrorReason;
-	rev?: string;
-	path?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class ShowError extends GitCommandError<ShowErrorDetails> {
-	static override is(ex: unknown): ex is ShowError;
-	static override is<R extends ShowErrorReason>(ex: unknown, reason: R): ex is ShowError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: ShowErrorReason): boolean {
-		return ex instanceof ShowError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: ShowErrorDetails, original?: Error) {
-		super('Unable to show file', details, original);
-	}
-
-	protected override buildErrorMessage(details: ShowErrorDetails): string {
-		const baseMessage = `Unable to show${details.path ? ` '${details.path}'` : ' file'}${
-			details.rev ? ` at revision '${details.rev}'` : ''
-		}`;
-		switch (details.reason) {
-			case 'invalidObject':
-				return `${baseMessage} because the path is not a file`;
-			case 'invalidRevision':
-				return `${baseMessage} because the specified revision is invalid`;
-			case 'notFound':
-				return `${baseMessage} because the file does not exist`;
-			case 'notInRevision':
-				return `${baseMessage} because the file is not in the specified revision`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export type TagErrorReason =
-	| 'alreadyExists'
-	| 'invalidName'
-	| 'notFound'
-	| 'permissionDenied'
-	| 'remoteRejected'
-	| 'tagConflict'
-	| 'other';
-interface TagErrorDetails {
-	reason?: TagErrorReason;
-	action?: string;
-	tag?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class TagError extends GitCommandError<TagErrorDetails> {
-	static override is(ex: unknown): ex is TagError;
-	static override is<R extends TagErrorReason>(ex: unknown, reason: R): ex is TagError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: TagErrorReason): boolean {
-		return ex instanceof TagError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: TagErrorDetails, original?: Error) {
-		super('Unable to perform action on tag', details, original);
-	}
-
-	protected override buildErrorMessage(details: TagErrorDetails): string {
-		let baseMessage: string;
-		if (details.action != null) {
-			baseMessage = `Unable to ${details.action} tag ${details.tag ? `'${details.tag}'` : ''}`;
-		} else {
-			baseMessage = `Unable to perform action${details.tag ? ` with tag '${details.tag}'` : 'on tag'}`;
-		}
-
-		switch (details.reason) {
-			case 'alreadyExists':
-				return `${baseMessage} because it already exists`;
-			case 'invalidName':
-				return `${baseMessage} because the tag name is invalid`;
-			case 'notFound':
-				return `${baseMessage} because it does not exist`;
-			case 'permissionDenied':
-				return `${baseMessage} because you don't have permission to push to this remote repository.`;
-			case 'remoteRejected':
-				return `${baseMessage} because the remote repository rejected the push.`;
-			case 'tagConflict':
-				return `${baseMessage} because the remote already has a tag with that name. Use force to overwrite it.`;
-			default:
-				return baseMessage;
-		}
-	}
-}
-
-export class WorkspaceUntrustedError extends Error {
-	static is(ex: unknown): ex is WorkspaceUntrustedError {
-		return ex instanceof WorkspaceUntrustedError;
-	}
-
-	constructor() {
-		super('Unable to perform Git operations because the current workspace is untrusted');
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export type WorktreeCreateErrorReason = 'alreadyCheckedOut' | 'alreadyExists';
-interface WorktreeCreateErrorDetails {
-	reason?: WorktreeCreateErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class WorktreeCreateError extends GitCommandError<WorktreeCreateErrorDetails> {
-	static override is(ex: unknown): ex is WorktreeCreateError;
-	static override is<R extends WorktreeCreateErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is WorktreeCreateError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: WorktreeCreateErrorReason): boolean {
-		return ex instanceof WorktreeCreateError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: WorktreeCreateErrorDetails, original?: Error) {
-		super('Unable to create worktree', details, original);
-	}
-
-	protected override buildErrorMessage(details: WorktreeCreateErrorDetails): string {
-		switch (details.reason) {
-			case 'alreadyCheckedOut':
-				return 'Unable to create worktree because it is already checked out';
-			case 'alreadyExists':
-				return 'Unable to create worktree because it already exists';
-			default:
-				return 'Unable to create worktree';
-		}
-	}
-}
-
-export type WorktreeDeleteErrorReason = 'defaultWorkingTree' | 'directoryNotEmpty' | 'locked' | 'uncommittedChanges';
-interface WorktreeDeleteErrorDetails {
-	reason?: WorktreeDeleteErrorReason;
-	/** The reason the worktree was locked, when known and provided by the locker */
-	lockReason?: string;
-	gitCommand?: GitCommandContext;
-}
-
-export class WorktreeDeleteError extends GitCommandError<WorktreeDeleteErrorDetails> {
-	static override is(ex: unknown): ex is WorktreeDeleteError;
-	static override is<R extends WorktreeDeleteErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is WorktreeDeleteError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: WorktreeDeleteErrorReason): boolean {
-		return ex instanceof WorktreeDeleteError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: WorktreeDeleteErrorDetails, original?: Error) {
-		super('Unable to delete worktree', details, original);
-	}
-
-	protected override buildErrorMessage(details: WorktreeDeleteErrorDetails): string {
-		switch (details.reason) {
-			case 'defaultWorkingTree':
-				return 'Cannot delete worktree because it is the default working tree';
-			case 'directoryNotEmpty':
-				return 'Unable to delete worktree because the directory is not empty';
-			case 'locked':
-				return 'Unable to delete worktree because it is locked';
-			case 'uncommittedChanges':
-				return 'Unable to delete worktree because there are uncommitted changes';
-			default:
-				return 'Unable to delete worktree';
-		}
-	}
-}
-
-/**
- * Token info accepted by {@link AuthenticationError}.
- * Structurally compatible with both the extension's `TokenInfo` / `TokenWithInfo`
- * and the package's `GitHubTokenInfo`.
- */
-export interface AuthTokenInfo {
-	readonly providerId: string;
-	readonly microHash?: string;
-	readonly cloud: boolean;
-	readonly type: string | undefined;
-	readonly scopes?: readonly string[];
-	readonly expiresAt?: Date;
-}
-
-export const enum AuthenticationErrorReason {
-	UserDidNotConsent = 1,
-	Unauthorized = 2,
-	Forbidden = 3,
-}
-
-export class AuthenticationError extends Error {
-	readonly id: string;
-	readonly original?: Error;
-	readonly reason: AuthenticationErrorReason | undefined;
-	readonly authInfo: string;
-
-	constructor(info: AuthTokenInfo, reason?: AuthenticationErrorReason, original?: Error);
-	constructor(info: AuthTokenInfo, message?: string, original?: Error);
-	constructor(
-		info: AuthTokenInfo,
-		messageOrReason: string | AuthenticationErrorReason | undefined,
-		original?: Error,
-	) {
-		const { providerId: id, type, cloud, scopes, expiresAt } = info;
-		const tokenDetails = [
-			cloud ? 'cloud' : 'self-managed',
-			type,
-			info.microHash,
-			expiresAt && `expiresAt=${isNaN(expiresAt.getTime()) ? expiresAt.toString() : expiresAt.toISOString()}`,
-			scopes && `[${scopes.join(',')}]`,
-		]
-			.filter(v => v)
-			.join(', ');
-		const authInfo = `(token details: ${tokenDetails})`;
-		let message;
-		let reason: AuthenticationErrorReason | undefined;
-		if (messageOrReason == null) {
-			message = `Unable to get required authentication session for '${id}'`;
-		} else if (typeof messageOrReason === 'string') {
-			message = messageOrReason;
-			reason = undefined;
-		} else {
-			reason = messageOrReason;
-			switch (reason) {
-				case AuthenticationErrorReason.UserDidNotConsent:
-					message = `'${id}' authentication is required for this operation`;
-					break;
-				case AuthenticationErrorReason.Unauthorized:
-					message = `Your '${id}' credentials are either invalid or expired`;
-					break;
-				case AuthenticationErrorReason.Forbidden:
-					message = `Your '${id}' credentials do not have the required access`;
-					break;
-			}
-		}
-		super(message);
-
-		this.id = id;
-		this.original = original;
-		this.reason = reason;
-		this.authInfo = authInfo;
-		Error.captureStackTrace?.(this, new.target);
-	}
-
-	static is(ex: unknown): ex is AuthenticationError {
-		return ex instanceof AuthenticationError;
-	}
-
-	override toString(): string {
-		return `${super.toString()} ${this.authInfo}`;
-	}
-}
-
-export class RequestClientError extends Error {
-	static is(ex: unknown): ex is RequestClientError {
-		return ex instanceof RequestClientError;
-	}
-
-	constructor(public readonly original: Error) {
-		super(original.message);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export class RequestNotFoundError extends Error {
-	static is(ex: unknown): ex is RequestNotFoundError {
-		return ex instanceof RequestNotFoundError;
-	}
-
-	constructor(public readonly original: Error) {
-		super(original.message);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export class RequestRateLimitError extends Error {
-	static is(ex: unknown): ex is RequestRateLimitError {
-		return ex instanceof RequestRateLimitError;
-	}
-
-	constructor(
-		public readonly original: Error,
-		public readonly token: string | undefined,
-		public readonly resetAt: number | undefined,
-	) {
-		super(original.message);
-
-		Error.captureStackTrace?.(this, new.target);
-	}
-}
-
-export type SigningErrorReason = 'noKey' | 'gpgNotFound' | 'sshNotFound' | 'passphraseFailed' | 'unknown';
-
-interface SigningErrorDetails {
-	reason?: SigningErrorReason;
-	gitCommand?: GitCommandContext;
-}
-
-export class SigningError extends GitCommandError<SigningErrorDetails> {
-	static override is(ex: unknown): ex is SigningError;
-	static override is<R extends SigningErrorReason>(
-		ex: unknown,
-		reason: R,
-	): ex is SigningError & { details: { reason: R } };
-	static override is(ex: unknown, reason?: SigningErrorReason): boolean {
-		return ex instanceof SigningError && (reason == null || ex.details.reason === reason);
-	}
-
-	constructor(details: SigningErrorDetails, original?: Error) {
-		super('Unable to sign commit', details, original);
-	}
-
-	protected override buildErrorMessage(details: SigningErrorDetails): string {
-		const baseMessage = 'Unable to sign commit';
-		switch (details.reason) {
-			case 'noKey':
-				return `${baseMessage} because no signing key is configured`;
-			case 'gpgNotFound':
-				return `${baseMessage} because GPG program was not found`;
-			case 'sshNotFound':
-				return `${baseMessage} because SSH program was not found`;
-			case 'passphraseFailed':
-				return `${baseMessage} because GPG passphrase failed or was cancelled`;
-			default:
-				return baseMessage;
-		}
-	}
-}