@hanseltime/template-repo-sync 1.0.1 → 1.2.0

package/lib/cjs/template-sync.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.templateSync = exports.TEMPLATE_SYNC_LOCAL_CONFIG = exports.TEMPLATE_SYNC_CONFIG = void 0;
 const path_1 = require("path");
@@ -7,21 +30,25 @@ const match_1 = require("./match");
 const merge_file_1 = require("./merge-file");
 const git_clone_1 = require("./clone-drivers/git-clone");
 const diff_drivers_1 = require("./diff-drivers");
+const ref_drivers_1 = require("./ref-drivers");
+const formatting_1 = require("./formatting");
+const commentJSON = __importStar(require("comment-json"));
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
     const cloneDriver = options.cloneDriver ?? git_clone_1.gitClone;
     const diffDriver = options.diffDriver ?? diff_drivers_1.gitDiff;
+    const currentRefDriver = options.currentRefDriver ?? ref_drivers_1.gitCurrentRef;
     const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
     // Get the clone Config
     const cloneConfigPath = (0, path_1.join)(tempCloneDir, `${exports.TEMPLATE_SYNC_CONFIG}.json`);
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)
-        ? JSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
-        : {};
+        ? commentJSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
+        : { ignore: [] };
     const localConfigPath = (0, path_1.join)(options.repoDir, `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`);
     const localTemplateSyncConfig = (0, fs_1.existsSync)(localConfigPath)
-        ? JSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
-        : {};
+        ? commentJSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
+        : { ignore: [] };
     let filesToSync;
     if (localTemplateSyncConfig.afterRef) {
         filesToSync = await diffDriver(tempCloneDir, localTemplateSyncConfig.afterRef);
@@ -48,6 +75,21 @@ async function templateSync(options) {
             localFileChanges[f] = result.localChanges;
         }
     }));
