@hanseltime/template-repo-sync 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.3.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.2.0...v1.3.0) (2024-06-09)
+
+
+### Features
+
+* support specifying the template branch ([54bad24](https://github.com/HanseltimeIndustries/template-repo-sync/commit/54bad24935bb8609617b8d30409aa8a47fc64139))
+
 # [1.2.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.1.0...v1.2.0) (2024-03-11)
 
 

package/lib/cjs/checkout-drivers/git-checkout.d.ts

@@ -0,0 +1,8 @@
+export declare function gitCheckout(options: {
+    /** The directory where we cloned to */
+    tmpDir: string;
+    /** The name of the remote that git checks out against */
+    remoteName: string;
+    /** The branch to checkout against */
+    branch: string;
+}): Promise<boolean>;

package/lib/cjs/checkout-drivers/git-checkout.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitCheckout = void 0;
+const child_process_1 = require("child_process");
+async function gitCheckout(options) {
+    const { branch, remoteName, tmpDir } = options;
+    (0, child_process_1.execSync)(`git fetch ${remoteName} ${branch}`, {
+        cwd: tmpDir,
+        env: process.env,
+    });
+    (0, child_process_1.execSync)(`git checkout -b ${branch} --track ${remoteName}/${branch}`, {
+        cwd: tmpDir,
+        env: process.env,
+    });
+    return true;
+}
+exports.gitCheckout = gitCheckout;

package/lib/cjs/checkout-drivers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./git-checkout";
+export * from "./types";

package/lib/cjs/checkout-drivers/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./git-checkout"), exports);
+__exportStar(require("./types"), exports);

package/lib/cjs/checkout-drivers/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A function that will checkout a given "branch" after the repo has been
+ * "cloned" by a clone drvier.
+ *
+ * @returns true if the checkout succeeded
+ */
+export type TemplateCheckoutDriverFn = (options: {
+    /** The directory where we cloned to */
+    tmpDir: string;
+    /** The name of the remote that git checks out against */
+    remoteName: string;
+    /** The branch to checkout against */
+    branch: string;
+}) => Promise<boolean>;

package/lib/cjs/checkout-drivers/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/clone-drivers/git-clone.d.ts

@@ -1 +1,2 @@
-export declare function gitClone(tmpDir: string, repoUrl: string): Promise<string>;
+import { CloneReturn } from "./types";
+export declare function gitClone(tmpDir: string, repoUrl: string): Promise<CloneReturn>;

package/lib/cjs/clone-drivers/git-clone.js

@@ -9,6 +9,9 @@ async function gitClone(tmpDir, repoUrl) {
         cwd: tmpDir,
         env: process.env,
     });
-    return (0, path_1.resolve)(tmpDir, CLONE_DIR);
+    return {
+        dir: (0, path_1.resolve)(tmpDir, CLONE_DIR),
+        remoteName: "origin",
+    };
 }
 exports.gitClone = gitClone;

package/lib/cjs/clone-drivers/types.d.ts

@@ -1,5 +1,16 @@
+/**
+ * @deprecated - return the remote name in the CloneReturn
+ */
+type CloneDir = string;
+export interface CloneReturn {
+    /** The directory where the clone occurred - absolute path to avoid working dir issues */
+    dir: string;
+    /** The name of the remote for the particular technology that you used - passed to checkout drivers */
+    remoteName: string;
+}
 /**
  * A function that clones the template repo into the provided tmpDir
  * and then returns the relative path within that directory to the template root
  */
-export type TemplateCloneDriverFn = (tmpDir: string, repoUrl: string) => Promise<string>;
+export type TemplateCloneDriverFn = (tmpDir: string, repoUrl: string) => Promise<CloneReturn | CloneDir>;
+export {};

package/lib/cjs/template-sync.d.ts

@@ -2,8 +2,17 @@ import { Change } from "diff";
 import { TemplateCloneDriverFn } from "./clone-drivers";
 import { TemplateDiffDriverFn } from "./diff-drivers";
 import { TemplateRefDriverFn } from "./ref-drivers/types";
