@hanseltime/template-repo-sync 2.1.2 → 2.2.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.2.1](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.2.0...v2.2.1) (2026-02-22)
+
+
+### Bug Fixes
+
+* template sync afterRef updates ([21dd335](https://github.com/HanseltimeIndustries/template-repo-sync/commit/21dd335045034d132ad5f6ab7944a81c82b96981))
+
+# [2.2.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.1.2...v2.2.0) (2026-02-21)
+
+
+### Features
+
+* add modified files output to track actual sync changes ([050ffd0](https://github.com/HanseltimeIndustries/template-repo-sync/commit/050ffd0ff74195943e60fc8dbf4354191959c0be))
+
 ## [2.1.2](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.1.1...v2.1.2) (2026-02-08)
 
 

package/lib/cjs/formatting/sync-results-to-md.js

@@ -21,6 +21,23 @@ ${result.localFileChanges[file].reduce((diffS, 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}`;
+    }, "")}
 `;
 }
 exports.syncResultsToMd = syncResultsToMd;

package/lib/cjs/merge-file.d.ts

@@ -14,7 +14,8 @@ interface MergeFileReturn {
     ignoredDueToLocal: boolean;
     /**
      * Only available if the file wasn't ignored, this is a list of lineDiffs
-     * from the the diff library that were applied to what would've been removed
+     * from the diff library that were applied to what would've been changed by
+     * the base templatesync repo
      */
     localChanges?: Change[];
 }

package/lib/cjs/template-sync.d.ts

@@ -1,6 +1,6 @@
 import { Change } from "diff";
 import { TemplateCloneDriverFn } from "./clone-drivers";
-import { TemplateDiffDriverFn } from "./diff-drivers";
+import { DiffResult, TemplateDiffDriverFn } from "./diff-drivers";
 import { TemplateRefDriverFn } from "./ref-drivers/types";
 import { TemplateCheckoutDriverFn } from "./checkout-drivers";
 export interface TemplateSyncOptions {
@@ -57,6 +57,16 @@ export interface TemplateSyncReturn {
     localFileChanges: {
         [filePath: string]: Change[];
     };
+    /**
+     * A list of all files that are modified by this operation.  You can use total to quickly check if
+     * there was an actual meaningful change.
+     *
+     * Please note, ther may be localSkipfiles and total: 0, which indicates there were changes BUT the local template
+     * sync file rendered them meaningless.
+     */
+    modifiedFiles: DiffResult & {
+        total: number;
+    };
 }
 export declare const TEMPLATE_SYNC_CONFIG = "templatesync";
 export declare const TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";

package/lib/cjs/template-sync.js

@@ -61,12 +61,29 @@ async function templateSync(options) {
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)
         ? commentJSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
         : { ignore: [] };
-    const localConfigPath = (0, path_1.join)(options.repoDir, `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`);
+    const localConfigFile = `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`;
+    const localConfigPath = (0, path_1.join)(options.repoDir, localConfigFile);
     const localTemplateSyncConfig = (0, fs_1.existsSync)(localConfigPath)
         ? commentJSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
         : { ignore: [] };
     let filesToSync;
+    const ref = await currentRefDriver({
+        rootDir: tempCloneDir,
+    });
     if (localTemplateSyncConfig.afterRef) {
+        if (ref === localTemplateSyncConfig.afterRef) {
+            // short circuit if the refs match
+            return {
+                localSkipFiles: [],
+                localFileChanges: {},
+                modifiedFiles: {
+                    added: [],
+                    modified: [],
+                    deleted: [],
+                    total: 0,
+                },
+            };
+        }
         filesToSync = await diffDriver(tempCloneDir, localTemplateSyncConfig.afterRef);
     }
     else {
@@ -83,7 +100,7 @@ async function templateSync(options) {
     filesToSync.added = filesToSync.added.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
     filesToSync.modified = filesToSync.modified.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
     filesToSync.deleted = filesToSync.deleted.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
-    const localSkipFiles = [];
+    const localSkipFiles = new Set();
     const localFileChanges = {};
     const fileSyncFactory = (op) => {
         return async (f) => {
@@ -95,7 +112,7 @@ async function templateSync(options) {
                 fileOperation: op,
             });
             if (result.ignoredDueToLocal) {
-                localSkipFiles.push(f);
+                localSkipFiles.add(f);
             }
             else if (result?.localChanges && result.localChanges.length > 0) {
                 localFileChanges[f] = result.localChanges;
@@ -106,6 +123,15 @@ async function templateSync(options) {
     await Promise.all(filesToSync.added.map(fileSyncFactory("added")));
     await Promise.all(filesToSync.modified.map(fileSyncFactory("modified")));
     await Promise.all(filesToSync.deleted.map(fileSyncFactory("deleted")));
+    // Report the files that changed in general
+    const actualAdded = filesToSync.added.filter((f) => !localSkipFiles.has(f));
+    const actualModified = filesToSync.modified.filter((f) => !localSkipFiles.has(f));
+    const actualDeleted = filesToSync.deleted.filter((f) => !localSkipFiles.has(f));
+    const modifiedFiles = {
+        added: actualAdded,
+        modified: actualModified,
+        deleted: actualDeleted,
+    };
     // apply after ref
     if (options.updateAfterRef) {
         const ref = await currentRefDriver({
@@ -116,14 +142,22 @@ async function templateSync(options) {
             const config = commentJSON.parse(configStr);
             config.afterRef = ref;
             (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+            modifiedFiles.modified.push(localConfigFile);
         }
         else {
             (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify({ afterRef: ref }, null, 4));
+            modifiedFiles.added.push(localConfigFile);
         }
     }
     return {
-        localSkipFiles,
+        localSkipFiles: Array.from(localSkipFiles),
         localFileChanges,
+        modifiedFiles: {
+            ...modifiedFiles,
+            total: modifiedFiles.added.length +
+                modifiedFiles.deleted.length +
+                modifiedFiles.modified.length,
+        },
     };
 }
 exports.templateSync = templateSync;

package/lib/esm/formatting/sync-results-to-md.js

@@ -21,6 +21,23 @@ ${result.localFileChanges[file].reduce((diffS, 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}`;
+    }, "")}
 `;
 }
 exports.syncResultsToMd = syncResultsToMd;

package/lib/esm/template-sync.js

@@ -61,12 +61,29 @@ async function templateSync(options) {
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)
         ? commentJSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
         : { ignore: [] };
-    const localConfigPath = (0, path_1.join)(options.repoDir, `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`);
+    const localConfigFile = `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`;
+    const localConfigPath = (0, path_1.join)(options.repoDir, localConfigFile);
     const localTemplateSyncConfig = (0, fs_1.existsSync)(localConfigPath)
         ? commentJSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
         : { ignore: [] };
     let filesToSync;
+    const ref = await currentRefDriver({
+        rootDir: tempCloneDir,
+    });
     if (localTemplateSyncConfig.afterRef) {
+        if (ref === localTemplateSyncConfig.afterRef) {
+            // short circuit if the refs match
+            return {
+                localSkipFiles: [],
+                localFileChanges: {},
+                modifiedFiles: {
+                    added: [],
+                    modified: [],
+                    deleted: [],
+                    total: 0,
+                },
+            };
+        }
         filesToSync = await diffDriver(tempCloneDir, localTemplateSyncConfig.afterRef);
     }
     else {
@@ -83,7 +100,7 @@ async function templateSync(options) {
     filesToSync.added = filesToSync.added.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
     filesToSync.modified = filesToSync.modified.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
     filesToSync.deleted = filesToSync.deleted.filter((f) => !(0, micromatch_1.some)(f, templateSyncConfig.ignore));
-    const localSkipFiles = [];
+    const localSkipFiles = new Set();
     const localFileChanges = {};
     const fileSyncFactory = (op) => {
         return async (f) => {
@@ -95,7 +112,7 @@ async function templateSync(options) {
                 fileOperation: op,
             });
             if (result.ignoredDueToLocal) {
-                localSkipFiles.push(f);
+                localSkipFiles.add(f);
             }
             else if (result?.localChanges && result.localChanges.length > 0) {
                 localFileChanges[f] = result.localChanges;
@@ -106,6 +123,15 @@ async function templateSync(options) {
     await Promise.all(filesToSync.added.map(fileSyncFactory("added")));
     await Promise.all(filesToSync.modified.map(fileSyncFactory("modified")));
     await Promise.all(filesToSync.deleted.map(fileSyncFactory("deleted")));
+    // Report the files that changed in general
+    const actualAdded = filesToSync.added.filter((f) => !localSkipFiles.has(f));
+    const actualModified = filesToSync.modified.filter((f) => !localSkipFiles.has(f));
+    const actualDeleted = filesToSync.deleted.filter((f) => !localSkipFiles.has(f));
+    const modifiedFiles = {
+        added: actualAdded,
+        modified: actualModified,
+        deleted: actualDeleted,
+    };
     // apply after ref
     if (options.updateAfterRef) {
         const ref = await currentRefDriver({
@@ -116,14 +142,22 @@ async function templateSync(options) {
             const config = commentJSON.parse(configStr);
             config.afterRef = ref;
             (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+            modifiedFiles.modified.push(localConfigFile);
         }
         else {
             (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify({ afterRef: ref }, null, 4));
+            modifiedFiles.added.push(localConfigFile);
         }
     }
     return {
-        localSkipFiles,
+        localSkipFiles: Array.from(localSkipFiles),
         localFileChanges,
+        modifiedFiles: {
+            ...modifiedFiles,
+            total: modifiedFiles.added.length +
+                modifiedFiles.deleted.length +
+                modifiedFiles.modified.length,
+        },
     };
 }
 exports.templateSync = templateSync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hanseltime/template-repo-sync",
-  "version": "2.1.2",
+  "version": "2.2.1",
   "description": "An npm library that enables pluggable, customizable synchronization between template repos",
   "main": "lib/cjs/index.js",
   "types": "lib/cjs/index.d.ts",

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

@@ -18,5 +18,22 @@ package.json
 -your thang
 
 \`\`\`
+
+## Files Modified (6)
+
+Added:
+
+- src/something.ts
+- new_settings.toml
+
+Modified:
+
+- something.txt
+- .env
+
+Deleted:
+
+- TODO.md
+- throwaway.ts
 "
 `;

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

@@ -19,6 +19,12 @@ describe("syncResultsToMd", () => {
             },
           ],
         },
+        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

@@ -23,6 +23,23 @@ ${result.localFileChanges[file].reduce((diffS, 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}`;
+}, "")}
 `;
 }
 

package/src/merge-file.ts

@@ -22,7 +22,8 @@ interface MergeFileReturn {
   ignoredDueToLocal: boolean;
   /**
    * Only available if the file wasn't ignored, this is a list of lineDiffs
-   * from the the diff library that were applied to what would've been removed
+   * from the diff library that were applied to what would've been changed by
+   * the base templatesync repo
    */
   localChanges?: Change[];
 }

package/src/template-sync.spec.ts

@@ -44,6 +44,18 @@ describe("templateSync", () => {
       // Expect no changes since there was no local sync file
       localSkipFiles: [],
       localFileChanges: {},
+      modifiedFiles: {
+        added: [
+          "package.json",
+          "src/index.js",
+          "src/templated.js",
+          "src/templated.ts",
+          "templatesync.json",
+        ],
+        deleted: [],
+        modified: [],
+        total: 5,
+      },
     });
 
     // Verify the files
@@ -72,6 +84,18 @@ describe("templateSync", () => {
       // Expect no changes since there was no local sync file
       localSkipFiles: [],
       localFileChanges: {},
+      modifiedFiles: {
+        added: [
+          "package.json",
+          "src/index.js",
+          "src/templated.js",
+          "src/templated.ts",
+          "templatesync.json",
+        ],
+        deleted: [],
+        modified: [],
+        total: 5,
+      },
     });
 
     // Verify the files
@@ -175,6 +199,18 @@ describe("templateSync", () => {
         "package.json": expect.arrayContaining([]),
       }),
     );
+    // Make sure the result captures the changes
+    expect(result.modifiedFiles).toEqual({
+      added: [
+        "package.json",
+        "src/index.js",
+        "src/templated.js",
+        "templatesync.json",
+      ],
+      deleted: [],
+      modified: [],
+      total: 4,
+    });
 
     // Verify the files
     await fileMatchTemplate(tmpDir, "templatesync.json");
@@ -256,7 +292,7 @@ describe("templateSync", () => {
     // We will only update the templated.ts
     const mockDiffDriver = jest.fn().mockImplementation(async () => ({
       added: ["src/templated.ts"],
-      modified: ["src/index.ts"], // Add index.ts so we make sure it is still ignored - due to a bug
+      modified: ["src/index.ts"], // Add index.ts so we make sure it is still ignored - see test-fixtures/template/templatesync.json ignores
       deleted: [],
     }));
     const mockCurrentRefDriver = jest
@@ -273,8 +309,14 @@ describe("templateSync", () => {
       checkoutDriver: dummyCheckoutDriver,
     });
 
-    // since there was no override for this file, not changes from the local file
+    // since there was no override for this file, no changes from the local file
     expect(result.localFileChanges).toEqual(expect.objectContaining({}));
+    expect(result.modifiedFiles).toEqual({
+      added: ["src/templated.ts"],
+      modified: ["templatesync.local.json"], // Add index.ts so we make sure it is still ignored - due to a bug
+      deleted: [],
+      total: 2,
+    });
 
     // Verify the files
     await fileMatchTemplate(tmpDir, "templatesync.json");
@@ -296,6 +338,73 @@ describe("templateSync", () => {
     });
     expect(dummyCheckoutDriver).not.toHaveBeenCalled();
   });
+  it("Does not update the local templatesync if updateAfterRef is true and the ref is the same", async () => {
+    // Remove the local sync overrides
+    await rm(join(tmpDir, "templatesync.local.json"));
+
+    const mockLocalConfig = {
+      afterRef: "dummySha",
+      ignore: [
+        // We don't have a need for this in here, but it's an example of keeping things cleaner for our custom plugins
+        "plugins/**",
+      ],
+    };
+
+    writeFileSync(
+      join(tmpDir, "templatesync.local.json"),
+      JSON.stringify(mockLocalConfig),
+    );
+
+    // We will only update the templated.ts
+    const mockDiffDriver = jest.fn().mockImplementation(async () => ({
+      added: ["src/templated.ts"],
+      modified: ["src/index.ts"], // Add index.ts so we make sure it is still ignored - see test-fixtures/template/templatesync.json ignores
+      deleted: [],
+    }));
+    const mockCurrentRefDriver = jest
+      .fn()
+      .mockImplementation(async () => "dummySha");
+    const result = await templateSync({
+      tmpCloneDir: "stubbed-by-driver",
+      cloneDriver: dummyCloneDriver,
+      repoUrl: "not-important",
+      repoDir: tmpDir,
+      updateAfterRef: true,
+      diffDriver: mockDiffDriver,
+      currentRefDriver: mockCurrentRefDriver,
+      checkoutDriver: dummyCheckoutDriver,
+    });
+
+    // Nothing shoudl be reported as changing
+    expect(result).toEqual({
+      localFileChanges: {},
+      localSkipFiles: [],
+      modifiedFiles: {
+        added: [],
+        modified: [],
+        deleted: [],
+        total: 0,
+      },
+    });
+    // Verify the files
+    await fileMatchDownstream(tmpDir, "templatesync.json");
+    await fileMatchDownstream(tmpDir, "src/templated.ts");
+
+    // Expect the none of the diff files to work
+    await fileMatchDownstream(tmpDir, "src/index.ts");
+    await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
+    await fileMatchDownstream(tmpDir, "package.json");
+
+    // Ensure we have updated the local template field
+    expect(
+      JSON.parse(
+        (await readFile(join(tmpDir, "templatesync.local.json"))).toString(),
+      ),
+    ).toEqual({
+      ...mockLocalConfig,
+    });
+    expect(dummyCheckoutDriver).not.toHaveBeenCalled();
+  });
   it("creates the local templatesync with the current ref if updateAfterRef is true and no local template exists", async () => {
     // Remove the local sync overrides
     await rm(join(tmpDir, "templatesync.local.json"));
@@ -318,8 +427,21 @@ describe("templateSync", () => {
       checkoutDriver: dummyCheckoutDriver,
     });
 
-    // since there was no override for this file, not changes from the local file
+    // since there was no override for this file, no changes from the local file
     expect(result.localFileChanges).toEqual(expect.objectContaining({}));
+    expect(result.modifiedFiles).toEqual({
+      added: [
+        "package.json",
+        "src/index.js",
+        "src/templated.js",
+        "src/templated.ts",
+        "templatesync.json",
+        "templatesync.local.json",
+      ],
+      deleted: [],
+      modified: [],
+      total: 6,
+    });
 
     // Verify the files
     await fileMatchTemplate(tmpDir, "templatesync.json");

package/src/template-sync.ts

@@ -77,6 +77,16 @@ export interface TemplateSyncReturn {
   localFileChanges: {
     [filePath: string]: Change[];
   };
+  /**
+   * A list of all files that are modified by this operation.  You can use total to quickly check if
+   * there was an actual meaningful change.
+   *
+   * Please note, ther may be localSkipfiles and total: 0, which indicates there were changes BUT the local template
+   * sync file rendered them meaningless.
+   */
+  modifiedFiles: DiffResult & {
+    total: number;
+  };
 }
 
 export const TEMPLATE_SYNC_CONFIG = "templatesync";
@@ -115,10 +125,8 @@ export async function templateSync(
       ) as unknown as Config)
     : { ignore: [] };
 
-  const localConfigPath = join(
-    options.repoDir,
-    `${TEMPLATE_SYNC_LOCAL_CONFIG}.json`,
-  );
+  const localConfigFile = `${TEMPLATE_SYNC_LOCAL_CONFIG}.json`;
+  const localConfigPath = join(options.repoDir, localConfigFile);
   const localTemplateSyncConfig: LocalConfig = existsSync(localConfigPath)
     ? (commentJSON.parse(
         readFileSync(localConfigPath).toString(),
@@ -126,7 +134,23 @@ export async function templateSync(
     : { ignore: [] };
 
   let filesToSync: DiffResult;
+  const ref = await currentRefDriver({
+    rootDir: tempCloneDir,
+  });
   if (localTemplateSyncConfig.afterRef) {
+    if (ref === localTemplateSyncConfig.afterRef) {
+      // short circuit if the refs match
+      return {
+        localSkipFiles: [],
+        localFileChanges: {},
+        modifiedFiles: {
+          added: [],
+          modified: [],
+          deleted: [],
+          total: 0,
+        },
+      };
+    }
     filesToSync = await diffDriver(
       tempCloneDir,
       localTemplateSyncConfig.afterRef,
@@ -153,7 +177,7 @@ export async function templateSync(
     (f) => !some(f, templateSyncConfig.ignore),
   );
 
-  const localSkipFiles: string[] = [];
+  const localSkipFiles: Set<string> = new Set();
   const localFileChanges: {
     [filePath: string]: Change[];
   } = {};
@@ -168,7 +192,7 @@ export async function templateSync(
         fileOperation: op,
       });
       if (result.ignoredDueToLocal) {
-        localSkipFiles.push(f);
+        localSkipFiles.add(f);
       } else if (result?.localChanges && result.localChanges.length > 0) {
         localFileChanges[f] = result.localChanges;
       }
@@ -180,6 +204,20 @@ export async function templateSync(
   await Promise.all(filesToSync.modified.map(fileSyncFactory("modified")));
   await Promise.all(filesToSync.deleted.map(fileSyncFactory("deleted")));
 
+  // Report the files that changed in general
+  const actualAdded = filesToSync.added.filter((f) => !localSkipFiles.has(f));
+  const actualModified = filesToSync.modified.filter(
+    (f) => !localSkipFiles.has(f),
+  );
+  const actualDeleted = filesToSync.deleted.filter(
+    (f) => !localSkipFiles.has(f),
+  );
+  const modifiedFiles = {
+    added: actualAdded,
+    modified: actualModified,
+    deleted: actualDeleted,
+  };
+
   // apply after ref
   if (options.updateAfterRef) {
     const ref = await currentRefDriver({
@@ -194,16 +232,25 @@ export async function templateSync(
         localConfigPath,
         commentJSON.stringify(config, null, inferJSONIndent(configStr)),
       );
+      modifiedFiles.modified.push(localConfigFile);
     } else {
       writeFileSync(
         localConfigPath,
         commentJSON.stringify({ afterRef: ref }, null, 4),
       );
+      modifiedFiles.added.push(localConfigFile);
     }
   }
 
   return {
-    localSkipFiles,
+    localSkipFiles: Array.from(localSkipFiles),
     localFileChanges,
+    modifiedFiles: {
+      ...modifiedFiles,
+      total:
+        modifiedFiles.added.length +
+        modifiedFiles.deleted.length +
+        modifiedFiles.modified.length,
+    },
   };
 }