@hanseltime/template-repo-sync 2.2.1 → 2.4.0-alpha.0

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

@@ -1,17 +0,0 @@
-"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-current-ref"), exports);

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

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

package/lib/esm/template-sync.js

@@ -1,163 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.templateSync = exports.TEMPLATE_SYNC_LOCAL_CONFIG = exports.TEMPLATE_SYNC_CONFIG = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
-const match_1 = require("./match");
-const merge_file_1 = require("./merge-file");
-const git_clone_1 = require("./clone-drivers/git-clone");
-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");
-const micromatch_1 = require("micromatch");
-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 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)
-        ? commentJSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
-        : { ignore: [] };
-    const localConfigFile = `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`;
-    const localConfigPath = (0, path_1.join)(options.repoDir, localConfigFile);
-    const localTemplateSyncConfig = (0, fs_1.existsSync)(localConfigPath)
-        ? commentJSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
-        : { ignore: [] };
-    let filesToSync;
-    const ref = await currentRefDriver({
-        rootDir: tempCloneDir,
-    });
-    if (localTemplateSyncConfig.afterRef) {
-        if (ref === localTemplateSyncConfig.afterRef) {
-            // short circuit if the refs match
-            return {
-                localSkipFiles: [],
-                localFileChanges: {},
-                modifiedFiles: {
-                    added: [],
-                    modified: [],
-                    deleted: [],
-                    total: 0,
-                },
-            };
-        }
-        filesToSync = await diffDriver(tempCloneDir, localTemplateSyncConfig.afterRef);
-    }
-    else {
-        filesToSync = {
-            added: (0, match_1.getAllFilesInDir)(tempCloneDir, [
-                ...templateSyncConfig.ignore,
-                ".git/**",
-            ]),
-            deleted: [],
-            modified: [],
-        };
-    }
-    // Apply ignore filters
-    filesToSync.added = filesToSync.added.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
-    filesToSync.modified = filesToSync.modified.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
-    filesToSync.deleted = filesToSync.deleted.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
-    const localSkipFiles = new Set();
-    const localFileChanges = {};
-    const fileSyncFactory = (op) => {
-        return async (f) => {
-            const result = await (0, merge_file_1.mergeFile)(f, {
-                localTemplateSyncConfig,
-                templateSyncConfig,
-                tempCloneDir,
-                cwd: options.repoDir,
-                fileOperation: op,
-            });
-            if (result.ignoredDueToLocal) {
-                localSkipFiles.add(f);
-            }
-            else if (result?.localChanges && result.localChanges.length > 0) {
-                localFileChanges[f] = result.localChanges;
-            }
-        };
-    };
-    // Added and modified have the same setup for now
-    await Promise.all(filesToSync.added.map(fileSyncFactory("added")));
-    await Promise.all(filesToSync.modified.map(fileSyncFactory("modified")));
-    await Promise.all(filesToSync.deleted.map(fileSyncFactory("deleted")));
-    // Report the files that changed in general
-    const actualAdded = filesToSync.added.filter((f) => !localSkipFiles.has(f));
-    const actualModified = filesToSync.modified.filter((f) => !localSkipFiles.has(f));
-    const actualDeleted = filesToSync.deleted.filter((f) => !localSkipFiles.has(f));
-    const modifiedFiles = {
-        added: actualAdded,
-        modified: actualModified,
-        deleted: actualDeleted,
-    };
-    // apply after ref
-    if (options.updateAfterRef) {
-        const ref = await currentRefDriver({
-            rootDir: tempCloneDir,
-        });
-        if ((0, fs_1.existsSync)(localConfigPath)) {
-            const configStr = (0, fs_1.readFileSync)(localConfigPath).toString();
-            const config = commentJSON.parse(configStr);
-            config.afterRef = ref;
-            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
-            modifiedFiles.modified.push(localConfigFile);
-        }
-        else {
-            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify({ afterRef: ref }, null, 4));
-            modifiedFiles.added.push(localConfigFile);
-        }
-    }
-    return {
-        localSkipFiles: Array.from(localSkipFiles),
-        localFileChanges,
-        modifiedFiles: {
-            ...modifiedFiles,
-            total: modifiedFiles.added.length +
-                modifiedFiles.deleted.length +
-                modifiedFiles.modified.length,
-        },
-    };
-}
-exports.templateSync = templateSync;

package/lib/esm/test-utils/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tempDir = exports.TEST_FIXTURES_DIR = void 0;
-const path_1 = require("path");
-const os_1 = require("os");
-exports.TEST_FIXTURES_DIR = (0, path_1.resolve)(__dirname, "..", "..", "test-fixtures");
-function tempDir() {
-    return process.env.RUNNER_TEMP ?? (0, os_1.tmpdir)();
-}
-exports.tempDir = tempDir;

package/lib/esm/types.js

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

package/release.config.js