+import { TemplateCheckoutDriverFn } from "./checkout-drivers";
 export interface TemplateSyncOptions {
+    /**
+     * This is the url of the template repo
+     */
     repoUrl: string;
+    /**
+     * Optional Branch to check out - if not specified, this checks out the
+     * default branch of the template repo
+     */
+    branch?: string;
     /**
      * The directory for cloning our template repo into via the cloneDriver
      */
@@ -29,6 +38,10 @@ export interface TemplateSyncOptions {
      * Defaults to using git current ref
      */
     currentRefDriver?: TemplateRefDriverFn;
+    /**
+     * Defaults to using git checkout driver
+     */
+    checkoutDriver?: TemplateCheckoutDriverFn;
 }
 export interface TemplateSyncReturn {
     /**

package/lib/cjs/template-sync.js

@@ -33,13 +33,28 @@ const diff_drivers_1 = require("./diff-drivers");
 const ref_drivers_1 = require("./ref-drivers");
 const formatting_1 = require("./formatting");
 const commentJSON = __importStar(require("comment-json"));
+const checkout_drivers_1 = require("./checkout-drivers");
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
     const cloneDriver = options.cloneDriver ?? git_clone_1.gitClone;
     const diffDriver = options.diffDriver ?? diff_drivers_1.gitDiff;
     const currentRefDriver = options.currentRefDriver ?? ref_drivers_1.gitCurrentRef;
-    const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+    const checkoutDriver = options.checkoutDriver ?? checkout_drivers_1.gitCheckout;
+    const cloneReturn = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+    const { dir: tempCloneDir, remoteName } = typeof cloneReturn === "string"
+        ? {
+            dir: cloneReturn,
+            remoteName: "origin", // Default to this
+        }
+        : cloneReturn;
+    if (options.branch) {
+        await checkoutDriver({
+            tmpDir: tempCloneDir,
+            remoteName,
+            branch: options.branch,
+        });
+    }
     // Get the clone Config
     const cloneConfigPath = (0, path_1.join)(tempCloneDir, `${exports.TEMPLATE_SYNC_CONFIG}.json`);
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)

package/lib/esm/checkout-drivers/git-checkout.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitCheckout = void 0;
+const child_process_1 = require("child_process");
+async function gitCheckout(options) {
+    const { branch, remoteName, tmpDir } = options;
+    (0, child_process_1.execSync)(`git fetch ${remoteName} ${branch}`, {
+        cwd: tmpDir,
+        env: process.env,
+    });
+    (0, child_process_1.execSync)(`git checkout -b ${branch} --track ${remoteName}/${branch}`, {
+        cwd: tmpDir,
+        env: process.env,
+    });
+    return true;
+}
+exports.gitCheckout = gitCheckout;

package/lib/esm/checkout-drivers/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./git-checkout"), exports);
+__exportStar(require("./types"), exports);

package/lib/esm/checkout-drivers/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/clone-drivers/git-clone.js

@@ -9,6 +9,9 @@ async function gitClone(tmpDir, repoUrl) {
         cwd: tmpDir,
         env: process.env,
     });
-    return (0, path_1.resolve)(tmpDir, CLONE_DIR);
+    return {
+        dir: (0, path_1.resolve)(tmpDir, CLONE_DIR),
+        remoteName: "origin",
+    };
 }
 exports.gitClone = gitClone;

package/lib/esm/template-sync.js

@@ -33,13 +33,28 @@ const diff_drivers_1 = require("./diff-drivers");
 const ref_drivers_1 = require("./ref-drivers");
 const formatting_1 = require("./formatting");
 const commentJSON = __importStar(require("comment-json"));
+const checkout_drivers_1 = require("./checkout-drivers");
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
     const cloneDriver = options.cloneDriver ?? git_clone_1.gitClone;
     const diffDriver = options.diffDriver ?? diff_drivers_1.gitDiff;
     const currentRefDriver = options.currentRefDriver ?? ref_drivers_1.gitCurrentRef;
-    const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+    const checkoutDriver = options.checkoutDriver ?? checkout_drivers_1.gitCheckout;
+    const cloneReturn = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+    const { dir: tempCloneDir, remoteName } = typeof cloneReturn === "string"
+        ? {
+            dir: cloneReturn,
+            remoteName: "origin", // Default to this
+        }
+        : cloneReturn;
+    if (options.branch) {
+        await checkoutDriver({
+            tmpDir: tempCloneDir,
+            remoteName,
+            branch: options.branch,
+        });
+    }
     // Get the clone Config
     const cloneConfigPath = (0, path_1.join)(tempCloneDir, `${exports.TEMPLATE_SYNC_CONFIG}.json`);
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hanseltime/template-repo-sync",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "An npm library that enables pluggable, customizable synchronization between template repos",
   "main": "lib/cjs/index.js",
   "types": "lib/cjs/index.d.ts",

package/src/checkout-drivers/git-checkout.spec.ts

@@ -0,0 +1,58 @@
+import { join, resolve } from "path";
+import { TEST_FIXTURES_DIR, tempDir } from "../test-utils";
+import { copy, mkdtemp, moveSync } from "fs-extra";
+import { execSync } from "child_process";
+import { gitCheckout } from "./git-checkout";
+import { readFileSync } from "fs";
+
+const gitRemoteDir = resolve(TEST_FIXTURES_DIR, "testGitRepo");
+
+describe("gitCheckout", () => {
+  let tmpRemoteDir: string;
+  let tmpRepoDir: string;
+  beforeEach(async () => {
+    const baseTmpDir = await mkdtemp(tempDir());
+    // Make the remote dir
+    tmpRemoteDir = join(baseTmpDir, "remote");
+    await copy(gitRemoteDir, tmpRemoteDir);
+    // rehydrate the git repo
+    moveSync(join(tmpRemoteDir, "gitDir"), join(tmpRemoteDir, ".git"));
+
+    // Perform the clone we expect
+    execSync(`git clone ${tmpRemoteDir} testGitRepo`, {
+      cwd: baseTmpDir,
+    });
+    tmpRepoDir = join(baseTmpDir, "testGitRepo");
+  });
+  it("checks out the appropriate branch", async () => {
+    await gitCheckout({
+      tmpDir: tmpRepoDir,
+      remoteName: "origin",
+      branch: "test-branch", // We set this in the gitDir
+    });
+
+    expect(readFileSync(join(tmpRepoDir, "README.md")).toString()).toContain(
+      "# This is the test-branch",
+    );
+  });
+  it("throws an error if the branch is not found", async () => {
+    await expect(
+      async () =>
+        await gitCheckout({
+          tmpDir: tmpRepoDir,
+          remoteName: "origin",
+          branch: "test-branch-not-there", // This is not set in gitDir
+        }),
+    ).rejects.toThrow();
+  });
+  it("throws an error if the origin is not found", async () => {
+    await expect(
+      async () =>
+        await gitCheckout({
+          tmpDir: tmpRepoDir,
+          remoteName: "originNA",
+          branch: "test-branch", // This is not set in gitDir
+        }),
+    ).rejects.toThrow();
+  });
+});

package/src/checkout-drivers/git-checkout.ts

@@ -0,0 +1,22 @@
+import { execSync } from "child_process";
+
+export async function gitCheckout(options: {
+  /** The directory where we cloned to */
+  tmpDir: string;
+  /** The name of the remote that git checks out against */
+  remoteName: string;
+  /** The branch to checkout against */
+  branch: string;
+}): Promise<boolean> {
+  const { branch, remoteName, tmpDir } = options;
+  execSync(`git fetch ${remoteName} ${branch}`, {
+    cwd: tmpDir,
+    env: process.env,
+  });
+  execSync(`git checkout -b ${branch} --track ${remoteName}/${branch}`, {
+    cwd: tmpDir,
+    env: process.env,
+  });
+
+  return true;
+}

