git-chopstick-core 0.1.0 → 0.1.2

package/dist/git/branch.js

@@ -0,0 +1,150 @@
+import { git, isGitError } from './core.js';
+import { formatAsLocalRef } from './refs.js';
+import { deleteRef } from './update-ref.js';
+import { GitError as DugiteError } from './exec.js';
+import { envForRemoteOperation } from './environment.js';
+import { createForEachRefParser } from './git-delimiter-parser.js';
+import { coerceToString } from './coerce-to-string.js';
+/**
+ * Create a new branch from the given start point.
+ *
+ * @param repository - The repository in which to create the new branch
+ * @param name       - The name of the new branch
+ * @param startPoint - A committish string that the new branch should be based
+ *                     on, or undefined if the branch should be created based
+ *                     off of the current state of HEAD
+ */
+export async function createBranch(repository, name, startPoint, noTrack) {
+    const args = startPoint !== null ? ['branch', name, startPoint] : ['branch', name];
+    // if we're branching directly from a remote branch, we don't want to track it
+    // tracking it will make the rest of desktop think we want to push to that
+    // remote branch's upstream (which would likely be the upstream of the fork)
+    if (noTrack) {
+        args.push('--no-track');
+    }
+    await git(args, repository.path, 'createBranch');
+}
+export const getBranchNames = ({ path }) => {
+    const parser = createForEachRefParser({ name: '%(refname:short)' });
+    return git(['branch', ...parser.formatArgs], path, 'getBranchNames').then(x => parser.parse(x.stdout).map(b => b.name));
+};
+/** Rename the given branch to a new name. */
+export async function renameBranch(repository, branch, newName, force) {
+    try {
+        await git(['branch', force ? '-M' : '-m', branch.nameWithoutRemote, newName], repository.path, 'renameBranch');
+    }
+    catch (error) {
+        // If we failed to rename and the branch name only differs by case, we
+        // we'll try again with the -M flag to force the rename. See
+        // https://github.com/desktop/desktop/issues/21320
+        if (
+        // Only retry if the caller hasn't explicitly asked us to force the rename
+        force === undefined &&
+            isGitError(error) &&
+            error.result.gitError === DugiteError.BranchAlreadyExists) {
+            const stderr = coerceToString(error.result.stderr);
+            const m = /fatal: a branch named '(.+?)' already exists/.exec(stderr);
+            if (m && m[1].toLowerCase() === newName.toLowerCase()) {
+                // At this point we're almost certain that we are dealing with a
+                // case-only rename on a case insensitive filesystem, but we can't
+                // be 100% sure, NTFS can be configured to be case sensitive and macOS
+                // might have case sensitive file systems mounted so we have to list
+                // all branches and check the names.
+                return (getBranchNames(repository)
+                    // Throw the original error if we fail to get the branch names
+                    .catch(() => Promise.reject(error))
+                    .then(names => 
+                // If we find the new name in the list of branches we can't
+                // safely assume it's a case-only rename and have to
+                // propagate the original error, otherwise try again with -M
+                names.includes(newName)
+                    ? Promise.reject(error)
+                    : renameBranch(repository, branch, newName, true)));
+            }
+        }
+        throw error;
+    }
+}
+/**
+ * Delete the branch locally.
+ */
+export async function deleteLocalBranch(repository, branchName) {
+    await git(['branch', '-D', branchName], repository.path, 'deleteLocalBranch');
+    return true;
+}
+/**
+ * Deletes a remote branch
+ *
+ * @param remoteName - the name of the remote to delete the branch from
+ * @param remoteBranchName - the name of the branch on the remote
+ */
+export async function deleteRemoteBranch(repository, remote, remoteBranchName) {
+    const args = ['push', remote.name, `:${remoteBranchName}`];
+    // If the user is not authenticated, the push is going to fail
+    // Let this propagate and leave it to the caller to handle
+    const result = await git(args, repository.path, 'deleteRemoteBranch', {
+        env: await envForRemoteOperation(remote.url),
+        expectedErrors: new Set([DugiteError.BranchDeletionFailed]),
+    });
+    // It's possible that the delete failed because the ref has already
+    // been deleted on the remote. If we identify that specific
+    // error we can safely remove our remote ref which is what would
+    // happen if the push didn't fail.
+    if (result.gitError === DugiteError.BranchDeletionFailed) {
+        const ref = `refs/remotes/${remote.name}/${remoteBranchName}`;
+        await deleteRef(repository, ref);
+    }
+    return true;
+}
+/**
+ * Finds branches that have a tip equal to the given committish
+ *
+ * @param repository within which to execute the command
+ * @param commitish a sha, HEAD, etc that the branch(es) tip should be
+ * @returns list branch names. null if an error is encountered
+ */
+export async function getBranchesPointedAt(repository, commitish) {
+    const args = [
+        'branch',
+        `--points-at=${commitish}`,
+        '--format=%(refname:short)',
+    ];
+    // this command has an implicit \n delimiter
+    const { stdout, exitCode } = await git(args, repository.path, 'branchPointedAt', {
+        // - 1 is returned if a common ancestor cannot be resolved
+        // - 129 is returned if ref is malformed
+        //   "warning: ignoring broken ref refs/remotes/origin/main."
+        successExitCodes: new Set([0, 1, 129]),
+    });
+    if (exitCode === 1 || exitCode === 129) {
+        return null;
+    }
+    // split (and remove trailing element cause its always an empty string)
+    return stdout.split('\n').slice(0, -1);
+}
+/**
+ * Gets all branches that have been merged into the given branch
+ *
+ * @param repository The repository in which to search
+ * @param branchName The to be used as the base branch
+ * @returns map of branch canonical refs paired to its sha
+ */
+export async function getMergedBranches(repository, branchName) {
+    const canonicalBranchRef = formatAsLocalRef(branchName);
+    const { formatArgs, parse } = createForEachRefParser({
+        sha: '%(objectname)',
+        canonicalRef: '%(refname)',
+    });
+    const args = ['branch', ...formatArgs, '--merged', branchName];
+    const mergedBranches = new Map();
+    const { stdout } = await git(args, repository.path, 'mergedBranches');
+    for (const branch of parse(stdout)) {
+        // Don't include the branch we're using to compare against
+        // in the list of branches merged into that branch.
+        if (branch.canonicalRef !== canonicalBranchRef) {
+            mergedBranches.set(branch.canonicalRef, branch.sha);
+        }
+    }
+    return mergedBranches;
+}
+//# sourceMappingURL=branch.js.map