@@ -1,40 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const { readFileSync } = require("fs");
-const { join } = require("path");
-
-const packageJson = JSON.parse(
-  readFileSync(join(__dirname, "package.json")).toString(),
-);
-
-// Abbreviate for Git Commit readability
-const fullName = packageJson.name;
-const scopeLimiterIdx = fullName.lastIndexOf("/");
-const abbreviatedName = fullName.substring(
-  scopeLimiterIdx >= 0 ? scopeLimiterIdx + 1 : 0,
-);
-
-module.exports = {
-  branches: ["main", { name: "alpha", prerelease: true }],
-  plugins: [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    [
-      "@semantic-release/npm",
-      {
-        npmPublish: false, // We just use this to increment the versions since semantic-release doesn't handle OIDC well
-        // Call the publish comand in the CI/CD
-      },
-    ],
-    [
-      "@semantic-release/git",
-      {
-        assets: ["CHANGELOG.md", "package.json"],
-        message: `docs(release): ${abbreviatedName} $\{nextRelease.version} [skip ci]\n\n$\{nextRelease.notes}`,
-      },
-    ],
-    // This creates a release on github - you can decide if you want to mirror the files in package.json
-    "@semantic-release/github",
-  ],
-  ci: true,
-};

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

@@ -1,69 +0,0 @@
-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();
-  });
-  it("does not throw if the branch was the default", async () => {
-    await gitCheckout({
-      tmpDir: tmpRepoDir,
-      remoteName: "origin",
-      branch: "master", // We set this in the gitDir
-    });
-
-    expect(readFileSync(join(tmpRepoDir, "README.md")).toString()).toContain(
-      "# This is the master branch",
-    );
-  });
-});

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

@@ -1,38 +0,0 @@
-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;
-
-  const remoteInfo = execSync(`git remote show ${remoteName}`, {
-    cwd: tmpDir,
-    env: process.env,
-  }).toString();
-  const defaultMatch = /HEAD branch:\s*([a-zA-Z0-9_-]+)/.exec(remoteInfo);
-  if (!defaultMatch || !defaultMatch[1]) {
-    throw new Error(
-      `Could not determine default branch of cloned repo.\nAttempted to find in remote info:\n${remoteInfo} `,
-    );
-  }
-
-  const defaultBranch = defaultMatch[1];
-  // Skip this if the default branch is already pulled
-  if (defaultBranch !== branch) {
-    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

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

package/src/checkout-drivers/types.ts

@@ -1,14 +0,0 @@
-/**
- * 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,20 +0,0 @@
-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<CloneReturn> {
-  execSync(`git clone ${repoUrl} ${CLONE_DIR}`, {
-    cwd: tmpDir,
-    env: process.env,
-  });
-
-  return {
-    dir: resolve(tmpDir, CLONE_DIR),
-    remoteName: "origin",
-  };
-}

package/src/clone-drivers/index.ts

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

package/src/clone-drivers/types.ts

@@ -1,20 +0,0 @@
-/**
- * @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<CloneReturn | CloneDir>;

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

@@ -1,73 +0,0 @@
-import { execSync } from "child_process";
-import * as fs from "fs";
-import * as path from "path";
-import { gitDiff } from "./git-diff";
-
-describe("gitDiff", () => {
-  let tempDir: string;
-
-  beforeEach(() => {
-    tempDir = fs.mkdtempSync("gitdiff-test");
-    // Initialize a git repo
-    execSync("git init", { cwd: tempDir });
-    fs.writeFileSync(path.join(tempDir, "file1.txt"), "hello");
-    fs.writeFileSync(path.join(tempDir, "second.txt"), "second");
-    fs.writeFileSync(path.join(tempDir, "third.txt"), "third");
-    execSync("git add . && git commit -m 'initial'", { cwd: tempDir });
-  });
-
-  afterEach(() => {
-    fs.rmSync(tempDir, { recursive: true, force: true });
-  });
-
-  it("handles a rename as a delete and an add", async () => {
-    const firstCommit = execSync("git rev-parse HEAD", { cwd: tempDir })
-      .toString()
-      .trim();
-
-    // Perform a rename
-    execSync("git mv file1.txt file2.txt", { cwd: tempDir });
-    execSync("git commit -m 'rename'", { cwd: tempDir });
-
-    const result = await gitDiff(tempDir, firstCommit);
-
-    // Because of --no-renames:
-    expect(result).toEqual({
-      deleted: ["file1.txt"],
-      added: ["file2.txt"],
-      modified: [],
-    });
-  });
-  it("handles a added, deleted, and modified appropriately across multiple commits", async () => {
-    const firstCommit = execSync("git rev-parse HEAD", { cwd: tempDir })
-      .toString()
-      .trim();
-
-    // Perform a rename
-    execSync("git mv file1.txt file2.txt", { cwd: tempDir });
-    execSync("git commit -m 'rename'", { cwd: tempDir });
-
-    // Perform adds
-    fs.writeFileSync(path.join(tempDir, "another.txt"), "another file");
-    execSync("git add . && git commit -m 'adding another file'", {
-      cwd: tempDir,
-    });
-
-    // Perform a modify
-    fs.writeFileSync(path.join(tempDir, "third.txt"), "third+");
-    execSync("git add . && git commit -m 'modifying third'", { cwd: tempDir });
-
-    // Perform a delete
-    fs.rmSync(path.join(tempDir, "second.txt"));
-    execSync("git add . && git commit -m 'deleting second'", { cwd: tempDir });
-
-    const result = await gitDiff(tempDir, firstCommit);
-
-    // Because of --no-renames:
-    expect(result).toEqual({
-      deleted: expect.arrayContaining(["file1.txt", "second.txt"]),
-      added: expect.arrayContaining(["file2.txt", "another.txt"]),
-      modified: ["third.txt"],
-    });
-  });
-});

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

@@ -1,39 +0,0 @@
-import { execSync } from "child_process";
-
-/**
- * For a given directory with a git configuration, this will return the modified, added, and
- * deleted files since the last afterRef
- * @param gitDir The git directory folder
- * @param afterRef The git ref to look for diffs after
- * @returns
- */
-export async function gitDiff(gitDir: string, afterRef: string) {
-  const baseCommand = `git diff ${afterRef}.. --no-renames --name-only`;
-  const modifiedFiles = execSync(`${baseCommand} --diff-filter=M`, {
-    cwd: gitDir,
-  })
-    .toString()
-    .trim()
-    .split("\n")
-    .filter((s) => s !== "");
-  const addedFiles = execSync(`${baseCommand} --diff-filter=A`, {
-    cwd: gitDir,
-  })
-    .toString()
-    .trim()
-    .split("\n")
-    .filter((s) => s !== "");
-  const deletedFiles = execSync(`${baseCommand} --diff-filter=D`, {
-    cwd: gitDir,
-  })
-    .toString()
-    .trim()
-    .split("\n")
-    .filter((s) => s !== "");
-
-  return {
-    modified: modifiedFiles,
-    added: addedFiles,
-    deleted: deletedFiles,
-  };
-}

package/src/diff-drivers/index.ts

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

package/src/diff-drivers/types.ts

@@ -1,14 +0,0 @@
-export interface DiffResult {
-  modified: string[];
-  added: string[];
-  deleted: string[];
-}
-
-/**
- * A function that operates within the gitDir, and returns the list of file paths
- * since the last sha
- */
-export type TemplateDiffDriverFn = (
-  gitDir: string,
-  afterRef: string,
-) => Promise<DiffResult>;

package/src/formatting/__snapshots__/sync-results-to-md.spec.ts.snap

@@ -1,39 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`syncResultsToMd snapshots 1`] = `
-"# templatesync.local 
-
-## Stopped the following files from syncing:
-
-* src/file1.ts
-
-
-## Changed the following files from what they would have synced:
-
-package.json
-\`\`\`diff
-
-+my thing
-
--your thang
-
-\`\`\`
-
-## Files Modified (6)
-
-Added:
-
-- src/something.ts
-- new_settings.toml
-
-Modified:
-
-- something.txt
-- .env
-
-Deleted:
-
-- TODO.md
-- throwaway.ts
-"
-`;

