@hanseltime/template-repo-sync 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.1.0](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.0.1...v1.1.0) (2024-03-04)
+
+
+### Features
+
+* adding updateRef Option ([b553e65](https://github.com/HanseltimeIndustries/template-repo-sync/commit/b553e65ebce59777ccb80728d540c5734d41cab7))
+
 ## [1.0.1](https://github.com/HanseltimeIndustries/template-repo-sync/compare/v1.0.0...v1.0.1) (2024-03-03)
 
 

package/README.md

@@ -1,4 +1,4 @@
-# Template Sync Action
+# Template Sync
 
 This npm package seeks to provide further granularity for people hoping to maintain a base template repo in github that
 is either imported or used as a literal template repo.
@@ -61,7 +61,30 @@ export interface Config {
 }
 ```
 
-### Example 1
+### Example 1 - Using a custom plugin
+
+In this scenario, you have installed a package that exposes the correct plugin interface for handling .ini file contents in
+your implementing repository and set up this templatesync.local config file. Because of this, we can be assured that .ini files
+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',
+        }
+    }
+}
+```
+
+### Example 2 - Using a custom plugin for some paths
+
+Just like in example 1, we have installed a plugin that exposes the correct plugin interface. Now though,
+instead of applying that plugin to all '.ini' files, we are saying that, for this particular set of .ini
+files, only the ones in custom-configs/ will use this merge operator.
 
 ```typescript
 {
@@ -70,7 +93,15 @@ export interface Config {
         ".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
-            driver: 'my-installed-npm-package',
+            plugin: 'my-installed-npm-package',
+            rule: [
+                {
+                    glob: 'custom-configs/**',
+                    options: {
+                        myPluginParam: 'some parameter',
+                    }
+                }
+            ]
         }
     }
 }
@@ -91,3 +122,35 @@ but it does mean that you will only see the changes to files that are newer than
 
 As always, you can remove the SHA/Tag from your local config and this will trigger a full sync in the event that you made the wrong
 assumption about merging templates correctly.
+
+```typescript
+{
+    afterRef: 'git sha',
+    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',
+                    }
+                }
+            ]
+        }
+    }
+}
+```
+
+## Programmatic API
+
+The programmatic api for this package is centered around `templateSync`. The way the function is written, we try to
+allow escape hatches for other styles of comparison in the form of "TemplateDriver" functions. As part of the current
+implementation, all of these `drivers` represent git actions, but for the sake of expandability, may be set up to evaluate
+things like helm chart renderings (at least that is the hope). If you write a driver, please consider contributing it back.
+
+Please see [template-sync](./src/template-sync.ts) for the most up to date options.
+
+TODO: we should update use case examples

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

@@ -82,11 +82,11 @@ async function merge(current, fromTemplateRepo, context) {
     const fromTemplateJson = JSON.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 JSON.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 JSON.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);

package/lib/cjs/ref-drivers/git-current-ref.d.ts

@@ -0,0 +1,3 @@
+export declare function gitCurrentRef(options: {
+    rootDir: string;
+}): Promise<string>;

package/lib/cjs/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/cjs/ref-drivers/index.d.ts

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

package/lib/cjs/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/cjs/ref-drivers/types.d.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/lib/cjs/ref-drivers/types.js

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

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

@@ -1,6 +1,7 @@
 import { Change } from "diff";
 import { TemplateCloneDriverFn } from "./clone-drivers";
 import { TemplateDiffDriverFn } from "./diff-drivers";
+import { TemplateRefDriverFn } from "./ref-drivers/types";
 export interface TemplateSyncOptions {
     repoUrl: string;
     /**
@@ -11,6 +12,11 @@ export interface TemplateSyncOptions {
      * The repo directory path that we are going to merge toward
      */
     repoDir: string;
+    /**
+     * If set to true, template sync will apply the current ref
+     * of the template repo to afterRef
+     */
+    updateAfterRef?: boolean;
     /**
      * Defaults to using git clone
      */
@@ -19,6 +25,10 @@ export interface TemplateSyncOptions {
      * Defaults to using git diff
      */
     diffDriver?: TemplateDiffDriverFn;
+    /**
+     * Defaults to using git current ref
+     */
+    currentRefDriver?: TemplateRefDriverFn;
 }
 export interface TemplateSyncReturn {
     /**

package/lib/cjs/template-sync.js

@@ -7,11 +7,14 @@ 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");
 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`);