package/src/checkout-drivers/index.ts

@@ -0,0 +1,2 @@
+export * from "./git-checkout";
+export * from "./types";

package/src/checkout-drivers/types.ts

@@ -0,0 +1,14 @@
+/**
+ * A function that will checkout a given "branch" after the repo has been
+ * "cloned" by a clone drvier.
+ *
+ * @returns true if the checkout succeeded
+ */
+export type TemplateCheckoutDriverFn = (options: {
+  /** The directory where we cloned to */
+  tmpDir: string;
+  /** The name of the remote that git checks out against */
+  remoteName: string;
+  /** The branch to checkout against */
+  branch: string;
+}) => Promise<boolean>;

package/src/clone-drivers/git-clone.ts

@@ -1,16 +1,20 @@
 import { execSync } from "child_process";
 import { resolve } from "path";
+import { CloneReturn } from "./types";
 
 const CLONE_DIR = "cloned_repo";
 
 export async function gitClone(
   tmpDir: string,
   repoUrl: string,
-): Promise<string> {
+): Promise<CloneReturn> {
   execSync(`git clone ${repoUrl} ${CLONE_DIR}`, {
     cwd: tmpDir,
     env: process.env,
   });
 
-  return resolve(tmpDir, CLONE_DIR);
+  return {
+    dir: resolve(tmpDir, CLONE_DIR),
+    remoteName: "origin",
+  };
 }

package/src/clone-drivers/types.ts

