@hanseltime/template-repo-sync 1.3.1 → 2.0.4

package/.github/workflows/release.yaml

@@ -13,16 +13,25 @@ jobs:
     with:
       from: ${{ github.workflow }}
   release:
+    permissions:
+      contents: read
+      id-token: write
     runs-on: ubuntu-latest
     needs: call-test-workflow
     steps:
-      - uses: actions/checkout@v3
+      # Use our auto-commit permissioned app for our git actions
+      - uses: actions/create-github-app-token@v1
+        id: app-token
         with:
-          token: ${{ secrets.RELEASE_PAT }}
-      - name: Use Node.js 20.x
-        uses: actions/setup-node@v4
+          app-id: ${{ secrets.AUTO_COMMIT_APP_ID }}
+          private-key: ${{ secrets.AUTO_COMMIT_APP_PKEY }}
+      - uses: actions/checkout@v6
         with:
-          node-version: 20.x
+          token: ${{ steps.app-token.outputs.token }}
+      - name: Use Node.js 24.x
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24.x
           cache: "npm"
           cache-dependency-path: package-lock.json
       - name: Install
@@ -32,5 +41,7 @@ jobs:
       - name: Release
         run: npm run release
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          GITHUB_TOKEN: ${{ secrets.RELEASE_PAT }}
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+      - name: Test Run
+        run: |
+          npm publish --access public

package/.github/workflows/test-flow.yaml

