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

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);
-}

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

@@ -1,31 +0,0 @@
-import { syncResultsToMd } from "./sync-results-to-md";
-
-describe("syncResultsToMd", () => {
-  it("snapshots", () => {
-    expect(
-      syncResultsToMd({
-        localSkipFiles: ["src/file1.ts"],
-        localFileChanges: {
-          "package.json": [
-            {
-              count: 8,
-              value: "my thing",
-              added: true,
-            },
-            {
-              count: 10,
-              value: "your thang",
-              removed: true,
-            },
-          ],
-        },
-        modifiedFiles: {
-          added: ["src/something.ts", "new_settings.toml"],
-          deleted: ["TODO.md", "throwaway.ts"],
-          modified: ["something.txt", ".env"],
-          total: 6,
-        },
-      }),
-    ).toMatchSnapshot();
-  });
-});

package/src/formatting/sync-results-to-md.ts

@@ -1,63 +0,0 @@
-import { Change } from "diff";
-import {
-  TEMPLATE_SYNC_LOCAL_CONFIG,
-  TemplateSyncReturn,
-} from "../template-sync";
-
-export function syncResultsToMd(result: TemplateSyncReturn) {
-  return `# ${TEMPLATE_SYNC_LOCAL_CONFIG} 
-
-## Stopped the following files from syncing:
-
-${result.localSkipFiles.reduce((s, file) => {
-  return `${s}* ${file}\n`;
-}, "")}
-
-## Changed the following files from what they would have synced:
-
-${Object.keys(result.localFileChanges).reduce((s, file) => {
-  return `${s}${file}
-\`\`\`diff
-${result.localFileChanges[file].reduce((diffS, change) => {
-  return `${diffS}\n${makeChangeIntoDiffLines(change)}`;
-}, "")}
-\`\`\``;
-}, "")}
-
-## Files Modified (${result.modifiedFiles.total})
-
-Added:
-${result.modifiedFiles.added.reduce((s, f) => {
-  return `${s}\n- ${f}`;
-}, "")}
-
-Modified:
-${result.modifiedFiles.modified.reduce((s, f) => {
-  return `${s}\n- ${f}`;
-}, "")}
-
-Deleted:
-${result.modifiedFiles.deleted.reduce((s, f) => {
-  return `${s}\n- ${f}`;
-}, "")}
-`;
-}
-
-function makeChangeIntoDiffLines(change: Change, nonchangeMax = 3) {
-  const operator = change.added ? "+" : change.removed ? "-" : "";
-
-  if (
-    !operator &&
-    nonchangeMax > 0 &&
-    change.count &&
-    change.count > nonchangeMax
-  ) {
-    const lines = change.value.split("\n");
-    const partial = lines.slice(lines.length - nonchangeMax);
-    return `...\n${partial.join("\n")}\n`;
-  }
-
-  return change.value.split("\n").reduce((s, line) => {
-    return `${s}${operator}${line}\n`;
-  }, "");
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from "./types";
-export * from "./template-sync";
-export * from "./formatting";

package/src/load-plugin.ts

@@ -1,51 +0,0 @@
-import { defaultExtensionMap } from "./plugins";
-import { MergeConfig, MergePlugin } from "./types";
-import { existsSync } from "fs";
-import { resolve } from "path";
-
-/**
- * Loads the plugin associated with the merge config
- * @param mergeConfig
- * @param forExt
- * @param configDir
- * @returns
- */
-export async function loadPlugin<T>(
-  mergeConfig: MergeConfig<T>,
-  configDir: string,
-): Promise<MergePlugin<T>> {
-  if (mergeConfig.plugin.startsWith("_")) {
-    const defaultHandler = Object.values(defaultExtensionMap).find(
-      (el) => el.builtinName === mergeConfig.plugin,
-    );
-    if (!defaultHandler) {
-      throw new Error(
-        `No builtin merge function supplied for ${mergeConfig.plugin}.  Cannot have merge config without custom plugin supplied.`,
-      );
-    }
-    return defaultHandler as MergePlugin<T>;
-  }
-
-  let handler: MergePlugin<unknown>;
-  // First check if this is a local .js file
-  const localPath = resolve(configDir, mergeConfig.plugin);
-  const importPath = existsSync(localPath) ? localPath : mergeConfig.plugin;
-  try {
-    // Sad workaround for testing since dynamic import segfaults
-    if (process.env.JEST_WORKER_ID !== undefined) {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      handler = require(importPath) as MergePlugin<unknown>;
-    } else {
-      handler = (await import(importPath)) as MergePlugin<unknown>;
-    }
-    if (!handler.merge) {
-      handler = (handler as unknown as { default: MergePlugin<unknown> })
-        .default;
-    }
-  } catch (err) {
-    console.error(err);
-    throw err;
-  }
-
-  return handler as MergePlugin<T>;
-}

package/src/match.spec.ts

@@ -1,68 +0,0 @@
-import { resolve } from "path";
-import { getAllFilesInDir } from "./match";
-import { TEST_FIXTURES_DIR } from "./test-utils";
-
-const TEST_GLOB_DIR = resolve(TEST_FIXTURES_DIR, "glob-test");
-
-describe("getAllFilesInDir", () => {
-  it("gets all files in the directory with no ignores", () => {
-    const files = getAllFilesInDir(TEST_GLOB_DIR, []);
-    expect(files).toEqual(
-      expect.arrayContaining([
-        "folder1/something.js",
-        "folder1/something.ts",
-        "toplevel.js",
-        "toplevel.txt",
-      ]),
-    );
-    try {
-      expect(files.length).toBe(4);
-    } catch (err) {
-      console.error("All found files: " + files);
-      throw err;
-    }
-  });
-  it("gets all files in the directory that do not match the ignore (single)", () => {
-    const files = getAllFilesInDir(TEST_GLOB_DIR, ["**/*.ts"]);
-    expect(files).toEqual(
-      expect.arrayContaining([
-        "folder1/something.js",
-        "toplevel.js",
-        "toplevel.txt",
-      ]),
-    );
-    try {
-      expect(files.length).toBe(3);
-    } catch (err) {
-      console.error("All found files: " + files);
-      throw err;
-    }
-  });
-  it("gets all files in the directory that do not match the ignore (multiple)", () => {
-    const files = getAllFilesInDir(TEST_GLOB_DIR, ["**/*.ts", "**/*.txt"]);
-    expect(files).toEqual(
-      expect.arrayContaining(["folder1/something.js", "toplevel.js"]),
-    );
-    try {
-      expect(files.length).toBe(2);
-    } catch (err) {
-      console.error("All found files: " + files);
-      throw err;
-    }
-  });
-
-  it("gets all files in the directory that do not match the ignore with a folder level directive (multiple)", () => {
-    const files = getAllFilesInDir(TEST_GLOB_DIR, [
-      "**/*.ts",
-      "**/*.txt",
-      "folder1",
-    ]);
-    expect(files).toEqual(expect.arrayContaining(["toplevel.js"]));
-    try {
-      expect(files.length).toBe(1);
-    } catch (err) {
-      console.error("All found files: " + files);
-      throw err;
-    }
-  });
-});

package/src/match.ts

@@ -1,52 +0,0 @@
-import { readdirSync } from "fs";
-import { some } from "micromatch";
-import { join } from "path";
-
-export function invertMatchPatterns(patterns: string[]) {
-  return patterns.map((pattern) => {
-    if (pattern.startsWith("!")) {
-      return pattern.slice(1);
-    }
-    return `!${pattern}`;
-  });
-}
-
-/**
- * Gets all the files in the directory recursively while avoiding any micromatch patterns
- * that would match for ignoring
- *
- * @param dir
- * @param ignorePatterns
- * @returns
- */
-export function getAllFilesInDir(
-  dir: string,
-  ignorePatterns: string[],
-): string[] {
-  return recurseDirsForFiles(dir, ignorePatterns);
-}
-
-function recurseDirsForFiles(
-  dirpath: string,
-  ignorePatterns: string[],
-  relativeRoot = "",
-): string[] {
-  return readdirSync(dirpath, {
-    withFileTypes: true,
-  }).reduce((files, f) => {
-    const relPath = join(relativeRoot, f.name);
-    if (some(relPath, ignorePatterns)) {
-      return files;
-    }
-
-    // Ensure we aren't ignoring these folders explicitly
-    if (f.isDirectory()) {
-      files.push(
-        ...recurseDirsForFiles(join(dirpath, f.name), ignorePatterns, relPath),
-      );
-    } else {
-      files.push(relPath);
-    }
-    return files;
-  }, [] as string[]);
-}