package/dist/git/branch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"branch.js","sourceRoot":"","sources":["../../src/git/branch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAG3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,QAAQ,IAAI,WAAW,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAElE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,UAAsB,EACtB,IAAY,EACZ,UAAyB,EACzB,OAAiB;IAEjB,MAAM,IAAI,GACR,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAEvE,8EAA8E;IAC9E,0EAA0E;IAC1E,4EAA4E;IAC5E,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACzB,CAAC;IAED,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAE,IAAI,EAAc,EAAqB,EAAE;IACxE,MAAM,MAAM,GAAG,sBAAsB,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAA;IACnE,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAC5E,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACxC,CAAA;AACH,CAAC,CAAA;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,UAAsB,EACtB,MAAc,EACd,OAAe,EACf,KAAe;IAEf,IAAI,CAAC;QACH,MAAM,GAAG,CACP,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAClE,UAAU,CAAC,IAAI,EACf,cAAc,CACf,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,sEAAsE;QACtE,4DAA4D;QAC5D,kDAAkD;QAClD;QACE,0EAA0E;QAC1E,KAAK,KAAK,SAAS;YACnB,UAAU,CAAC,KAAK,CAAC;YACjB,KAAK,CAAC,MAAM,CAAC,QAAQ,KAAK,WAAW,CAAC,mBAAmB,EACzD,CAAC;YACD,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAClD,MAAM,CAAC,GAAG,8CAA8C,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAErE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;gBACtD,gEAAgE;gBAChE,kEAAkE;gBAClE,sEAAsE;gBACtE,oEAAoE;gBACpE,oCAAoC;gBACpC,OAAO,CACL,cAAc,CAAC,UAAU,CAAC;oBACxB,8DAA8D;qBAC7D,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;qBAClC,IAAI,CAAC,KAAK,CAAC,EAAE;gBACZ,2DAA2D;gBAC3D,oDAAoD;gBACpD,4DAA4D;gBAC5D,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACrB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;oBACvB,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CACpD,CACJ,CAAA;YACH,CAAC;QACH,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAsB,EACtB,UAAkB;IAElB,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAA;IAC7E,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,UAAsB,EACtB,MAAe,EACf,gBAAwB;IAExB,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,gBAAgB,EAAE,CAAC,CAAA;IAE1D,8DAA8D;IAC9D,0DAA0D;IAC1D,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE;QACpE,GAAG,EAAE,MAAM,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC;QAC5C,cAAc,EAAE,IAAI,GAAG,CAAc,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;KACzE,CAAC,CAAA;IAEF,mEAAmE;IACnE,2DAA2D;IAC3D,gEAAgE;IAChE,kCAAkC;IAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,CAAC,oBAAoB,EAAE,CAAC;QACzD,MAAM,GAAG,GAAG,gBAAgB,MAAM,CAAC,IAAI,IAAI,gBAAgB,EAAE,CAAA;QAC7D,MAAM,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,UAAsB,EACtB,SAAiB;IAEjB,MAAM,IAAI,GAAG;QACX,QAAQ;QACR,eAAe,SAAS,EAAE;QAC1B,2BAA2B;KAC5B,CAAA;IACD,4CAA4C;IAC5C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,CACpC,IAAI,EACJ,UAAU,CAAC,IAAI,EACf,iBAAiB,EACjB;QACE,0DAA0D;QAC1D,wCAAwC;QACxC,6DAA6D;QAC7D,gBAAgB,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;KACvC,CACF,CAAA;IACD,IAAI,QAAQ,KAAK,CAAC,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,uEAAuE;IACvE,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAsB,EACtB,UAAkB;IAElB,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAA;IACvD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,sBAAsB,CAAC;QACnD,GAAG,EAAE,eAAe;QACpB,YAAY,EAAE,YAAY;KAC3B,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAA;IAC9D,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAA;IAChD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAA;IAErE,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,0DAA0D;QAC1D,mDAAmD;QACnD,IAAI,MAAM,CAAC,YAAY,KAAK,kBAAkB,EAAE,CAAC;YAC/C,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAED,OAAO,cAAc,CAAA;AACvB,CAAC"}