@@ -48,6 +51,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 = JSON.parse(configStr);
+            config.afterRef = ref;
+            (0, fs_1.writeFileSync)(localConfigPath, JSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+        }
+        else {
+            (0, fs_1.writeFileSync)(localConfigPath, JSON.stringify({ afterRef: ref }, null, 4));
+        }
+    }
     return {
         localSkipFiles,
         localFileChanges,

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

@@ -82,11 +82,11 @@ async function merge(current, fromTemplateRepo, context) {
     const fromTemplateJson = JSON.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 JSON.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 JSON.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);

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

@@ -7,11 +7,14 @@ 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");
 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`);
@@ -48,6 +51,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 = JSON.parse(configStr);
+            config.afterRef = ref;
+            (0, fs_1.writeFileSync)(localConfigPath, JSON.stringify(config, null, (0, formatting_1.inferJSONIndent)(configStr)));
+        }
+        else {
+            (0, fs_1.writeFileSync)(localConfigPath, JSON.stringify({ afterRef: ref }, null, 4));
+        }
+    }
     return {
         localSkipFiles,
         localFileChanges,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hanseltime/template-repo-sync",
-  "version": "1.0.1",
+  "version": "1.1.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/plugins/json-merge.ts

@@ -93,12 +93,20 @@ export async function merge(
 
   if (context.mergeArguments === "merge-current") {
     // Performs Lodash Merge with current as the override
-    return JSON.stringify(lodashMerge(fromTemplateJson, currentJson), null, 4);
+    return JSON.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 JSON.stringify(
+      lodashMerge(currentJson, fromTemplateJson),
+      null,
+      inferJSONIndent(current),
+    );
   }
 
   const { missingIsDelete, ignoreNewProperties, paths } =

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

package/src/template-sync.ts

@@ -1,5 +1,5 @@
 import { join } from "path";
-import { existsSync, readFileSync } from "fs";
+import { existsSync, readFileSync, writeFileSync } from "fs";
 import { getAllFilesInDir } from "./match";
 import { Config, LocalConfig } from "./types";
 import { mergeFile } from "./merge-file";
@@ -7,6 +7,9 @@ import { gitClone } from "./clone-drivers/git-clone";
 import { Change } from "diff";
 import { TemplateCloneDriverFn } from "./clone-drivers";
 import { TemplateDiffDriverFn, gitDiff } from "./diff-drivers";
+import { gitCurrentRef } from "./ref-drivers";
+import { TemplateRefDriverFn } from "./ref-drivers/types";
+import { inferJSONIndent } from "./formatting";
 
 export interface TemplateSyncOptions {
   repoUrl: string;
@@ -21,6 +24,12 @@ export interface TemplateSyncOptions {
    */
   repoDir: string;
 
+  /**
+   * If set to true, template sync will apply the current ref
+   * of the template repo to afterRef
+   */
+  updateAfterRef?: boolean;
+
   /**
    * Defaults to using git clone
    */
@@ -30,6 +39,11 @@ export interface TemplateSyncOptions {
    * Defaults to using git diff
    */
   diffDriver?: TemplateDiffDriverFn;
+
+  /**
+   * Defaults to using git current ref
+   */
+  currentRefDriver?: TemplateRefDriverFn;
 }
 
 export interface TemplateSyncReturn {
@@ -56,6 +70,7 @@ export async function templateSync(
 ): Promise<TemplateSyncReturn> {
   const cloneDriver = options.cloneDriver ?? gitClone;
   const diffDriver = options.diffDriver ?? gitDiff;
+  const currentRefDriver = options.currentRefDriver ?? gitCurrentRef;
   const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
 
   // Get the clone Config
@@ -106,6 +121,28 @@ export async function templateSync(
     }),
   );
 
+  // apply after ref
+  if (options.updateAfterRef) {
+    const ref = await currentRefDriver({
+      rootDir: tempCloneDir,
+    });
+
+    if (existsSync(localConfigPath)) {
+      const configStr = readFileSync(localConfigPath).toString();
+      const config = JSON.parse(configStr) as LocalConfig;
+      config.afterRef = ref;
+      writeFileSync(
+        localConfigPath,
+        JSON.stringify(config, null, inferJSONIndent(configStr)),
+      );
+    } else {
+      writeFileSync(
+        localConfigPath,
+        JSON.stringify({ afterRef: ref }, null, 4),
+      );
+    }
+  }
+
   return {
     localSkipFiles,
     localFileChanges,