package/src/formatting/index.ts

@@ -1,2 +0,0 @@
-export * from "./sync-results-to-md";
-export * from "./infer-json-indent";

package/src/formatting/infer-json-indent.spec.ts

@@ -1,49 +0,0 @@
-import { inferJSONIndent } from "./infer-json-indent";
-
-const withNewLine = `{
-
-    "whoa": true,
-    "thing": here,
-    "something": {
-        "nested": false
-    }
-}`;
-
-const fourSpaces = `{
-    "whoa": true,
-    "thing": here,
-    "something": {
-        "nested": false
-    }
-}`;
-
-const tabSpaces = `{
-	"whoa": true,
-	"thing": here,
-	"something": {
-		"nested": false
-	}
-}`;
-
-const twoSpaces = `{
-  "whoa": true,
-  "thing": here,
-  "something": {
-    "nested": false
-  }
-}`;
-
-describe("inferJSONIndent", () => {
-  it("returns spaces when the first indent is spaces with a new line", () => {
-    expect(inferJSONIndent(withNewLine)).toBe("    ");
-  });
-  it("returns spaces when the first indent is spaces", () => {
-    expect(inferJSONIndent(fourSpaces)).toBe("    ");
-  });
-  it("returns spaces when the first indent is spaces", () => {
-    expect(inferJSONIndent(twoSpaces)).toBe("  ");
-  });
-  it("returns tabs when the first indent is a tab", () => {
-    expect(inferJSONIndent(tabSpaces)).toBe("\t");
-  });
-});

package/src/formatting/infer-json-indent.ts

@@ -1,16 +0,0 @@
-const spacingRegex = /[{[]\n?(?<spacing>\s+)["tf\d]/;
-export function inferJSONIndent(rawJSON: string) {
-  const match = spacingRegex.exec(rawJSON);
-  if (!match?.groups?.spacing) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      `Could not find json indentation for json string: ${rawJSON.slice(40)} ... \nDefaulting to 4 spaces`,
-    );
-    // Four spaces
-    return "    ";
-  }
-  const spacing = match.groups.spacing;
-  // Handle the case where there were multiple newlines before a value
-  const lastNewLine = spacing.lastIndexOf("\n");
-  return match?.groups.spacing.slice(lastNewLine >= 0 ? lastNewLine + 1 : 0);
-}