package/dist/git/checkout-index.d.ts

@@ -0,0 +1,19 @@
+import { Repository } from '../models/repository.js';
+/**
+ * Forcefully updates the working directory with information from the index
+ * for a given set of files.
+ *
+ * This method is essentially the same as running `git checkout -- files`
+ * except by using `checkout-index` we can pass the files we want updated
+ * on stdin, avoiding all issues with too long arguments.
+ *
+ * Note that this function will not yield errors for paths that don't
+ * exist in the index (-q).
+ *
+ * @param repository The repository in which to update the working directory
+ *                   with information from the index
+ *
+ * @param paths      The relative paths in the working directory to update
+ *                   with information from the index.
+ */
+export declare function checkoutIndex(repository: Repository, paths: ReadonlyArray<string>): Promise<void>;

package/dist/git/checkout-index.js

@@ -0,0 +1,29 @@
+import { git } from './core.js';
+/**
+ * Forcefully updates the working directory with information from the index
+ * for a given set of files.
+ *
+ * This method is essentially the same as running `git checkout -- files`
+ * except by using `checkout-index` we can pass the files we want updated
+ * on stdin, avoiding all issues with too long arguments.
+ *
+ * Note that this function will not yield errors for paths that don't
+ * exist in the index (-q).
+ *
+ * @param repository The repository in which to update the working directory
+ *                   with information from the index
+ *
+ * @param paths      The relative paths in the working directory to update
+ *                   with information from the index.
+ */
+export async function checkoutIndex(repository, paths) {
+    if (!paths.length) {
+        return;
+    }
+    const options = {
+        successExitCodes: new Set([0, 1]),
+        stdin: paths.join('\0'),
+    };
+    await git(['checkout-index', '-f', '-u', '-q', '--stdin', '-z'], repository.path, 'checkoutIndex', options);
+}
+//# sourceMappingURL=checkout-index.js.map