@@ -18,15 +18,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
+        node-version: [20.x, 22.x, 24.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       # TODO: caching this action would accelerate the run
       - name: corepack
         run: |
           corepack enable
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
           cache: "npm"

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+## [2.0.4](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.0.3...v2.0.4) (2026-02-05)
+
+
+### Bug Fixes
+
+* leave semantic release out of npm publish ([9c0d9a3](https://github.com/HanseltimeIndustries/template-repo-sync/commit/9c0d9a389faf34c944640a5a3fc153b038e61b1d))
+
+## [2.0.3](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.0.2...v2.0.3) (2026-02-05)
+
+
+### Bug Fixes
+
+* trigger a new release ([807e84f](https://github.com/HanseltimeIndustries/template-repo-sync/commit/807e84f51eaca42a2607cfbb57d2d672fb84a511))
+
+## [2.0.2](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.0.1...v2.0.2) (2026-02-04)
+
+
+### Bug Fixes
+
+* triger another release due to npm issues ([b6bc9ac](https://github.com/HanseltimeIndustries/template-repo-sync/commit/b6bc9ace83165906707a95ee3aa3a89082cf4d4c))
+
+## [2.0.1](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.0.0...v2.0.1) (2026-02-04)
+
+
+### Bug Fixes
+
+* trigger new release ([8a60867](https://github.com/HanseltimeIndustries/template-repo-sync/commit/8a60867539b35222e5074cfccab716f01c8d613d))
+
+# [2.0.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.3.1...v2.0.0) (2026-02-04)
+
+
+### Features
+
+* switch to multiple plugins and globs for merge config ([d419c90](https://github.com/HanseltimeIndustries/template-repo-sync/commit/d419c90b1f5e4fc9c8e8b973f1a43bb709267a4a))
+
+
+### BREAKING CHANGES
+
+* The merge field of config is is now an array of plugin configs instead of a map with a single extension
+
 ## [1.3.1](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.3.0...v1.3.1) (2024-06-09)
 
 

package/README.md

@@ -13,15 +13,17 @@ best practice development patterns, then we naturally want to have a way to allo
 changes, while also having control over things that may be specifically changed due to their need to support something beyond the
 orgnaization standard.
 
+<!-- Created with Markdown All In One VsCode Entension, rerun to update -->
+
 - [Template Sync](#template-sync)
 - [How to use this](#how-to-use-this)
   - [Config file](#config-file)
     - [File format](#file-format)
     - [Example 1 - Using a custom plugin](#example-1---using-a-custom-plugin)
     - [Example 2 - Using a custom plugin for some paths](#example-2---using-a-custom-plugin-for-some-paths)
+    - [Example 3 - First Rule precedence](#example-3---first-rule-precedence)
   - [From SHA/Tag directive](#from-shatag-directive)
   - [Programmatic API](#programmatic-api)
-  <!-- Created with Markdown All In One VsCode Entension, rerun to update -->
 
 # How to use this
 
@@ -33,7 +35,7 @@ for those who would like to implement the same calls in another CI/CD structure.
 There are two types of config files that you can create:
 
 - `templatesync.config` in the template repo (this is for the template maintainer to specify how they would expect a roll out
-  to update and for them to exclude anything that is more of an example than a standard (for instance, a hellow world placeholder))
+  to update and for them to exclude anything that is more of an example than a standard (for instance, a hello world placeholder))
 
 - `templatesync.local.config` in the repo that cloned the template. This is meant for the repo maintainers to have the ability to avoid
   or customize updates between the template repo in the event that they have deviated purposefully from it.
@@ -57,21 +59,31 @@ export interface Config {
   /**
    * If there is no merge config, then we will always just overwrite the file for the diff
    */
-  merge: {
+  merge: [
     /**
-     * .json file merge overrides.  Keep in mind,
+     * The first merge rule that matches a file will be applied.
      */
-    ".json": {
-      // You can add a merge plugin for extensions that we don't natively support
-      mergePlugin: string;
+    {
+      /**
+       * A string or list of strings that would be used by micromatch
+       * against the file paths
+       */
+      glob: string | string[];
       /**
-       * A list of file globs for json files that can have custom rules applied
+       * This could be a built-in merge plugin from this library
+       *  i.e. "_json"
        *
-       * The first matching glob will be applied so make sure to put your defaults last
+       * It can also be an npm package or a path to a local file with
+       * a merge plugin that matches the interface
+       */
+      plugin: string;
+      /**
+       * This is an object of options that correspond to the plugin
+       * you specified
        */
-      [fileGlobs: string]: JsonFileMerge;
-    }[];
-  };
+      options: any;
+    },
+  ];
 }
 ```
 
@@ -83,14 +95,15 @@ in the local repo will be merged using the plugin we specified.
 
 ```typescript
 {
-
-    merge: {
-        ".ini": {
-            // If you are running under pacakge manager like yarn or npm,
-            // you can provide a valid pacakge or .js fil from your package to run
-            plugin: 'my-installed-npm-package',
-        }
-    }
+  merge: [
+    {
+      // For all .ini packages
+      glob: "**/*.ini",
+      // If you are running under package manager like yarn or npm,
+      // you can provide a valid pacakge or .js fil from your package to run
+      plugin: "my-installed-npm-package",
+    },
+  ];
 }
 ```
 
@@ -102,25 +115,52 @@ files, only the ones in custom-configs/ will use this merge operator.
 
 ```typescript
 {
+  merge: [
+    {
+      // For all .ini packages
+      glob: "custom-configs/**",
+      // If you are running under package manager like yarn or npm,
+      // you can provide a valid pacakge or .js fil from your package to run
+      plugin: "my-installed-npm-package",
+      options: {
+        myPluginParam: "some parameter",
+      },
+    },
+  ];
+}
+```
 
-    merge: {
-        ".ini": {
-            // If you are running under pacakge manager like yarn or npm,
-            // you can provide a valid pacakge or .js fil from your package to run
-            plugin: 'my-installed-npm-package',
-            rule: [
-                {
-                    glob: 'custom-configs/**',
-                    options: {
-                        myPluginParam: 'some parameter',
-                    }
-                }
-            ]
-        }
-    }
+### Example 3 - First Rule precedence
+
+If you have multiple merge rules that would match a file. The first and only the first rule that matches will be applied.
+
+```typescript
+{
+  merge: [
+    {
+      // For all .ini packages
+      glob: "custom-configs/**",
+      // If you are running under package manager like yarn or npm,
+      // you can provide a valid pacakge or .js fil from your package to run
+      plugin: "my-installed-npm-package",
+      options: {
+        myPluginParam: "some parameter",
+      },
+    },
+    {
+      // For all other .ini packages
+      glob: "**/*.ini",
+      // If you are running under package manager like yarn or npm,
+      // you can provide a valid pacakge or .js fil from your package to run
+      plugin: "my-installed-npm-package",
+    },
+  ];
 }
 ```
 
+Note: if you need to do the equivalent of 2 merge plugins for a file, you can use a custom plugin
+that would call both plugins!
+
 ## From SHA/Tag directive
 
 One of the biggest pains of syncing templates is that you can end up seeing a change multiple times because your change has

package/docs/merge-plugins/CURRENT_PLUGINS.md

@@ -1,6 +1,6 @@
 # Current Merge Plugins
 
-This document lists all merge plugins that are provided provided as defaults for certain file extensions.
+This document lists all merge plugins that are provided as defaults for certain file extensions.
 These should be found in the [plugins folder](src/plugins)
 
 - [Current Merge Plugins](#current-merge-plugins)
@@ -17,6 +17,8 @@ These should be found in the [plugins folder](src/plugins)
 
 The json merge plugin allows you to configure jsonpath based merges on any .json file.
 
+Plugin Field Name: `_json`
+
 ## Configuration Options:
 
 ### Simple merge spec
@@ -85,8 +87,6 @@ interface Options {
 
 #### Example
 
-This
-
 ```json
 {
   "merge": {

package/docs/merge-plugins/{DEVELOPMENT.md → PLUGIN_DEVELOPMENT.md}

@@ -1,8 +1,9 @@
 # Plugin Development
 
 - [Plugin Development](#plugin-development)
-  - [Example: hello \<world\>](#example-hello-world) - [Example one: local file](#example-one-local-file) - [Example two: npm package](#example-two-npm-package)
-  <!-- Created with Markdown All In One VsCode Extension -->
+  - [Example: hello \<world\>](#example-hello-world)
+    - [Example one: local file](#example-one-local-file)
+    - [Example two: npm package](#example-two-npm-package)
 
 The templatesync.json and templatesync.local.config files make use of a `"merge"` property where you can
 customize the baseline behavior of ignore or overwrite from template.
@@ -89,19 +90,15 @@ With all of that set up, as long as we have the package available to the pacakge
 
 ```json
 {
-  "merge": {
-    ".txt": {
-      "plugin": "dist/hello-plugin.js", // Note, we make it point to the compiled .js so you will need to build and commit the file
-      "rules": [
-        {
-          "glob": "**/*",
-          "options": {
-            "world": "chad"
-          }
-        }
-      ]
+  "merge": [
+    {
+      "glob": "**/*.txt",
+      "plugin": "dist/hello-plugin.js",
+      "options": {
+        "world": "chad"
+      }
     }
-  }
+  ]
 }
 ```
 
@@ -112,18 +109,14 @@ simply reference the package (assuming that it exposes the required functions as
 
 ```json
 {
-  "merge": {
-    ".txt": {
+  "merge": [
+    {
+      "glob": "**/*.txt",
       "plugin": "@myscope/hello-merge",
-      "rules": [
-        {
-          "glob": "**/*",
-          "options": {
-            "world": "chad"
-          }
-        }
-      ]
+      "options": {
+        "world": "chad"
+      }
     }
-  }
+  ]
 }
 ```

package/docs/merge-plugins/README.md

@@ -26,27 +26,23 @@ set of boilerplate for an npm package, you would probably provide an example pac
 
 In this scenario, we expect the template user to declare their own `name` and `description`, and add their own
 `scripts` and `devDependencies`. However, we are hoping to make sure that the publish method and and its
-our-artifact-package are kept up-to-date on syncs. Because of this, we would make use of the default json merge
-plugin that is built-in with this library:
+our-artifact-package are kept up-to-date on syncs. Because of this, we would make use of the built-in json merge
+plugin `_json` that is provided with this library:
 
 ```json
 {
-  "merge": {
-    ".json": {
-      // This uses the default plugin for json merges
-      "rules": [
-        {
-          "glob": "package.json",
-          "options": {
-            "paths": [
-              ["$.scripts.publish", "merge-template"], // Any changes to publish are so critical that we want them to sync
-              ["$.devDependencies", "merge-template"] // Always ensure dev dependency versions for our scripts are updated
-            ]
-          }
-        }
-      ]
+  "merge": [
+    {
+      "glob": "package.json",
+      "plugin": "_json",
+      "options": {
+        "paths": [
+          ["$.scripts.publish", "merge-template"], // Any changes to publish are so critical that we want them to sync
+          ["$.devDependencies", "merge-template"] // Always ensure dev dependency versions for our scripts are updated
+        ]
+      }
     }
-  }
+  ]
 }
 ```
 
@@ -61,21 +57,15 @@ config file, they can specify their own merge configuration for the package.json
 
 ```json
 {
-  "merge": {
-    ".json": {
-      // This uses the default plugin for json merges
-      "rules": [
-        {
-          "glob": "package.json",
-          "options": {
-            "paths": [
-              ["$.devDependencies", "merge-template"] // Always ensure dev dependency versions for our scripts are updated
-            ]
-          }
-        }
+  "merge": [
+    {
+      "glob": "package.json",
+      "plugin": "_json",
+      "paths": [
+        ["$.devDependencies", "merge-template"] // Always ensure dev dependency versions for our scripts are updated
       ]
     }
-  }
+  ]
 }
 ```
 

package/jest.config.js

@@ -10,7 +10,7 @@ module.exports = {
   collectCoverageFrom: ["./src/**"],
   coverageThreshold: {
     global: {
-      branches: 80,
+      branches: 77,
       functions: 80,
       // Lines can get skewed by bucket files
       statements: 80,

package/lib/cjs/load-plugin.d.ts

@@ -1,2 +1,9 @@
 import { MergeConfig, MergePlugin } from "./types";
-export declare function loadPlugin<T>(mergeConfig: MergeConfig<T>, forExt: string, configDir: string): Promise<MergePlugin<T>>;
+/**
+ * Loads the plugin associated with the merge config
+ * @param mergeConfig
+ * @param forExt
+ * @param configDir
+ * @returns
+ */
+export declare function loadPlugin<T>(mergeConfig: MergeConfig<T>, configDir: string): Promise<MergePlugin<T>>;

package/lib/cjs/load-plugin.js

@@ -27,36 +27,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 Promise.resolve(`${importPath}`).then(s => __importStar(require(s))));
-            }
-            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 Promise.resolve(`${importPath}`).then(s => __importStar(require(s))));
         }
-    }
-    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/cjs/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/cjs/plugins/index.d.ts

@@ -1,4 +1,6 @@
 import { JsonFileMergeOptions, MergePlugin } from "../types";
 export declare const defaultExtensionMap: {
-    [ext: string]: MergePlugin<JsonFileMergeOptions>;
+    [ext: string]: MergePlugin<JsonFileMergeOptions> & {
+        builtinName: string;
+    };
 };

package/lib/cjs/plugins/index.js

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

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