@hanseltime/template-repo-sync 1.3.0 → 2.0.2

package/lib/cjs/types.d.ts

@@ -30,18 +30,22 @@ type MergePluginOptions = JsonFileMergeOptions;
  * Configuration object for a given file type merge configuration
  */
 export interface MergeConfig<T> {
+    /**
+     * A glob or array of globs (using micromatch syntax) that selects the files that this applies to
+     * when merging
+     */
+    glob: string | string[];
     /**
      * The node module, available on the calling node context, that you want to run.
-     * If not provided, we try to use any built-in merge plugins.
+     * Built-in plugins can be specified via their built-in name (see documentation):
+     *
+     * Example: _json
      */
-    plugin?: string;
+    plugin: string;
     /**
      * An array of first match file globs that will then call the plugin with the appropriate options
      */
-    rules: {
-        glob: string;
-        options: MergePluginOptions | T;
-    }[];
+    options: MergePluginOptions | T;
 }
 /**
  * The shape of a template sync config file
@@ -51,9 +55,7 @@ export interface Config<T = unknown> {
     /**
      * If there is no merge config, then we will always just overwrite the file for the diff
      */
-    merge?: {
-        [fileExt: string]: MergeConfig<T>;
-    };
+    merge?: MergeConfig<T>[];
 }
 /**
  * The shape of a local template sync config file that overrides the root template repo
@@ -68,9 +70,7 @@ export interface LocalConfig<T = unknown> {
     /**
      * If there is no merge config, then we will always just overwrite the file for the diff
      */
-    merge?: {
-        [fileExt: string]: MergeConfig<T>;
-    };
+    merge?: MergeConfig<T>[];
 }
 /**
  * Information around the file we are trying to merge and that arguments for that merge

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

@@ -4,14 +4,26 @@ 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}`, {
+    const remoteInfo = (0, child_process_1.execSync)(`git remote show ${remoteName}`, {
         cwd: tmpDir,
         env: process.env,
-    });
-    (0, child_process_1.execSync)(`git checkout -b ${branch} --track ${remoteName}/${branch}`, {
-        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) {
+        (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/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.0",
+  "version": "2.0.2",
   "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,18 @@ 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
+      },
+    ],
+    [
+      "@semantic-release/exec",
+      {
+        publishCmd: "npm publish --access public",
+      },
+    ],
     [
       "@semantic-release/git",
       {

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

@@ -55,4 +55,15 @@ describe("gitCheckout", () => {
         }),
     ).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

@@ -9,14 +9,30 @@ export async function gitCheckout(options: {
   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}`, {
+
+  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/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>;