package/dist/git/checkout-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-index.js","sourceRoot":"","sources":["../../src/git/checkout-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAG/B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,UAAsB,EACtB,KAA4B;IAE5B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG;QACd,gBAAgB,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;KACxB,CAAA;IAED,MAAM,GAAG,CACP,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EACrD,UAAU,CAAC,IAAI,EACf,eAAe,EACf,OAAO,CACR,CAAA;AACH,CAAC"}

package/dist/git/checkout.d.ts

@@ -0,0 +1,46 @@
+import { Repository } from '../models/repository.js';
+import { Branch } from '../models/branch.js';
+import { ICheckoutProgress } from '../models/progress.js';
+import { WorkingDirectoryFileChange } from '../models/status.js';
+import { ManualConflictResolution } from '../models/manual-conflict-resolution.js';
+import { CommitOneLine } from '../models/commit.js';
+import { IRemote } from '../models/remote.js';
+export type ProgressCallback = (progress: ICheckoutProgress) => void;
+/**
+ * Check out the given branch.
+ *
+ * @param repository - The repository in which the branch checkout should
+ *                     take place
+ *
+ * @param branch     - The branch name that should be checked out
+ *
+ * @param progressCallback - An optional function which will be invoked
+ *                           with information about the current progress
+ *                           of the checkout operation. When provided this
+ *                           enables the '--progress' command line flag for
+ *                           'git checkout'.
+ */
+export declare function checkoutBranch(repository: Repository, branch: Branch, currentRemote: IRemote | null, progressCallback?: ProgressCallback, allowFileProtocol?: boolean): Promise<true>;
+/**
+ * Check out the given commit.
+ * Literally invokes `git checkout <commit SHA>`.
+ *
+ * @param repository - The repository in which the branch checkout should
+ *                     take place
+ *
+ * @param commit     - The commit that should be checked out
+ *
+ * @param progressCallback - An optional function which will be invoked
+ *                           with information about the current progress
+ *                           of the checkout operation. When provided this
+ *                           enables the '--progress' command line flag for
+ *                           'git checkout'.
+ */
+export declare function checkoutCommit(repository: Repository, commit: CommitOneLine, currentRemote: IRemote | null, progressCallback?: ProgressCallback, allowFileProtocol?: boolean): Promise<true>;
+/** Check out the paths at HEAD. */
+export declare function checkoutPaths(repository: Repository, paths: ReadonlyArray<string>): Promise<void>;
+/**
+ * Check out either stage #2 (ours) or #3 (theirs) for a conflicted
+ * file.
+ */
+export declare function checkoutConflictedFile(repository: Repository, file: WorkingDirectoryFileChange, resolution: ManualConflictResolution): Promise<void>;

package/dist/git/checkout.js