@@ -1,3 +1,15 @@
+/**
+ * @deprecated - return the remote name in the CloneReturn
+ */
+type CloneDir = string;
+
+export interface CloneReturn {
+  /** The directory where the clone occurred - absolute path to avoid working dir issues */
+  dir: string;
+  /** The name of the remote for the particular technology that you used - passed to checkout drivers */
+  remoteName: string;
+}
+
 /**
  * A function that clones the template repo into the provided tmpDir
  * and then returns the relative path within that directory to the template root
@@ -5,4 +17,4 @@
 export type TemplateCloneDriverFn = (
   tmpDir: string,
   repoUrl: string,
-) => Promise<string>;
+) => Promise<CloneReturn | CloneDir>;

package/src/template-sync.spec.ts

@@ -7,14 +7,20 @@ import { existsSync, readFileSync, writeFileSync } from "fs";
 
 // Just return the test-fixture directory
 const dummyCloneDriver = async () => {
-  return resolve(TEST_FIXTURES_DIR, "template");
+  return {
+    dir: resolve(TEST_FIXTURES_DIR, "template"),
+    remoteName: "ourRemote",
+  };
 };
 
+const dummyCheckoutDriver = jest.fn();
+
 const downstreamDir = resolve(TEST_FIXTURES_DIR, "downstream");
 
 describe("templateSync", () => {
   let tmpDir: string;
   beforeEach(async () => {
+    jest.resetAllMocks();
     tmpDir = await mkdtemp(tempDir());
     await copy(downstreamDir, tmpDir);
   });
@@ -32,6 +38,35 @@ describe("templateSync", () => {
         cloneDriver: dummyCloneDriver,
         repoUrl: "not-important",
         repoDir: emptyTmpDir,
+        checkoutDriver: dummyCheckoutDriver,
+      }),
+    ).toEqual({
+      // Expect no changes since there was no local sync file
+      localSkipFiles: [],
+      localFileChanges: {},
+    });
+
+    // Verify the files
+    await fileMatchTemplate(emptyTmpDir, "templatesync.json");
+    await fileMatchTemplate(emptyTmpDir, "package.json");
+    await fileMatchTemplate(emptyTmpDir, "src/templated.ts");
+
+    // Expect the ignores to not be a problem
+    expect(existsSync(resolve(emptyTmpDir, "src/index.ts"))).toBeFalsy();
+    expect(existsSync(resolve(emptyTmpDir, "src/custom-bin"))).toBeFalsy();
+
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
+  });
+  it("Checks out the branch and then appropriately merges", async () => {
+    const emptyTmpDir = await mkdtemp(tempDir());
+    expect(
+      await templateSync({
+        tmpCloneDir: "stubbed-by-driver",
+        cloneDriver: dummyCloneDriver,
+        repoUrl: "not-important",
+        repoDir: emptyTmpDir,
+        branch: "new-template-test",
+        checkoutDriver: dummyCheckoutDriver,
       }),
     ).toEqual({
       // Expect no changes since there was no local sync file
@@ -47,6 +82,12 @@ describe("templateSync", () => {
     // Expect the ignores to not be a problem
     expect(existsSync(resolve(emptyTmpDir, "src/index.ts"))).toBeFalsy();
     expect(existsSync(resolve(emptyTmpDir, "src/custom-bin"))).toBeFalsy();
+    const cloneInfo = await dummyCloneDriver();
+    expect(dummyCheckoutDriver).toHaveBeenCalledWith({
+      tmpDir: cloneInfo.dir,
+      remoteName: cloneInfo.remoteName,
+      branch: "new-template-test",
+    });
   });
   it("appropriately merges according to just the templatesync config file in an existing repo", async () => {
     // Remove the local sync overrides
@@ -57,6 +98,7 @@ describe("templateSync", () => {
       cloneDriver: dummyCloneDriver,
       repoUrl: "not-important",
       repoDir: tmpDir,
+      checkoutDriver: dummyCheckoutDriver,
     });
 
     expect(result.localSkipFiles).toEqual([]);
@@ -93,6 +135,7 @@ describe("templateSync", () => {
     // Expect the ignores to not be a problem
     await fileMatchDownstream(tmpDir, "src/index.ts");
     await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
   });
   it("appropriately merges according to the templatesync config file and the local config in an existing repo", async () => {
     // Remove the local sync overrides
@@ -127,6 +170,7 @@ describe("templateSync", () => {
       cloneDriver: dummyCloneDriver,
       repoUrl: "not-important",
       repoDir: tmpDir,
+      checkoutDriver: dummyCheckoutDriver,
     });
 
     expect(result.localSkipFiles).toEqual(["src/templated.ts"]);
@@ -152,6 +196,7 @@ describe("templateSync", () => {
     // Expect the ignores to not be a problem
     await fileMatchDownstream(tmpDir, "src/index.ts");
     await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
   });
   it("appropriately merges according to the templatesync config file and the local config in an existing repo with afterRef", async () => {
     // Remove the local sync overrides
@@ -178,6 +223,7 @@ describe("templateSync", () => {
       repoUrl: "not-important",
       repoDir: tmpDir,
       diffDriver: mockDiffDriver,
+      checkoutDriver: dummyCheckoutDriver,
     });
 
     // since there was no override for this file, not changes from the local file
@@ -191,6 +237,7 @@ describe("templateSync", () => {
     await fileMatchDownstream(tmpDir, "src/index.ts");
     await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
     await fileMatchDownstream(tmpDir, "package.json");
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
   });
   it("updates the local templatesync with the current ref if updateAfterRef is true", async () => {
     // Remove the local sync overrides
@@ -224,6 +271,7 @@ describe("templateSync", () => {
       updateAfterRef: true,
       diffDriver: mockDiffDriver,
       currentRefDriver: mockCurrentRefDriver,
+      checkoutDriver: dummyCheckoutDriver,
     });
 
     // since there was no override for this file, not changes from the local file
@@ -247,6 +295,7 @@ describe("templateSync", () => {
       ...mockLocalConfig,
       afterRef: "newestSha",
     });
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
   });
   it("creates the local templatesync with the current ref if updateAfterRef is true and no local template exists", async () => {
     // Remove the local sync overrides
@@ -267,6 +316,7 @@ describe("templateSync", () => {
       updateAfterRef: true,
       diffDriver: mockDiffDriver,
       currentRefDriver: mockCurrentRefDriver,
+      checkoutDriver: dummyCheckoutDriver,
     });
 
     // since there was no override for this file, not changes from the local file
@@ -313,6 +363,7 @@ describe("templateSync", () => {
       afterRef: "newestSha",
     });
   });
+  expect(dummyCheckoutDriver).not.toHaveBeenCalled();
 });
 
 // helper
@@ -330,7 +381,7 @@ async function fileMatch(
   source: "downstream" | "template",
 ) {
   const dir =
-    source === "downstream" ? downstreamDir : await dummyCloneDriver();
+    source === "downstream" ? downstreamDir : (await dummyCloneDriver()).dir;
   expect((await readFile(resolve(tmpDir, relPath))).toString()).toEqual(
     (await readFile(resolve(dir, relPath))).toString(),
   );

package/src/template-sync.ts

@@ -11,10 +11,20 @@ import { gitCurrentRef } from "./ref-drivers";
 import { TemplateRefDriverFn } from "./ref-drivers/types";
 import { inferJSONIndent } from "./formatting";
 import * as commentJSON from "comment-json";
+import { TemplateCheckoutDriverFn, gitCheckout } from "./checkout-drivers";
 
 export interface TemplateSyncOptions {
+  /**
+   * This is the url of the template repo
+   */
   repoUrl: string;
 