+    // apply after ref
+    if (options.updateAfterRef) {
+        const ref = await currentRefDriver({
+            rootDir: tempCloneDir,
+        });
+        if ((0, fs_1.existsSync)(localConfigPath)) {
+            const configStr = (0, fs_1.readFileSync)(localConfigPath).toString();
+            const config = commentJSON.parse(configStr);
+            config.afterRef = ref;
+            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+        }
+        else {
+            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify({ afterRef: ref }, null, 4));
+        }
+    }
     return {
         localSkipFiles,
         localFileChanges,

package/lib/cjs/types.d.ts

@@ -36,7 +36,7 @@ export interface MergeConfig<T> {
      */
     plugin?: string;
     /**
-     * An array of first match file globs that will
+     * An array of first match file globs that will then call the plugin with the appropriate options
      */
     rules: {
         glob: string;

package/lib/esm/plugins/json-merge.js

@@ -1,13 +1,36 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.merge = exports.validate = void 0;
 const lodash_merge_1 = __importDefault(require("lodash.merge"));
-const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
 const jsonpath_1 = __importDefault(require("jsonpath"));
 const infer_json_indent_1 = require("../formatting/infer-json-indent");
+const commentJSON = __importStar(require("comment-json"));
 function stringOptionError(value) {
     if (value === "overwrite" ||
         value === "merge-template" ||
@@ -78,18 +101,18 @@ async function merge(current, fromTemplateRepo, context) {
     if (context.mergeArguments === "overwrite") {
         return fromTemplateRepo;
     }
-    const currentJson = JSON.parse(current);
-    const fromTemplateJson = JSON.parse(fromTemplateRepo);
+    const currentJson = commentJSON.parse(current);
+    const fromTemplateJson = commentJSON.parse(fromTemplateRepo);
     if (context.mergeArguments === "merge-current") {
         // Performs Lodash Merge with current as the override
-        return JSON.stringify((0, lodash_merge_1.default)(fromTemplateJson, currentJson), null, 4);
+        return commentJSON.stringify((0, lodash_merge_1.default)(fromTemplateJson, currentJson), null, (0, infer_json_indent_1.inferJSONIndent)(current));
     }
     if (context.mergeArguments === "merge-template") {
         // Performs Lodash Merge with current as the override
-        return JSON.stringify((0, lodash_merge_1.default)(currentJson, fromTemplateJson), null, 4);
+        return commentJSON.stringify((0, lodash_merge_1.default)(currentJson, fromTemplateJson), null, (0, infer_json_indent_1.inferJSONIndent)(current));
     }
     const { missingIsDelete, ignoreNewProperties, paths } = context.mergeArguments;
-    const returnJson = (0, lodash_clonedeep_1.default)(currentJson);
+    const returnJson = commentJSON.parse(current);
     paths.forEach((p) => {
         const [jPath, overrideType] = p;
         const fromTemplatePaths = new Map();
@@ -143,7 +166,7 @@ async function merge(current, fromTemplateRepo, context) {
             }
         });
     }
-    return JSON.stringify(returnJson, null, (0, infer_json_indent_1.inferJSONIndent)(current));
+    return commentJSON.stringify(returnJson, null, (0, infer_json_indent_1.inferJSONIndent)(current));
 }
 exports.merge = merge;
 /**

package/lib/esm/ref-drivers/git-current-ref.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitCurrentRef = void 0;
+const child_process_1 = require("child_process");
+async function gitCurrentRef(options) {
+    return (0, child_process_1.execSync)(`git rev-parse HEAD`, {
+        cwd: options.rootDir,
+    })
+        .toString()
+        .trim();
+}
+exports.gitCurrentRef = gitCurrentRef;

package/lib/esm/ref-drivers/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./git-current-ref"), exports);

package/lib/esm/ref-drivers/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/esm/template-sync.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.templateSync = exports.TEMPLATE_SYNC_LOCAL_CONFIG = exports.TEMPLATE_SYNC_CONFIG = void 0;
 const path_1 = require("path");
@@ -7,21 +30,25 @@ const match_1 = require("./match");
 const merge_file_1 = require("./merge-file");
 const git_clone_1 = require("./clone-drivers/git-clone");
 const diff_drivers_1 = require("./diff-drivers");
+const ref_drivers_1 = require("./ref-drivers");
+const formatting_1 = require("./formatting");
+const commentJSON = __importStar(require("comment-json"));
 exports.TEMPLATE_SYNC_CONFIG = "templatesync";
 exports.TEMPLATE_SYNC_LOCAL_CONFIG = "templatesync.local";
 async function templateSync(options) {
     const cloneDriver = options.cloneDriver ?? git_clone_1.gitClone;
     const diffDriver = options.diffDriver ?? diff_drivers_1.gitDiff;
+    const currentRefDriver = options.currentRefDriver ?? ref_drivers_1.gitCurrentRef;
     const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
     // Get the clone Config
     const cloneConfigPath = (0, path_1.join)(tempCloneDir, `${exports.TEMPLATE_SYNC_CONFIG}.json`);
     const templateSyncConfig = (0, fs_1.existsSync)(cloneConfigPath)
-        ? JSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
-        : {};
+        ? commentJSON.parse((0, fs_1.readFileSync)(cloneConfigPath).toString())
+        : { ignore: [] };
     const localConfigPath = (0, path_1.join)(options.repoDir, `${exports.TEMPLATE_SYNC_LOCAL_CONFIG}.json`);
     const localTemplateSyncConfig = (0, fs_1.existsSync)(localConfigPath)
-        ? JSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
-        : {};
+        ? commentJSON.parse((0, fs_1.readFileSync)(localConfigPath).toString())
+        : { ignore: [] };
     let filesToSync;
     if (localTemplateSyncConfig.afterRef) {
         filesToSync = await diffDriver(tempCloneDir, localTemplateSyncConfig.afterRef);
@@ -48,6 +75,21 @@ async function templateSync(options) {
             localFileChanges[f] = result.localChanges;
         }
     }));
+    // apply after ref
+    if (options.updateAfterRef) {
+        const ref = await currentRefDriver({
+            rootDir: tempCloneDir,
+        });
+        if ((0, fs_1.existsSync)(localConfigPath)) {
+            const configStr = (0, fs_1.readFileSync)(localConfigPath).toString();
+            const config = commentJSON.parse(configStr);
+            config.afterRef = ref;
+            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+        }
+        else {
+            (0, fs_1.writeFileSync)(localConfigPath, commentJSON.stringify({ afterRef: ref }, null, 4));
+        }
+    }
     return {
         localSkipFiles,
         localFileChanges,

package/package.json

@@ -1,29 +1,27 @@
 {
   "name": "@hanseltime/template-repo-sync",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "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",
   "scripts": {
-    "format": "npx prettier . --write",
-    "lint": "npx eslint .",
+    "format": "prettier . --write",
+    "lint": "eslint .",
     "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
     "run-script": "node --loader ts-node/esm",
     "build": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
     "prepare": "husky",
-    "release": "npx semantic-release"
+    "release": "semantic-release"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@actions/core": "^1.10.1",
-    "@actions/github": "^6.0.0",
+    "comment-json": "^4.2.3",
     "diff": "^5.1.0",
     "fs-extra": "^11.2.0",
     "jsonpath": "^1.1.1",
-    "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "micromatch": "^4.0.5"
   },
@@ -35,7 +33,6 @@
     "@types/fs-extra": "^11.0.4",
     "@types/jest": "^29.5.11",
     "@types/jsonpath": "^0.2.4",
-    "@types/lodash.clonedeep": "^4.5.9",
     "@types/lodash.merge": "^4.6.9",
     "@types/micromatch": "^4.0.6",
     "@types/node": "^20.11.7",

package/src/plugins/json-merge.spec.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { JsonPathOverrides } from "../types";
 import { merge, validate } from "./json-merge";
+import * as commentJson from "comment-json";
 
 const testFileJson = {
   here: "here",
@@ -24,6 +25,21 @@ const templateFileJson = {
   },
 };
 
+const testCommentJson = `{
+  // This is a top comment
+  "here": "here",
+  "another": 23, // this is inline
+  "inner": {
+    "el1": "el1",
+    "arr1": ["a1", "a2"],
+    "nested": {
+      // Upper comment
+      "final": "final", // Inline commment
+      "final2": "final2",
+    },
+  },
+}`;
+
 describe("merge", () => {
   it("performs overwrite when specified", async () => {
     const fromTemplateJson = {
@@ -291,6 +307,76 @@ describe("merge", () => {
       },
     });
   });
+  it("performs pathjson merges on comment json", async () => {
+    const template = { ...templateFileJson };
+    (template.inner as any).nested = {
+      final: { something: 44 },
+      newThing: "this",
+    };
+
+    const testTemplateCommentJson = `{
+      "here": "heretemplate",
+      /** New comment explaining extra **/
+      "extra": "extra",
+      "inner": {
+        "arr1": ["b1", "b2"],
+        "extra2": "extra2",
+        "nested": {
+          "final": {
+            // New comment explaining final
+            "something": 44,
+          },
+          "newThing": {
+            // new thing comment
+            "this": 23,
+          },
+        }
+      },
+    }`;
+
+    expect(
+      commentJson.stringify(
+        commentJson.parse(
+          await merge(testCommentJson, testTemplateCommentJson, {
+            relFilePath: "somepath",
+            mergeArguments: {
+              paths: [
+                ["$.here", "merge-template"],
+                ["$.inner.nested.*", "merge-template"],
+                ["$.inner.nested.final", "merge-current"],
+              ],
+            },
+          }),
+        ),
+        null,
+        4,
+      ),
+    ).toEqual(
+      commentJson.stringify(
+        commentJson.parse(`{
+        // This is a top comment
+        "here": "heretemplate",
+        "another": 23, // this is inline
+        "inner": {
+          "el1": "el1",
+          "arr1": ["a1", "a2"],
+          "nested": {
+            // Upper comment
+            "final": "final", // Inline commment
+            "final2": "final2",
+            "newThing": {
+              // new thing comment
+              "this": 23,
+            },
+          },
+        },
+        "extra": "extra",
+      }`),
+        null,
+        4,
+      ),
+    );
+  });
 });
 
 describe("validate", () => {

package/src/plugins/json-merge.ts

@@ -4,9 +4,9 @@ import {
   JsonPathOverrides,
 } from "../types";
 import lodashMerge from "lodash.merge";
-import locashCloneDeep from "lodash.clonedeep";
 import jp, { PathComponent } from "jsonpath";
 import { inferJSONIndent } from "../formatting/infer-json-indent";
+import * as commentJSON from "comment-json";
 
 function stringOptionError(value: string) {
   if (
@@ -88,23 +88,33 @@ export async function merge(
     return fromTemplateRepo;
   }
 
-  const currentJson = JSON.parse(current);
-  const fromTemplateJson = JSON.parse(fromTemplateRepo);
+  const currentJson = commentJSON.parse(current) as commentJSON.CommentObject;
+  const fromTemplateJson = commentJSON.parse(
+    fromTemplateRepo,
+  ) as commentJSON.CommentObject;
 
   if (context.mergeArguments === "merge-current") {
     // Performs Lodash Merge with current as the override
-    return JSON.stringify(lodashMerge(fromTemplateJson, currentJson), null, 4);
+    return commentJSON.stringify(
+      lodashMerge(fromTemplateJson, currentJson),
+      null,
+      inferJSONIndent(current),
+    );
   }
 
   if (context.mergeArguments === "merge-template") {
     // Performs Lodash Merge with current as the override
-    return JSON.stringify(lodashMerge(currentJson, fromTemplateJson), null, 4);
+    return commentJSON.stringify(
+      lodashMerge(currentJson, fromTemplateJson),
+      null,
+      inferJSONIndent(current),
+    );
   }
 
   const { missingIsDelete, ignoreNewProperties, paths } =
     context.mergeArguments as JsonPathOverrides;
 
-  const returnJson = locashCloneDeep(currentJson);
+  const returnJson = commentJSON.parse(current) as commentJSON.CommentObject;
   paths.forEach((p) => {
     const [jPath, overrideType] = p;
 
@@ -158,7 +168,7 @@ export async function merge(
     });
   }
 
-  return JSON.stringify(returnJson, null, inferJSONIndent(current));
+  return commentJSON.stringify(returnJson, null, inferJSONIndent(current));
 }
 
 /**

package/src/ref-drivers/git-current-ref.spec.ts

@@ -0,0 +1,12 @@
+import { execSync } from "child_process";
+import { gitCurrentRef } from "./git-current-ref";
+
+describe("getCurrentRef", () => {
+  it("gets the current sha", async () => {
+    expect(
+      await gitCurrentRef({
+        rootDir: process.cwd(),
+      }),
+    ).toEqual(execSync("git rev-parse HEAD").toString().trim());
+  });
+});

package/src/ref-drivers/git-current-ref.ts

@@ -0,0 +1,9 @@
+import { execSync } from "child_process";
+
+export async function gitCurrentRef(options: { rootDir: string }) {
+  return execSync(`git rev-parse HEAD`, {
+    cwd: options.rootDir,
+  })
+    .toString()
+    .trim();
+}

package/src/ref-drivers/index.ts

@@ -0,0 +1 @@
+export * from "./git-current-ref";

package/src/ref-drivers/types.ts

@@ -0,0 +1,10 @@
+/**
+ * A function that operates within the root dir and returns the
+ * current ref for its state.  This abstracts the idea of getting
+ * the current commit sha, so that things like other custom templating
+ * frameworks can provide their own ref
+ */
+export type TemplateRefDriverFn = (options: {
+  /** The root dir where we want to get the "current" ref */
+  rootDir: string;
+}) => Promise<string>;

package/src/template-sync.spec.ts

@@ -192,6 +192,127 @@ describe("templateSync", () => {
     await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
     await fileMatchDownstream(tmpDir, "package.json");
   });
+  it("updates the local templatesync with the current ref if updateAfterRef is true", 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 () => ["src/templated.ts"]);
+    const mockCurrentRefDriver = jest
+      .fn()
+      .mockImplementation(async () => "newestSha");
+    const result = await templateSync({
+      tmpCloneDir: "stubbed-by-driver",
+      cloneDriver: dummyCloneDriver,
+      repoUrl: "not-important",
+      repoDir: tmpDir,
+      updateAfterRef: true,
+      diffDriver: mockDiffDriver,
+      currentRefDriver: mockCurrentRefDriver,
+    });
+
+    // since there was no override for this file, not changes from the local file
+    expect(result.localFileChanges).toEqual(expect.objectContaining({}));
+
+    // Verify the files
+    await fileMatchTemplate(tmpDir, "templatesync.json");
+    await fileMatchTemplate(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,
+      afterRef: "newestSha",
+    });
+  });
+  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"));
+
+    // We will only update the templated.ts
+    const mockDiffDriver = jest
+      .fn()
+      .mockImplementation(async () => ["src/templated.ts"]);
+    const mockCurrentRefDriver = jest
+      .fn()
+      .mockImplementation(async () => "newestSha");
+    const result = await templateSync({
+      tmpCloneDir: "stubbed-by-driver",
+      cloneDriver: dummyCloneDriver,
+      repoUrl: "not-important",
+      repoDir: tmpDir,
+      updateAfterRef: true,
+      diffDriver: mockDiffDriver,
+      currentRefDriver: mockCurrentRefDriver,
+    });
+
+    // since there was no override for this file, not changes from the local file
+    expect(result.localFileChanges).toEqual(expect.objectContaining({}));
+
+    // Verify the files
+    await fileMatchTemplate(tmpDir, "templatesync.json");
+    await fileMatchTemplate(tmpDir, "src/templated.ts");
+    const packageJson = JSON.parse(
+      readFileSync(resolve(tmpDir, "package.json")).toString(),
+    );
+
+    expect(packageJson).toEqual({
+      name: "mypkg",
+      description: "my description",
+      dependencies: {
+        mypackage: "^1.2.0",
+        newpacakge: "^22.2.2",
+        package2: "3.22.1",
+        huh: "~1.0.0",
+      },
+      engines: {
+        node: ">=15",
+      },
+      scripts: {
+        build: "build",
+        test: "jest",
+        myscript: "somescript",
+      },
+      // By default we add new top-level fields
+      version: "new-version",
+    });
+
+    // Expect the none of the diff files to work
+    await fileMatchDownstream(tmpDir, "src/index.ts");
+    await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
+
+    // Ensure we have updated the local template field
+    expect(
+      JSON.parse(
+        (await readFile(join(tmpDir, "templatesync.local.json"))).toString(),
+      ),
+    ).toEqual({
+      afterRef: "newestSha",
+    });
+  });
 });
 
 // helper