@hanseltime/template-repo-sync 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.3.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v2.2.1...v2.3.0) (2026-03-04)
+
+
+### Features
+
+* actually run plugin validate commands before mergin ([216ebbb](https://github.com/HanseltimeIndustries/template-repo-sync/commit/216ebbbf21f71f4480905fde336fbc0631b6aa7b))
+
+## [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)
 
 

package/lib/cjs/template-sync.js

@@ -35,6 +35,7 @@ const formatting_1 = require("./formatting");
 const commentJSON = __importStar(require("comment-json"));
 const checkout_drivers_1 = require("./checkout-drivers");
 const micromatch_1 = require("micromatch");
+const load_plugin_1 = require("./load-plugin");
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
@@ -61,12 +62,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 {
@@ -79,6 +97,46 @@ async function templateSync(options) {
             modified: [],
         };
     }
+    // Pre-load plugins and make sure the sync file is respected
+    // Synchronous since grpc servers take a second
+    const localValidateErrors = {};
+    const validateErrors = {};
+    for (const config of localTemplateSyncConfig.merge ?? []) {
+        const plugin = await (0, load_plugin_1.loadPlugin)(config, options.repoDir);
+        const errors = plugin.validate(config.options ?? {});
+        if (errors && errors.length > 0) {
+            localValidateErrors[config.plugin] = errors;
+        }
+    }
+    for (const config of templateSyncConfig.merge ?? []) {
+        const plugin = await (0, load_plugin_1.loadPlugin)(config, tempCloneDir);
+        const errors = plugin.validate(config.options ?? {});
+        if (errors && errors.length > 0) {
+            validateErrors[config.plugin] = errors;
+        }
+    }
+    let errorStr = "";
+    if (Object.keys(validateErrors).length > 0) {
+        errorStr = `${errorStr}templatesync.json plugin option errors:\n`;
+        for (const plugin in validateErrors) {
+            errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+            validateErrors[plugin].forEach((err) => {
+                errorStr = `${errorStr}\t\t${err}\n`;
+            });
+        }
+    }
+    if (Object.keys(localValidateErrors).length > 0) {
+        errorStr = `${errorStr}templatesync.local.json plugin option errors:\n`;
+        for (const plugin in localValidateErrors) {
+            errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+            localValidateErrors[plugin].forEach((err) => {
+                errorStr = `${errorStr}\t\t${err}\n`;
+            });
+        }
+    }
+    if (errorStr !== "") {
+        throw Error(errorStr);
+    }
     // Apply ignore filters
     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));
@@ -114,7 +172,6 @@ async function templateSync(options) {
         added: actualAdded,
         modified: actualModified,
         deleted: actualDeleted,
-        total: actualAdded.length + actualModified.length + actualDeleted.length,
     };
     // apply after ref
     if (options.updateAfterRef) {
@@ -126,15 +183,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: Array.from(localSkipFiles),
         localFileChanges,
-        modifiedFiles: modifiedFiles,
+        modifiedFiles: {
+            ...modifiedFiles,
+            total: modifiedFiles.added.length +
+                modifiedFiles.deleted.length +
+                modifiedFiles.modified.length,
+        },
     };
 }
 exports.templateSync = templateSync;

package/lib/esm/template-sync.js

@@ -35,6 +35,7 @@ const formatting_1 = require("./formatting");
 const commentJSON = __importStar(require("comment-json"));
 const checkout_drivers_1 = require("./checkout-drivers");
 const micromatch_1 = require("micromatch");
+const load_plugin_1 = require("./load-plugin");
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
@@ -61,12 +62,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 {
@@ -79,6 +97,46 @@ async function templateSync(options) {
             modified: [],
         };
     }
+    // Pre-load plugins and make sure the sync file is respected
+    // Synchronous since grpc servers take a second
+    const localValidateErrors = {};
+    const validateErrors = {};
+    for (const config of localTemplateSyncConfig.merge ?? []) {
+        const plugin = await (0, load_plugin_1.loadPlugin)(config, options.repoDir);
+        const errors = plugin.validate(config.options ?? {});
+        if (errors && errors.length > 0) {
+            localValidateErrors[config.plugin] = errors;
+        }
+    }
+    for (const config of templateSyncConfig.merge ?? []) {
+        const plugin = await (0, load_plugin_1.loadPlugin)(config, tempCloneDir);
+        const errors = plugin.validate(config.options ?? {});
+        if (errors && errors.length > 0) {
+            validateErrors[config.plugin] = errors;
+        }
+    }
+    let errorStr = "";
+    if (Object.keys(validateErrors).length > 0) {
+        errorStr = `${errorStr}templatesync.json plugin option errors:\n`;
+        for (const plugin in validateErrors) {
+            errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+            validateErrors[plugin].forEach((err) => {
+                errorStr = `${errorStr}\t\t${err}\n`;
+            });
+        }
+    }
+    if (Object.keys(localValidateErrors).length > 0) {
+        errorStr = `${errorStr}templatesync.local.json plugin option errors:\n`;
+        for (const plugin in localValidateErrors) {
+            errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+            localValidateErrors[plugin].forEach((err) => {
+                errorStr = `${errorStr}\t\t${err}\n`;
+            });
+        }
+    }
+    if (errorStr !== "") {
+        throw Error(errorStr);
+    }
     // Apply ignore filters
     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));