+  /**
+   * Optional Branch to check out - if not specified, this checks out the
+   * default branch of the template repo
+   */
+  branch?: string;
+
   /**
    * The directory for cloning our template repo into via the cloneDriver
    */
@@ -45,6 +55,11 @@ export interface TemplateSyncOptions {
    * Defaults to using git current ref
    */
   currentRefDriver?: TemplateRefDriverFn;
+
+  /**
+   * Defaults to using git checkout driver
+   */
+  checkoutDriver?: TemplateCheckoutDriverFn;
 }
 
 export interface TemplateSyncReturn {
@@ -72,7 +87,24 @@ export async function templateSync(
   const cloneDriver = options.cloneDriver ?? gitClone;
   const diffDriver = options.diffDriver ?? gitDiff;
   const currentRefDriver = options.currentRefDriver ?? gitCurrentRef;
-  const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+  const checkoutDriver = options.checkoutDriver ?? gitCheckout;
+  const cloneReturn = await cloneDriver(options.tmpCloneDir, options.repoUrl);
+
+  const { dir: tempCloneDir, remoteName } =
+    typeof cloneReturn === "string"
+      ? {
+          dir: cloneReturn,
+          remoteName: "origin", // Default to this
+        }
+      : cloneReturn;
+
+  if (options.branch) {
+    await checkoutDriver({
+      tmpDir: tempCloneDir,
+      remoteName,
+      branch: options.branch,
+    });
+  }
 
   // Get the clone Config
   const cloneConfigPath = join(tempCloneDir, `${TEMPLATE_SYNC_CONFIG}.json`);

package/test-fixtures/testGitRepo/README.md

@@ -0,0 +1,17 @@
+# This is the master branch
+
+How to update this?
+
+You will want to "re-initialize this folder" by createing your .git repo
+
+```shell
+mv gitDir .git
+```
+
+From here, you can CD into the folder and run git commands. Anything you do will be recorded into the .git
+
+Before you commit those git history changes, please create the gitDir again from the new .git
+
+```shell
+mv .git gitDir
+```