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

package/src/merge-file.spec.ts

@@ -1,506 +0,0 @@
-import { join, resolve } from "path";
-import { mergeFile } from "./merge-file";
-import { tempDir, TEST_FIXTURES_DIR } from "./test-utils";
-import { mkdtemp, readFile, rm } from "fs/promises";
-import { copySync } from "fs-extra";
-import { FileOperation, JsonFileMergeOptions } from "./types";
-import { existsSync } from "fs";
-
-const testTemplateDir = resolve(TEST_FIXTURES_DIR, "template");
-const testDownstreamDir = resolve(TEST_FIXTURES_DIR, "downstream");
-
-describe("mergeFile", () => {
-  let tmpDir: string;
-  let tmpTemplateDir: string;
-  beforeEach(async () => {
-    tmpDir = await mkdtemp(tempDir());
-    copySync(testDownstreamDir, tmpDir);
-    tmpTemplateDir = await mkdtemp(tempDir());
-    copySync(testTemplateDir, tmpTemplateDir);
-  });
-  afterEach(async () => {
-    await rm(tmpDir, {
-      force: true,
-      recursive: true,
-    });
-    await rm(tmpTemplateDir, {
-      force: true,
-      recursive: true,
-    });
-  });
-  // Note: we use the "ignore" from the templateSync to constrain files we iterate over so it doeesn't happen here
-  // it('skips the file if it is part of template config ignroe', async () => {
-  //     expect(await mergeFile('package.json', {
-  //         cwd: tmpDir,
-  //         tempCloneDir: testTemplateDir,
-  //         localTemplateSyncConfig: {
-  //             ignore: [],
-  //             merge: {
-  //             }
-  //         },
-  //         templateSyncConfig: {
-  //             ignore: ['**/package.json'],
-  //         }
-  //     })).toBe(false)
-  // })
-  it.each([["added"], ["deleted"], ["modified"]])(
-    "skips the [%s] file if it is part of local config ignore",
-    async (op) => {
-      expect(
-        await mergeFile("package.json", {
-          cwd: tmpDir,
-          tempCloneDir: tmpTemplateDir,
-          localTemplateSyncConfig: {
-            ignore: ["**/package.json"],
-            merge: [],
-          },
-          templateSyncConfig: {
-            ignore: ["**/*.txt"],
-          },
-          fileOperation: op as FileOperation,
-        }),
-      ).toEqual({
-        ignoredDueToLocal: true,
-      });
-    },
-  );
-  it.each([["added"], ["modified"]])(
-    "overwrites if no merge config for [%s] files",
-    async (op) => {
-      expect(
-        await mergeFile("package.json", {
-          cwd: tmpDir,
-          tempCloneDir: tmpTemplateDir,
-          localTemplateSyncConfig: {
-            ignore: [],
-          },
-          templateSyncConfig: {
-            ignore: ["**/*.txt"],
-          },
-          fileOperation: op as FileOperation,
-        }),
-      ).toEqual({
-        ignoredDueToLocal: false,
-        localChanges: [],
-      });
-
-      // Ensure we overwrote
-      expect(await readFile(join(tmpDir, "package.json"))).toEqual(
-        await readFile(join(tmpTemplateDir, "package.json")),
-      );
-    },
-  );
-  it("removes the template deleted files", async () => {
-    expect(
-      await mergeFile("package.json", {
-        cwd: tmpDir,
-        tempCloneDir: tmpTemplateDir,
-        localTemplateSyncConfig: {
-          ignore: [],
-        },
-        templateSyncConfig: {
-          ignore: ["**/*.txt"],
-        },
-        fileOperation: "deleted", // This is normally inferred by the top-level code
-      }),
-    ).toEqual({
-      ignoredDueToLocal: false,
-      localChanges: [],
-    });
-
-    // Ensure we overwrote
-    expect(existsSync(join(tmpDir, "package.json"))).toBeFalsy();
-  });
-
-  // TODO - this could change if there's a use case
-  it("does not apply plugins on deleted", async () => {
-    expect(
-      await mergeFile("package.json", {
-        cwd: tmpDir,
-        tempCloneDir: tmpTemplateDir,
-        localTemplateSyncConfig: {
-          ignore: [],
-          merge: [
-            {
-              plugin: "_json",
-              glob: "**/package.json",
-              options: {
-                paths: [
-                  // Do not touch huh
-                  ["$.dependencies.huh", "merge-current"],
-                ],
-              },
-            },
-          ],
-        },
-        templateSyncConfig: {
-          ignore: ["**/*.txt"],
-          merge: [
-            {
-              glob: "**/package.json",
-              plugin: "_json",
-              options: {
-                missingIsDelete: true,
-                paths: [
-                  // Merge all template dependencies
-                  ["$.dependencies", "merge-template"],
-                ],
-              } as JsonFileMergeOptions,
-            },
-          ],
-        },
-        fileOperation: "deleted", // This is normally inferred by the top-level code
-      }),
-    ).toEqual({
-      ignoredDueToLocal: false,
-      localChanges: [],
-    });
-
-    // Ensure we overwrote
-    expect(existsSync(join(tmpDir, "package.json"))).toBeFalsy();
-  });
-
-  describe.each([["added" as FileOperation], ["modified" as FileOperation]])(
-    "[%s] file",
-    (op: FileOperation) => {
-      // Yea... these are more integration tests but I'm kinda untrusting of mocks for this
-      it("applies default [.json] merge with first rules if merge applies to file", async () => {
-        expect(
-          await mergeFile("package.json", {
-            cwd: tmpDir,
-            tempCloneDir: testTemplateDir,
-            localTemplateSyncConfig: {
-              ignore: [],
-            },
-            fileOperation: op,
-            templateSyncConfig: {
-              ignore: ["**/*.txt"],
-              merge: [
-                {
-                  glob: "**/package.json",
-                  options: "merge-current",
-                  plugin: "_json",
-                },
-                {
-                  glob: "**/package.json",
-                  options: "merge-template",
-                  plugin: "_json",
-                },
-              ],
-            },
-          }),
-        ).toEqual({
-          ignoredDueToLocal: false,
-          localChanges: [],
-        });
-
-        // Ensure we overwrote
-        expect(
-          JSON.parse((await readFile(join(tmpDir, "package.json"))).toString()),
-        ).toEqual({
-          name: "mypkg",
-          description: "my description",
-          dependencies: {
-            mypackage: "^1.2.0",
-            newpacakge: "^22.2.2",
-            package2: "3.22.1",
-            huh: "^2.30.0",
-          },
-          engines: {
-            node: ">=20",
-          },
-          scripts: {
-            build: "build",
-            test: "jest",
-            myscript: "somescript",
-          },
-          version: "new-version",
-        });
-      });
-      it("[inverse] applies default [.json] merge with first rules if merge applies to file", async () => {
-        expect(
-          await mergeFile("package.json", {
-            cwd: tmpDir,
-            tempCloneDir: testTemplateDir,
-            localTemplateSyncConfig: {
-              ignore: [],
-            },
-            fileOperation: op,
-            templateSyncConfig: {
-              ignore: ["**/*.txt"],
-              merge: [
-                {
-                  glob: "**/package.json",
-                  options: "merge-template",
-                  plugin: "_json",
-                },
-                {
-                  glob: "**/package.json",
-                  options: "merge-current",
-                  plugin: "_json",
-                },
-              ],
-            },
-          }),
-        ).toEqual({
-          ignoredDueToLocal: false,
-          localChanges: [],
-        });
-
-        // Ensure we overwrote
-        expect(
-          JSON.parse((await readFile(join(tmpDir, "package.json"))).toString()),
-        ).toEqual({
-          name: "some-stub-name",
-          description: "some-stub-description",
-          dependencies: {
-            mypackage: "^1.2.0",
-            newpacakge: "^22.2.2",
-            package2: "3.22.1",
-            huh: "~1.0.0",
-          },
-          engines: {
-            node: ">=15",
-          },
-          scripts: {
-            build: "build",
-            test: "fill this in yourself",
-            myscript: "somescript",
-          },
-          version: "new-version",
-        });
-      });
-      it("[inverse] applies default [.json] merge with sync and then local override", async () => {
-        expect(
-          await mergeFile("package.json", {
-            cwd: tmpDir,
-            tempCloneDir: testTemplateDir,
-            fileOperation: op,
-            localTemplateSyncConfig: {
-              ignore: [],
-              merge: [
-                {
-                  plugin: "_json",
-                  glob: "**/package.json",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                },
-              ],
-            },
-            templateSyncConfig: {
-              ignore: ["**/*.txt"],
-              merge: [
-                {
-                  glob: "**/package.json",
-                  plugin: "_json",
-                  options: {
-                    missingIsDelete: true,
-                    paths: [
-                      // Merge all template dependencies
-                      ["$.dependencies", "merge-template"],
-                    ],
-                  } as JsonFileMergeOptions,
-                },
-              ],
-            },
-          }),
-        ).toEqual({
-          ignoredDueToLocal: false,
-          localChanges: expect.arrayContaining([
-            {
-              added: undefined,
-              count: 1,
-              removed: true,
-              value: '    "huh": "~1.0.0"\n',
-            },
-            {
-              added: true,
-              count: 1,
-              removed: undefined,
-              value: '    "huh": "^2.30.0"\n',
-            },
-          ]),
-        });
-
-        // Ensure we overwrote
-        expect(
-          JSON.parse((await readFile(join(tmpDir, "package.json"))).toString()),
-        ).toEqual({
-          name: "mypkg",
-          description: "my description",
-          dependencies: {
-            mypackage: "^1.2.0",
-            newpacakge: "^22.2.2",
-            package2: "3.22.1",
-            huh: "^2.30.0",
-          },
-          engines: {
-            node: ">=20",
-          },
-          scripts: {
-            build: "build",
-            test: "jest",
-            myscript: "somescript",
-          },
-          version: "new-version",
-        });
-      });
-      it("[inverse] applies default [.json] and custom merge for local with sync and then local override", async () => {
-        expect(
-          await mergeFile("package.json", {
-            cwd: tmpDir,
-            tempCloneDir: testTemplateDir,
-            fileOperation: op,
-            localTemplateSyncConfig: {
-              ignore: [],
-              merge: [
-                {
-                  plugin: "../test-fixtures/dummy-plugin.js",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                  glob: "**/package.json",
-                },
-              ],
-            },
-            templateSyncConfig: {
-              ignore: ["**/*.txt"],
-              merge: [
-                {
-                  plugin: "_json",
-                  glob: "**/package.json",
-                  options: {
-                    missingIsDelete: true,
-                    paths: [
-                      // Merge all template dependencies
-                      ["$.dependencies", "merge-template"],
-                    ],
-                  } as JsonFileMergeOptions,
-                },
-              ],
-            },
-          }),
-        ).toEqual({
-          ignoredDueToLocal: false,
-          // TODO: I don't
-          localChanges: expect.arrayContaining([
-            {
-              added: undefined,
-              count: 17,
-              removed: true,
-              value: `  "name": "mypkg",
-  "description": "my description",
-  "dependencies": {
-    "mypackage": "^1.2.0",
-    "newpacakge": "^22.2.2",
-    "package2": "3.22.1",
-    "huh": "~1.0.0"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "scripts": {
-    "build": "build",
-    "test": "jest",
-    "myscript": "somescript"
-  },
-  "version": "new-version"\n`,
-            },
-            {
-              added: true,
-              count: 1,
-              removed: undefined,
-              value: `    "tested": true\n`,
-            },
-          ]),
-        });
-
-        // Ensure we overwrote
-        expect(
-          JSON.parse((await readFile(join(tmpDir, "package.json"))).toString()),
-        ).toEqual({
-          tested: true,
-        });
-      });
-      it("[inverse] applies builtin _json and custom merge for local with sync plugin and then local override", async () => {
-        expect(
-          await mergeFile("package.json", {
-            cwd: tmpDir,
-            tempCloneDir: testTemplateDir,
-            fileOperation: op,
-            localTemplateSyncConfig: {
-              ignore: [],
-              merge: [
-                {
-                  glob: "**/package.json",
-                  plugin: "plugins/custom-plugin.js",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                },
-              ],
-            },
-            templateSyncConfig: {
-              ignore: ["**/*.txt"],
-              merge: [
-                {
-                  glob: "**/package.json",
-                  // TODO - we need to handle the weird implicit case I added here.  It's dumb
-                  options: {
-                    missingIsDelete: true,
-                    paths: [
-                      // Merge all template dependencies
-                      ["$.dependencies", "merge-template"],
-                    ],
-                  } as JsonFileMergeOptions,
-                  plugin: "_json",
-                },
-              ],
-              //   ".json": {
-              //     // no plugins
-              //     rules: [
-              //       {
-              //         glob: "**/package.json",
-              //         options: {
-              //           missingIsDelete: true,
-              //           paths: [
-              //             // Merge all template dependencies
-              //             ["$.dependencies", "merge-template"],
-              //           ],
-              //         } as JsonFileMergeOptions,
-              //       },
-              //       {
-              //         glob: "**/package.json",
-              //         options: "merge-current",
-              //       },
-              //     ],
-              //   },
-              // },
-            },
-          }),
-        ).toEqual({
-          ignoredDueToLocal: false,
-          // We are just making sure plugin look up happens here
-          localChanges: expect.arrayContaining([]),
-        });
-
-        // Ensure we overwrote
-        expect(
-          JSON.parse((await readFile(join(tmpDir, "package.json"))).toString()),
-        ).toEqual({
-          downstream: true,
-        });
-      });
-    },
-  );
-});

