@hanseltime/template-repo-sync 1.3.1 → 2.0.4

package/lib/esm/load-plugin.js

@@ -4,36 +4,42 @@ exports.loadPlugin = void 0;
 const plugins_1 = require("./plugins");
 const fs_1 = require("fs");
 const path_1 = require("path");
-async function loadPlugin(mergeConfig, forExt, configDir) {
+/**
+ * Loads the plugin associated with the merge config
+ * @param mergeConfig
+ * @param forExt
+ * @param configDir
+ * @returns
+ */
+async function loadPlugin(mergeConfig, configDir) {
+    if (mergeConfig.plugin.startsWith("_")) {
+        const defaultHandler = Object.values(plugins_1.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;
+    }
     let handler;
-    if (mergeConfig.plugin) {
-        // First check if this is a loal .js file
-        const localPath = (0, path_1.resolve)(configDir, mergeConfig.plugin);
-        const importPath = (0, fs_1.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);
-            }
-            else {
-                handler = (await import(importPath));
-            }
-            if (!handler.merge) {
-                handler = handler
-                    .default;
-            }
+    // First check if this is a local .js file
+    const localPath = (0, path_1.resolve)(configDir, mergeConfig.plugin);
+    const importPath = (0, fs_1.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);
         }
-        catch (err) {
-            console.error(err);
-            throw err;
+        else {
+            handler = (await import(importPath));
         }
-    }
-    else {
-        if (!plugins_1.defaultExtensionMap[forExt]) {
-            throw new Error(`No default merge function supplied for ${forExt}.  Cannot have mere config without custom plugin supplied.`);
+        if (!handler.merge) {
+            handler = handler
+                .default;
         }
-        handler = plugins_1.defaultExtensionMap[forExt];
+    }
+    catch (err) {
+        console.error(err);
+        throw err;
     }
     return handler;
 }

package/lib/esm/merge-file.js

@@ -26,50 +26,39 @@ async function mergeFile(relPath, context) {
     const ext = (0, path_1.extname)(relPath);
     const filePath = (0, path_1.join)(cwd, relPath);
     const templatePath = (0, path_1.join)(tempCloneDir, relPath);
-    const mergeConfig = templateSyncConfig.merge?.[ext];
-    const localMergeConfig = localTemplateSyncConfig.merge?.[ext];
-    // Either write the merge or write
+    const mergeConfig = templateSyncConfig.merge?.find((mergeConfig) => (0, micromatch_1.isMatch)(relPath, mergeConfig.glob));
+    const localMergeConfig = localTemplateSyncConfig.merge?.find((mergeConfig) => (0, micromatch_1.isMatch)(relPath, mergeConfig.glob));
+    const mergeHandler = mergeConfig
+        ? await (0, load_plugin_1.loadPlugin)(mergeConfig, tempCloneDir)
+        : undefined;
+    const localMergeHandler = localMergeConfig
+        ? await (0, load_plugin_1.loadPlugin)(localMergeConfig, cwd)
+        : undefined;
+    // Either write the merge or write the file
     let fileContents;
     const localChanges = [];
-    if ((0, fs_1.existsSync)(filePath) && (mergeConfig || localMergeConfig)) {
+    if ((0, fs_1.existsSync)(filePath) && (mergeHandler || localMergeHandler)) {
         const originalCurrentFile = (await (0, promises_1.readFile)(filePath)).toString();
-        if (mergeConfig) {
-            // Apply the template's most recent merges
-            const handler = await (0, load_plugin_1.loadPlugin)(mergeConfig, ext, tempCloneDir);
-            const mergeOptions = mergeConfig.rules.find((rule) => {
-                return (0, micromatch_1.isMatch)(relPath, rule.glob);
+        if (mergeHandler) {
+            fileContents = await safeMerge(mergeHandler, mergeConfig?.plugin ?? `default for ${ext}`, originalCurrentFile, (await (0, promises_1.readFile)(templatePath)).toString(), {
+                relFilePath: relPath,
+                mergeArguments: mergeConfig?.options ?? {},
+                isLocalOptions: false,
             });
-            if (mergeOptions) {
-                fileContents = await safeMerge(handler, mergeConfig.plugin ?? `default for ${ext}`, originalCurrentFile, (await (0, promises_1.readFile)(templatePath)).toString(), {
-                    relFilePath: relPath,
-                    mergeArguments: mergeOptions.options,
-                    isLocalOptions: true,
-                });
-            }
-            else {
-                // Apply overwrite if we didn't set up merge
-                fileContents = (await (0, promises_1.readFile)(templatePath)).toString();
-            }
         }
         else {
             // Apply overwrite if we didn't set up merge
             fileContents = (await (0, promises_1.readFile)(templatePath)).toString();
         }
         // We apply the localMerge Config to the fileContent output by the template merge
-        if (localMergeConfig) {
-            const handler = await (0, load_plugin_1.loadPlugin)(localMergeConfig, ext, cwd);
-            const mergeOptions = localMergeConfig.rules.find((rule) => {
-                return (0, micromatch_1.isMatch)(relPath, rule.glob);
+        if (localMergeHandler) {
+            const localContents = await safeMerge(localMergeHandler, localMergeConfig?.plugin ?? `default for ${ext}`, originalCurrentFile, fileContents, {
+                relFilePath: relPath,
+                mergeArguments: localMergeConfig?.options ?? {},
+                isLocalOptions: true,
             });
-            if (mergeOptions) {
-                const localContents = await safeMerge(handler, localMergeConfig.plugin ?? `default for ${ext}`, originalCurrentFile, fileContents, {
-                    relFilePath: relPath,
-                    mergeArguments: mergeOptions.options,
-                    isLocalOptions: true,
-                });
-                localChanges.push(...(0, diff_1.diffLines)(fileContents, localContents));
-                fileContents = localContents;
-            }
+            localChanges.push(...(0, diff_1.diffLines)(fileContents, localContents));
+            fileContents = localContents;
         }
     }
     else {

package/lib/esm/plugins/index.js

@@ -6,5 +6,6 @@ exports.defaultExtensionMap = {
     ".json": {
         merge: json_merge_1.merge,
         validate: json_merge_1.validate,
+        builtinName: "_json",
     },
 };

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@hanseltime/template-repo-sync",
-  "version": "1.3.1",
+  "version": "2.0.4",
   "description": "An npm library that enables pluggable, customizable synchronization between template repos",
   "main": "lib/cjs/index.js",
   "types": "lib/cjs/index.d.ts",
   "module": "lib/esm/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HanseltimeIndustries/template-repo-sync.git"
+  },
   "scripts": {
     "format": "prettier . --write",
     "lint": "eslint .",
@@ -28,6 +32,7 @@
   "devDependencies": {
     "@commitlint/config-angular": "^19.0.3",
     "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/diff": "^5.0.9",
     "@types/fs-extra": "^11.0.4",

package/release.config.js

@@ -19,7 +19,13 @@ module.exports = {
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
-    "@semantic-release/npm",
+    [
+      "@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",
       {

package/src/load-plugin.ts

@@ -3,39 +3,48 @@ 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>,
-  forExt: string,
   configDir: string,
 ): Promise<MergePlugin<T>> {
-  let handler: MergePlugin<unknown>;
-  if (mergeConfig.plugin) {
-    // First check if this is a loal .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;
-    }
-  } else {
-    if (!defaultExtensionMap[forExt]) {
+  if (mergeConfig.plugin.startsWith("_")) {
+    const defaultHandler = Object.values(defaultExtensionMap).find(
+      (el) => el.builtinName === mergeConfig.plugin,
+    );
+    if (!defaultHandler) {
       throw new Error(
-        `No default merge function supplied for ${forExt}.  Cannot have mere config without custom plugin supplied.`,
+        `No builtin merge function supplied for ${mergeConfig.plugin}.  Cannot have merge config without custom plugin supplied.`,
       );
     }
-    handler = defaultExtensionMap[forExt];
+    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/merge-file.spec.ts

@@ -42,7 +42,7 @@ describe("mergeFile", () => {
         tempCloneDir: testTemplateDir,
         localTemplateSyncConfig: {
           ignore: ["**/package.json"],
-          merge: {},
+          merge: [],
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
@@ -85,21 +85,18 @@ describe("mergeFile", () => {
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
-          merge: {
-            ".json": {
-              // no plugins
-              rules: [
-                {
-                  glob: "**/package.json",
-                  options: "merge-current",
-                },
-                {
-                  glob: "**/package.json",
-                  options: "merge-template",
-                },
-              ],
+          merge: [
+            {
+              glob: "**/package.json",
+              options: "merge-current",
+              plugin: "_json",
             },
-          },
+            {
+              glob: "**/package.json",
+              options: "merge-template",
+              plugin: "_json",
+            },
+          ],
         },
       }),
     ).toEqual({
@@ -140,21 +137,18 @@ describe("mergeFile", () => {
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
-          merge: {
-            ".json": {
-              // no plugins
-              rules: [
-                {
-                  glob: "**/package.json",
-                  options: "merge-template",
-                },
-                {
-                  glob: "**/package.json",
-                  options: "merge-current",
-                },
-              ],
+          merge: [
+            {
+              glob: "**/package.json",
+              options: "merge-template",
+              plugin: "_json",
+            },
+            {
+              glob: "**/package.json",
+              options: "merge-current",
+              plugin: "_json",
             },
-          },
+          ],
         },
       }),
     ).toEqual({
@@ -192,45 +186,34 @@ describe("mergeFile", () => {
         tempCloneDir: testTemplateDir,
         localTemplateSyncConfig: {
           ignore: [],
-          merge: {
-            ".json": {
-              rules: [
-                {
-                  glob: "**/package.json",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                },
-              ],
+          merge: [
+            {
+              plugin: "_json",
+              glob: "**/package.json",
+              options: {
+                paths: [
+                  // Do not touch huh
+                  ["$.dependencies.huh", "merge-current"],
+                ],
+              },
             },
-          },
+          ],
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
-          merge: {
-            ".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",
-                },
-              ],
+          merge: [
+            {
+              glob: "**/package.json",
+              plugin: "_json",
+              options: {
+                missingIsDelete: true,
+                paths: [
+                  // Merge all template dependencies
+                  ["$.dependencies", "merge-template"],
+                ],
+              } as JsonFileMergeOptions,
             },
-          },
+          ],
         },
       }),
     ).toEqual({
@@ -281,47 +264,34 @@ describe("mergeFile", () => {
         tempCloneDir: testTemplateDir,
         localTemplateSyncConfig: {
           ignore: [],
-          merge: {
-            ".json": {
-              // simulates a "node" plugin since we're pulling from the current context
+          merge: [
+            {
               plugin: "../test-fixtures/dummy-plugin.js",
-              rules: [
-                {
-                  glob: "**/package.json",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                },
-              ],
+              options: {
+                paths: [
+                  // Do not touch huh
+                  ["$.dependencies.huh", "merge-current"],
+                ],
+              },
+              glob: "**/package.json",
             },
-          },
+          ],
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
-          merge: {
-            ".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",
-                },
-              ],
+          merge: [
+            {
+              plugin: "_json",
+              glob: "**/package.json",
+              options: {
+                missingIsDelete: true,
+                paths: [
+                  // Merge all template dependencies
+                  ["$.dependencies", "merge-template"],
+                ],
+              } as JsonFileMergeOptions,
             },
-          },
+          ],
         },
       }),
     ).toEqual({
@@ -366,54 +336,62 @@ describe("mergeFile", () => {
       tested: true,
     });
   });
-  it("[inverse] applies default [.json] and custom merge for local with sync plugin and then local override", async () => {
+  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,
         localTemplateSyncConfig: {
           ignore: [],
-          merge: {
-            ".json": {
-              // This is a relative path to ht
+          merge: [
+            {
+              glob: "**/package.json",
               plugin: "plugins/custom-plugin.js",
-              rules: [
-                {
-                  glob: "**/package.json",
-                  options: {
-                    paths: [
-                      // Do not touch huh
-                      ["$.dependencies.huh", "merge-current"],
-                    ],
-                  },
-                },
-              ],
+              options: {
+                paths: [
+                  // Do not touch huh
+                  ["$.dependencies.huh", "merge-current"],
+                ],
+              },
             },
-          },
+          ],
         },
         templateSyncConfig: {
           ignore: ["**/*.txt"],
-          merge: {
-            ".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",
-                },
-              ],
+          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({