@@ -0,0 +1,126 @@
+import { git } from './core.js';
+import { BranchType } from '../models/branch.js';
+import { clampProgress } from '../models/progress.js';
+import { CheckoutProgressParser, executionOptionsWithProgress, } from '../lib/progress/index.js';
+import { AuthenticationErrors } from './authentication.js';
+import { envForRemoteOperation, getFallbackUrlForProxyResolve, } from './environment.js';
+import { shortenSHA } from '../models/commit.js';
+import { updateSubmodulesAfterOperation } from './submodule.js';
+const CheckoutStepWeight = 0.9;
+function getCheckoutArgs(progressCallback) {
+    return ['checkout', ...(progressCallback ? ['--progress'] : [])];
+}
+async function getBranchCheckoutArgs(branch) {
+    return [
+        branch.name,
+        ...(branch.type === BranchType.Remote
+            ? ['-b', branch.nameWithoutRemote]
+            : []),
+        '--',
+    ];
+}
+async function getCheckoutOpts(repository, title, target, currentRemote, progressCallback, initialDescription) {
+    const opts = {
+        env: await envForRemoteOperation(getFallbackUrlForProxyResolve(repository, currentRemote)),
+        expectedErrors: AuthenticationErrors,
+    };
+    if (!progressCallback) {
+        return opts;
+    }
+    const kind = 'checkout';
+    // Initial progress
+    progressCallback({
+        kind,
+        title,
+        description: initialDescription ?? title,
+        value: 0,
+        target,
+    });
+    return await executionOptionsWithProgress({ ...opts, trackLFSProgress: true }, new CheckoutProgressParser(), progress => {
+        if (progress.kind === 'progress') {
+            const description = progress.details.text;
+            const value = progress.percent;
+            progressCallback({
+                kind,
+                title,
+                description,
+                value,
+                target,
+            });
+        }
+    });
+}
+/**
+ * Check out the given branch.
+ *
+ * @param repository - The repository in which the branch checkout should
+ *                     take place
+ *
+ * @param branch     - The branch name that should be checked out
+ *
+ * @param progressCallback - An optional function which will be invoked
+ *                           with information about the current progress
+ *                           of the checkout operation. When provided this
+ *                           enables the '--progress' command line flag for
+ *                           'git checkout'.
+ */
+export async function checkoutBranch(repository, branch, currentRemote, progressCallback, allowFileProtocol = false) {
+    const title = `Checking out branch ${branch.name}`;
+    const opts = await getCheckoutOpts(repository, title, branch.name, currentRemote, progressCallback
+        ? clampProgress(0, CheckoutStepWeight, progressCallback)
+        : undefined, `Switching to branch`);
+    const baseArgs = getCheckoutArgs(progressCallback);
+    const args = [...baseArgs, ...(await getBranchCheckoutArgs(branch))];
+    await git(args, repository.path, 'checkoutBranch', opts);
+    // Update submodules after checkout
+    await updateSubmodulesAfterOperation(repository, currentRemote, progressCallback
+        ? clampProgress(CheckoutStepWeight, 1, progressCallback)
+        : undefined, 'checkout', title, branch.name, allowFileProtocol);
+    // we return `true` here so `GitStore.performFailableGitOperation`
+    // will return _something_ differentiable from `undefined` if this succeeds
+    return true;
+}
+/**
+ * Check out the given commit.
+ * Literally invokes `git checkout <commit SHA>`.
+ *
+ * @param repository - The repository in which the branch checkout should
+ *                     take place
+ *
+ * @param commit     - The commit that should be checked out
+ *
+ * @param progressCallback - An optional function which will be invoked
+ *                           with information about the current progress
+ *                           of the checkout operation. When provided this
+ *                           enables the '--progress' command line flag for
+ *                           'git checkout'.
+ */
+export async function checkoutCommit(repository, commit, currentRemote, progressCallback, allowFileProtocol = false) {
+    const title = `Checking out commit`;
+    const target = shortenSHA(commit.sha);
+    const opts = await getCheckoutOpts(repository, title, target, currentRemote, progressCallback
+        ? clampProgress(0, CheckoutStepWeight, progressCallback)
+        : undefined);
+    const baseArgs = getCheckoutArgs(progressCallback);
+    const args = [...baseArgs, commit.sha];
+    await git(args, repository.path, 'checkoutCommit', opts);
+    // Update submodules after checkout
+    await updateSubmodulesAfterOperation(repository, currentRemote, progressCallback
+        ? clampProgress(CheckoutStepWeight, 1, progressCallback)
+        : undefined, 'checkout', title, target, allowFileProtocol);
+    // we return `true` here so `GitStore.performFailableGitOperation`
+    // will return _something_ differentiable from `undefined` if this succeeds
+    return true;
+}
+/** Check out the paths at HEAD. */
+export async function checkoutPaths(repository, paths) {
+    await git(['checkout', 'HEAD', '--', ...paths], repository.path, 'checkoutPaths');
+}
+/**
+ * Check out either stage #2 (ours) or #3 (theirs) for a conflicted
+ * file.
+ */
+export async function checkoutConflictedFile(repository, file, resolution) {
+    await git(['checkout', `--${resolution}`, '--', file.path], repository.path, 'checkoutConflictedFile');
+}
+//# sourceMappingURL=checkout.js.map