@@ -114,7 +172,6 @@ async function templateSync(options) {
         added: actualAdded,
         modified: actualModified,
         deleted: actualDeleted,
-        total: actualAdded.length + actualModified.length + actualDeleted.length,
     };
     // apply after ref
     if (options.updateAfterRef) {
@@ -126,15 +183,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: Array.from(localSkipFiles),
         localFileChanges,
-        modifiedFiles: modifiedFiles,
+        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.2.0",
+  "version": "2.3.0",
   "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/template-sync.spec.ts

@@ -5,24 +5,27 @@ import { tempDir, TEST_FIXTURES_DIR } from "./test-utils";
 import { join, resolve } from "path";
 import { existsSync, readFileSync, writeFileSync } from "fs";
 
-// Just return the test-fixture directory
-const dummyCloneDriver = async () => {
-  return {
-    dir: resolve(TEST_FIXTURES_DIR, "template"),
-    remoteName: "ourRemote",
-  };
-};
-
 const dummyCheckoutDriver = jest.fn();
+const dummyCurrentRefDriver = jest.fn();
 
 const downstreamDir = resolve(TEST_FIXTURES_DIR, "downstream");
 
 describe("templateSync", () => {
   let tmpDir: string;
+  let templateDir: string;
+  let dummyCloneDriver: () => Promise<{ dir: string; remoteName: string }>;
   beforeEach(async () => {
     jest.resetAllMocks();
     tmpDir = await mkdtemp(tempDir());
+    templateDir = await mkdtemp(tempDir());
+    await copy(resolve(TEST_FIXTURES_DIR, "template"), templateDir);
     await copy(downstreamDir, tmpDir);
+    dummyCloneDriver = async () => {
+      return {
+        dir: templateDir,
+        remoteName: "ourRemote",
+      };
+    };
   });
   afterEach(async () => {
     await rm(tmpDir, {
@@ -30,6 +33,93 @@ describe("templateSync", () => {
       recursive: true,
     });
   });
+  // Note: for this test, we expect actions and users to handle misconfigured template syncs
+  it.each([
+    [
+      "local",
+      `templatesync.local.json plugin option errors:
+\tPlugin (plugins/fail-validate-plugin.js):
+\t\toh no!
+\t\tnot this one too!
+`,
+    ],
+    [
+      "template",
+      `templatesync.json plugin option errors:
+\tPlugin (dummy-fail-plugin.js):
+\t\tshucks
+\t\tno good
+`,
+    ],
+    [
+      "both",
+      `templatesync.json plugin option errors:
+\tPlugin (dummy-fail-plugin.js):
+\t\tshucks
+\t\tno good
+templatesync.local.json plugin option errors:
+\tPlugin (plugins/fail-validate-plugin.js):
+\t\toh no!
+\t\tnot this one too!
+`,
+    ],
+  ])("throws errors from plugin validation", async (mode, expected) => {
+    // Remove the local sync overrides
+    await rm(join(tmpDir, "templatesync.local.json"));
+
+    if (mode === "local" || mode == "both") {
+      writeFileSync(
+        join(tmpDir, "templatesync.local.json"),
+        JSON.stringify({
+          ignore: [
+            // Ignores the templated.ts
+            "**/*.ts",
+            // We don't have a need for this in here, but it's an example of keeping things cleaner for our custom plugins
+            "plugins/**",
+          ],
+          merge: [
+            {
+              glob: "package.json",
+              plugin: "plugins/fail-validate-plugin.js",
+              options: {},
+            },
+          ],
+        }),
+      );
+    }
+    if (mode === "template" || mode === "both") {
+      writeFileSync(
+        join(templateDir, "templatesync.json"),
+        JSON.stringify({
+          ignore: [
+            // Ignores the templated.ts
+            "**/*.ts",
+            // We don't have a need for this in here, but it's an example of keeping things cleaner for our custom plugins
+            "plugins/**",
+          ],
+          merge: [
+            {
+              glob: "package.json",
+              plugin: "dummy-fail-plugin.js",
+              options: {},
+            },
+          ],
+        }),
+      );
+    }
+
+    await expect(
+      async () =>
+        await templateSync({
+          tmpCloneDir: "stubbed-by-driver",
+          cloneDriver: dummyCloneDriver,
+          repoUrl: "not-important",
+          repoDir: tmpDir,
+          checkoutDriver: dummyCheckoutDriver,
+          currentRefDriver: dummyCurrentRefDriver,
+        }),
+    ).rejects.toThrow(expected);
+  });
   it("appropriately merges according to just the templatesync config file into an empty dir", async () => {
     const emptyTmpDir = await mkdtemp(tempDir());
     expect(
@@ -39,6 +129,7 @@ describe("templateSync", () => {
         repoUrl: "not-important",
         repoDir: emptyTmpDir,
         checkoutDriver: dummyCheckoutDriver,
+        currentRefDriver: dummyCurrentRefDriver,
       }),
     ).toEqual({
       // Expect no changes since there was no local sync file
@@ -79,6 +170,7 @@ describe("templateSync", () => {
         repoDir: emptyTmpDir,
         branch: "new-template-test",
         checkoutDriver: dummyCheckoutDriver,
+        currentRefDriver: dummyCurrentRefDriver,
       }),
     ).toEqual({
       // Expect no changes since there was no local sync file
@@ -123,6 +215,7 @@ describe("templateSync", () => {
       repoUrl: "not-important",
       repoDir: tmpDir,
       checkoutDriver: dummyCheckoutDriver,
+      currentRefDriver: dummyCurrentRefDriver,
     });
 
     expect(result.localSkipFiles).toEqual([]);
@@ -190,6 +283,7 @@ describe("templateSync", () => {
       repoUrl: "not-important",
       repoDir: tmpDir,
       checkoutDriver: dummyCheckoutDriver,
+      currentRefDriver: dummyCurrentRefDriver,
     });
 
     expect(result.localSkipFiles).toEqual(["src/templated.ts"]);
@@ -256,6 +350,7 @@ describe("templateSync", () => {
       repoUrl: "not-important",
       repoDir: tmpDir,
       diffDriver: mockDiffDriver,
+      currentRefDriver: dummyCurrentRefDriver,
       checkoutDriver: dummyCheckoutDriver,
     });
 
@@ -292,7 +387,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
@@ -311,6 +406,12 @@ describe("templateSync", () => {
 
     // 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");
@@ -332,6 +433,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"));
@@ -356,6 +524,19 @@ describe("templateSync", () => {
 
     // 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");
@@ -398,26 +579,24 @@ describe("templateSync", () => {
       afterRef: "newestSha",
     });
   });
-  expect(dummyCheckoutDriver).not.toHaveBeenCalled();
+  // helper
+  async function fileMatchTemplate(tmpDir: string, relPath: string) {
+    return fileMatch(tmpDir, relPath, "template");
+  }
+
+  async function fileMatchDownstream(tmpDir: string, relPath: string) {
+    return fileMatch(tmpDir, relPath, "downstream");
+  }
+
+  async function fileMatch(
+    tmpDir: string,
+    relPath: string,
+    source: "downstream" | "template",
+  ) {
+    const dir =
+      source === "downstream" ? downstreamDir : (await dummyCloneDriver()).dir;
+    expect((await readFile(resolve(tmpDir, relPath))).toString()).toEqual(
+      (await readFile(resolve(dir, relPath))).toString(),
+    );
+  }
 });
-
-// helper
-async function fileMatchTemplate(tmpDir: string, relPath: string) {
-  return fileMatch(tmpDir, relPath, "template");
-}
-
-async function fileMatchDownstream(tmpDir: string, relPath: string) {
-  return fileMatch(tmpDir, relPath, "downstream");
-}
-
-async function fileMatch(
-  tmpDir: string,
-  relPath: string,
-  source: "downstream" | "template",
-) {
-  const dir =
-    source === "downstream" ? downstreamDir : (await dummyCloneDriver()).dir;
-  expect((await readFile(resolve(tmpDir, relPath))).toString()).toEqual(
-    (await readFile(resolve(dir, relPath))).toString(),
-  );
-}

package/src/template-sync.ts

@@ -13,6 +13,7 @@ import { inferJSONIndent } from "./formatting";
 import * as commentJSON from "comment-json";
 import { TemplateCheckoutDriverFn, gitCheckout } from "./checkout-drivers";
 import { some } from "micromatch";
+import { loadPlugin } from "./load-plugin";
 
 export interface TemplateSyncOptions {
   /**
@@ -125,10 +126,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(),
@@ -136,7 +135,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,
@@ -152,6 +167,53 @@ export async function templateSync(
     };
   }
 
+  // Pre-load plugins and make sure the sync file is respected
+  // Synchronous since grpc servers take a second
+  const localValidateErrors: {
+    [k: string]: string[];
+  } = {};
+  const validateErrors: {
+    [k: string]: string[];
+  } = {};
+  for (const config of localTemplateSyncConfig.merge ?? []) {
+    const plugin = await loadPlugin(config, options.repoDir);
+    const errors = plugin.validate(config.options ?? {});
+    if (errors && errors.length > 0) {
+      localValidateErrors[config.plugin] = errors;
+    }
+  }
+  for (const config of templateSyncConfig.merge ?? []) {
+    const plugin = await loadPlugin(config, tempCloneDir);
+    const errors = plugin.validate(config.options ?? {});
+    if (errors && errors.length > 0) {
+      validateErrors[config.plugin] = errors;
+    }
+  }
+
+  let errorStr = "";
+  if (Object.keys(validateErrors).length > 0) {
+    errorStr = `${errorStr}templatesync.json plugin option errors:\n`;
+    for (const plugin in validateErrors) {
+      errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+      validateErrors[plugin].forEach((err) => {
+        errorStr = `${errorStr}\t\t${err}\n`;
+      });
+    }
+  }
+  if (Object.keys(localValidateErrors).length > 0) {
+    errorStr = `${errorStr}templatesync.local.json plugin option errors:\n`;
+    for (const plugin in localValidateErrors) {
+      errorStr = `${errorStr}\tPlugin (${plugin}):\n`;
+      localValidateErrors[plugin].forEach((err) => {
+        errorStr = `${errorStr}\t\t${err}\n`;
+      });
+    }
+  }
+
+  if (errorStr !== "") {
+    throw Error(errorStr);
+  }
+
   // Apply ignore filters
   filesToSync.added = filesToSync.added.filter(
     (f) => !some(f, templateSyncConfig.ignore),
@@ -202,7 +264,6 @@ export async function templateSync(
     added: actualAdded,
     modified: actualModified,
     deleted: actualDeleted,
-    total: actualAdded.length + actualModified.length + actualDeleted.length,
   };
 
   // apply after ref
@@ -219,17 +280,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: Array.from(localSkipFiles),
     localFileChanges,
-    modifiedFiles: modifiedFiles,
+    modifiedFiles: {
+      ...modifiedFiles,
+      total:
+        modifiedFiles.added.length +
+        modifiedFiles.deleted.length +
+        modifiedFiles.modified.length,
+    },
   };
 }

package/test-fixtures/downstream/plugins/custom-plugin.js

@@ -8,4 +8,7 @@ module.exports = {
       4,
     );
   },
+  validate: () => {
+    return [];
+  },
 };

package/test-fixtures/downstream/plugins/fail-validate-plugin.js

@@ -0,0 +1,14 @@
+module.exports = {
+  merge: () => {
+    return JSON.stringify(
+      {
+        downstream: true,
+      },
+      null,
+      4,
+    );
+  },
+  validate: () => {
+    return ["oh no!", "not this one too!"];
+  },
+};

package/test-fixtures/downstream/templatesync.json

@@ -1,5 +1,5 @@
 {
-  "ignore": ["src/!(templated).ts", "custom-bin/**"],
+  "ignore": ["src/!(templated).ts", "custom-bin/**", "dummy-fail-plugin.js"],
   "merge": [
     {
       "glob": "package.json",

package/test-fixtures/template/dummy-fail-plugin.js

@@ -0,0 +1,8 @@
+module.exports = {
+  merge: () => {
+    return JSON.stringify({ tested: true }, null, 4);
+  },
+  validate: () => {
+    return ["shucks", "no good"];
+  },
+};

package/test-fixtures/template/templatesync.json

@@ -1,5 +1,5 @@
 {
-  "ignore": ["src/!(templated).ts", "custom-bin/**"],
+  "ignore": ["src/!(templated).ts", "custom-bin/**", "dummy-fail-plugin.js"],
   "merge": [
     {
       "glob": "package.json",