package/src/merge-file.ts

@@ -1,154 +0,0 @@
-import { isMatch, some } from "micromatch";
-import { Config, FileOperation, MergeContext, MergePlugin } from "./types";
-import { extname, join } from "path";
-import { existsSync } from "fs";
-import { readFile, rm } from "fs/promises";
-import { loadPlugin } from "./load-plugin";
-import { Change, diffLines } from "diff";
-import { outputFile } from "fs-extra";
-
-interface MergeFileOptions {
-  localTemplateSyncConfig: Config;
-  templateSyncConfig: Config;
-  tempCloneDir: string;
-  cwd: string;
-  fileOperation: FileOperation;
-}
-
-interface MergeFileReturn {
-  /**
-   * If the file was ignored due to the local config
-   */
-  ignoredDueToLocal: boolean;
-  /**
-   * Only available if the file wasn't ignored, this is a list of lineDiffs
-   * from the diff library that were applied to what would've been changed by
-   * the base templatesync repo
-   */
-  localChanges?: Change[];
-}
-
-/**
- * Applies the merge to a file according to the context information.
- *
- * Returns true if merged and false if skipped
- * @param relPath
- * @param context
- * @returns
- */
-export async function mergeFile(
-  relPath: string,
-  context: MergeFileOptions,
-): Promise<MergeFileReturn> {
-  const { localTemplateSyncConfig, templateSyncConfig, tempCloneDir, cwd } =
-    context;
-
-  if (some(relPath, localTemplateSyncConfig.ignore)) {
-    return {
-      ignoredDueToLocal: true,
-    };
-  }
-
-  const ext = extname(relPath);
-  const filePath = join(cwd, relPath);
-  const templatePath = join(tempCloneDir, relPath);
-
-  // Unless there's a need, we remove files that were deleted and don't pass them to plugins yet
-  if (context.fileOperation === "deleted") {
-    if (existsSync(filePath)) {
-      await rm(filePath);
-    }
-    return {
-      ignoredDueToLocal: false,
-      localChanges: [],
-    };
-  }
-
-  const mergeConfig = templateSyncConfig.merge?.find((mergeConfig) =>
-    isMatch(relPath, mergeConfig.glob),
-  );
-  const localMergeConfig = localTemplateSyncConfig.merge?.find((mergeConfig) =>
-    isMatch(relPath, mergeConfig.glob),
-  );
-
-  const mergeHandler = mergeConfig
-    ? await loadPlugin(mergeConfig, tempCloneDir)
-    : undefined;
-  const localMergeHandler = localMergeConfig
-    ? await loadPlugin(localMergeConfig, cwd)
-    : undefined;
-
-  // Either write the merge or write the file
-  let fileContents: string;
-  const localChanges: Change[] = [];
-  if (existsSync(filePath) && (mergeHandler || localMergeHandler)) {
-    const originalCurrentFile = (await readFile(filePath)).toString();
-    if (mergeHandler) {
-      fileContents = await safeMerge(
-        mergeHandler,
-        mergeConfig?.plugin ?? `default for ${ext}`,
-        originalCurrentFile,
-        (await readFile(templatePath)).toString(),
-        {
-          relFilePath: relPath,
-          mergeArguments: mergeConfig?.options ?? {},
-          isLocalOptions: false,
-        },
-      );
-    } else {
-      // Apply overwrite if we didn't set up merge
-      fileContents = (await readFile(templatePath)).toString();
-    }
-
-    // We apply the localMerge Config to the fileContent output by the template merge
-    if (localMergeHandler) {
-      const localContents = await safeMerge(
-        localMergeHandler,
-        localMergeConfig?.plugin ?? `default for ${ext}`,
-        originalCurrentFile,
-        fileContents,
-        {
-          relFilePath: relPath,
-          mergeArguments: localMergeConfig?.options ?? {},
-          isLocalOptions: true,
-        },
-      );
-      localChanges.push(...diffLines(fileContents, localContents));
-      fileContents = localContents;
-    }
-  } else {
-    // Just perform simple overwrite
-    fileContents = (await readFile(templatePath)).toString();
-  }
-  await outputFile(filePath, fileContents);
-  return {
-    ignoredDueToLocal: false,
-    localChanges,
-  };
-}
-
-/**
- * Simple helper function to ensure that we don't let bad plugins corrupt the call flow
- * @param plugin
- */
-async function safeMerge(
-  plugin: MergePlugin<unknown>,
-  pluginPath: string,
-  current: string,
-  fromTemplate: string,
-  context: MergeContext,
-) {
-  const ret = await plugin.merge(current, fromTemplate, context);
-  if (typeof ret !== "string") {
-    throw new Error(
-      `Plugin ${pluginPath} did not return string for merge function!  This is not allowed!`,
-    );
-  }
-
-  if (!ret) {
-    throw new Error(
-      `Plugin ${pluginPath} should not make a merge be an empty string!`,
-    );
-  }
-  return ret as string;
-}

package/src/plugins/index.ts

@@ -1,12 +0,0 @@
-import { JsonFileMergeOptions, MergePlugin } from "../types";
-import { merge as jsonMerge, validate as jsonValidate } from "./json-merge";
-
-export const defaultExtensionMap = {
-  ".json": {
-    merge: jsonMerge,
-    validate: jsonValidate,
-    builtinName: "_json",
-  },
-} as {
-  [ext: string]: MergePlugin<JsonFileMergeOptions> & { builtinName: string };
-};