package/dist/git/checkout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout.js","sourceRoot":"","sources":["../../src/git/checkout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAA8B,MAAM,WAAW,CAAA;AAE3D,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAqB,MAAM,uBAAuB,CAAA;AACxE,OAAO,EACL,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EACL,qBAAqB,EACrB,6BAA6B,GAC9B,MAAM,kBAAkB,CAAA;AAGzB,OAAO,EAAiB,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAE/D,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAA;AAI/D,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAE9B,SAAS,eAAe,CAAC,gBAAmC;IAC1D,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAClE,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,MAAc;IACjD,OAAO;QACL,MAAM,CAAC,IAAI;QACX,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM;YACnC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,iBAAiB,CAAC;YAClC,CAAC,CAAC,EAAE,CAAC;QACP,IAAI;KACL,CAAA;AACH,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,UAAsB,EACtB,KAAa,EACb,MAAc,EACd,aAA6B,EAC7B,gBAAmC,EACnC,kBAA2B;IAE3B,MAAM,IAAI,GAA+B;QACvC,GAAG,EAAE,MAAM,qBAAqB,CAC9B,6BAA6B,CAAC,UAAU,EAAE,aAAa,CAAC,CACzD;QACD,cAAc,EAAE,oBAAoB;KACrC,CAAA;IAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,IAAI,GAAG,UAAU,CAAA;IAEvB,mBAAmB;IACnB,gBAAgB,CAAC;QACf,IAAI;QACJ,KAAK;QACL,WAAW,EAAE,kBAAkB,IAAI,KAAK;QACxC,KAAK,EAAE,CAAC;QACR,MAAM;KACP,CAAC,CAAA;IAEF,OAAO,MAAM,4BAA4B,CACvC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,EACnC,IAAI,sBAAsB,EAAE,EAC5B,QAAQ,CAAC,EAAE;QACT,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAA;YACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAA;YAE9B,gBAAgB,CAAC;gBACf,IAAI;gBACJ,KAAK;gBACL,WAAW;gBACX,KAAK;gBACL,MAAM;aACP,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CACF,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,UAAsB,EACtB,MAAc,EACd,aAA6B,EAC7B,gBAAmC,EACnC,oBAA6B,KAAK;IAElC,MAAM,KAAK,GAAG,uBAAuB,MAAM,CAAC,IAAI,EAAE,CAAA;IAClD,MAAM,IAAI,GAAG,MAAM,eAAe,CAChC,UAAU,EACV,KAAK,EACL,MAAM,CAAC,IAAI,EACX,aAAa,EACb,gBAAgB;QACd,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,kBAAkB,EAAE,gBAAgB,CAAC;QACxD,CAAC,CAAC,SAAS,EACb,qBAAqB,CACtB,CAAA;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAA;IAClD,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,CAAC,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAEpE,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAA;IAExD,mCAAmC;IACnC,MAAM,8BAA8B,CAClC,UAAU,EACV,aAAa,EACb,gBAAgB;QACd,CAAC,CAAC,aAAa,CACX,kBAAkB,EAClB,CAAC,EACD,gBAAgB,CACjB;QACH,CAAC,CAAC,SAAS,EACb,UAAU,EACV,KAAK,EACL,MAAM,CAAC,IAAI,EACX,iBAAiB,CAClB,CAAA;IAED,kEAAkE;IAClE,2EAA2E;IAC3E,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,UAAsB,EACtB,MAAqB,EACrB,aAA6B,EAC7B,gBAAmC,EACnC,oBAA6B,KAAK;IAElC,MAAM,KAAK,GAAG,qBAAqB,CAAA;IACnC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACrC,MAAM,IAAI,GAAG,MAAM,eAAe,CAChC,UAAU,EACV,KAAK,EACL,MAAM,EACN,aAAa,EACb,gBAAgB;QACd,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,kBAAkB,EAAE,gBAAgB,CAAC;QACxD,CAAC,CAAC,SAAS,CACd,CAAA;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAA;IAClD,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAA;IAEtC,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAA;IAExD,mCAAmC;IACnC,MAAM,8BAA8B,CAClC,UAAU,EACV,aAAa,EACb,gBAAgB;QACd,CAAC,CAAC,aAAa,CACX,kBAAkB,EAClB,CAAC,EACD,gBAAgB,CACjB;QACH,CAAC,CAAC,SAAS,EACb,UAAU,EACV,KAAK,EACL,MAAM,EACN,iBAAiB,CAClB,CAAA;IAED,kEAAkE;IAClE,2EAA2E;IAC3E,OAAO,IAAI,CAAA;AACb,CAAC;AAED,mCAAmC;AACnC,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,UAAsB,EACtB,KAA4B;IAE5B,MAAM,GAAG,CACP,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,EACpC,UAAU,CAAC,IAAI,EACf,eAAe,CAChB,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAsB,EACtB,IAAgC,EAChC,UAAoC;IAEpC,MAAM,GAAG,CACP,CAAC,UAAU,EAAE,KAAK,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAChD,UAAU,CAAC,IAAI,EACf,wBAAwB,CACzB,CAAA;AACH,CAAC"}

package/dist/git/cherry-pick.d.ts

@@ -0,0 +1,82 @@
+import { Repository } from '../models/repository.js';
+import { WorkingDirectoryFileChange } from '../models/status.js';
+import { CommitOneLine } from '../models/commit.js';
+import { ICherryPickSnapshot } from '../models/cherry-pick.js';
+import { ManualConflictResolution } from '../models/manual-conflict-resolution.js';
+import { IMultiCommitOperationProgress } from '../models/progress.js';
+/** The app-specific results from attempting to cherry pick commits*/
+export declare enum CherryPickResult {
+    /**
+     * Git completed the cherry pick without reporting any errors, and the caller can
+     * signal success to the user.
+     */
+    CompletedWithoutError = "CompletedWithoutError",
+    /**
+     * The cherry pick encountered conflicts while attempting to cherry pick and
+     * need to be resolved before the user can continue.
+     */
+    ConflictsEncountered = "ConflictsEncountered",
+    /**
+     * The cherry pick was not able to continue as tracked files were not staged in
+     * the index.
+     */
+    OutstandingFilesNotStaged = "OutstandingFilesNotStaged",
+    /**
+     * The cherry pick was not attempted:
+     * - it could not check the status of the repository.
+     * - there was an invalid revision range provided.
+     * - there were uncommitted changes present.
+     * - there were errors in checkout the target branch
+     */
+    UnableToStart = "UnableToStart",
+    /**
+     * An unexpected error as part of the cherry pick flow was caught and handled.
+     *
+     * Check the logs to find the relevant Git details.
+     */
+    Error = "Error"
+}
+/**
+ * A function to initiate cherry picking in the app.
+ *
+ * @param commits - array of commits to cherry-pick
+ * For a cherry-pick operation, it does not matter what order the commits
+ * appear. But, it is best practice to send them in ascending order to prevent
+ * conflicts. First one on the array is first to be cherry-picked.
+ */
+export declare function cherryPick(repository: Repository, commits: ReadonlyArray<CommitOneLine>, progressCallback?: (progress: IMultiCommitOperationProgress) => void): Promise<CherryPickResult>;
+/**
+ * Inspect the `.git/sequencer` folder and convert the current cherry pick
+ * state into am `ICherryPickProgress` instance as well as return an array of
+ * remaining commits queued for cherry picking.
+ *  - Progress instance required to display progress to user.
+ *  - Commits required to track progress after a conflict has been resolved.
+ *
+ * This is required when Desktop is not responsible for initiating the cherry
+ * pick and when continuing a cherry pick after conflicts are resolved:
+ *
+ * It returns null if it cannot parse an ongoing cherry pick. This happens when,
+ *  - There isn't a cherry pick in progress (expected null outcome).
+ *  - Runs into errors parsing cherry pick files. This is expected if cherry
+ *    pick is aborted or finished during parsing. It could also occur if cherry
+ *    pick sequencer files are corrupted.
+ */
+export declare function getCherryPickSnapshot(repository: Repository): Promise<ICherryPickSnapshot | null>;
+/**
+ * Proceed with the current cherry pick operation and report back on whether it completed
+ *
+ * It is expected that the index has staged files which are cleanly cherry
+ * picked onto the base branch, and the remaining unstaged files are those which
+ * need manual resolution or were changed by the user to address inline
+ * conflicts.
+ *
+ * @param files - The working directory of files. These are the files that are
+ * detected to have changes that we want to stage for the cherry pick.
+ */
+export declare function continueCherryPick(repository: Repository, files: ReadonlyArray<WorkingDirectoryFileChange>, manualResolutions?: ReadonlyMap<string, ManualConflictResolution>, progressCallback?: (progress: IMultiCommitOperationProgress) => void): Promise<CherryPickResult>;
+/** Abandon the current cherry pick operation */
+export declare function abortCherryPick(repository: Repository): Promise<void>;
+/**
+ * Check if the `.git/CHERRY_PICK_HEAD` file exists
+ */
+export declare function isCherryPickHeadFound(repository: Repository): Promise<boolean>;