@hanseltime/template-repo-sync 1.0.1 → 1.2.0

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,10 @@ 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";
+import * as commentJSON from "comment-json";
 
 export interface TemplateSyncOptions {
   repoUrl: string;
@@ -21,6 +25,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 +40,11 @@ export interface TemplateSyncOptions {
    * Defaults to using git diff
    */
   diffDriver?: TemplateDiffDriverFn;
+
+  /**
+   * Defaults to using git current ref
+   */
+  currentRefDriver?: TemplateRefDriverFn;
 }
 
 export interface TemplateSyncReturn {
@@ -56,21 +71,26 @@ 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
   const cloneConfigPath = join(tempCloneDir, `${TEMPLATE_SYNC_CONFIG}.json`);
   const templateSyncConfig: Config = existsSync(cloneConfigPath)
-    ? JSON.parse(readFileSync(cloneConfigPath).toString())
-    : {};
+    ? (commentJSON.parse(
+        readFileSync(cloneConfigPath).toString(),
+      ) as unknown as Config)
+    : { ignore: [] };
 
   const localConfigPath = join(
     options.repoDir,
     `${TEMPLATE_SYNC_LOCAL_CONFIG}.json`,
   );
-  const localTemplateSyncConfig = existsSync(localConfigPath)
-    ? JSON.parse(readFileSync(localConfigPath).toString())
-    : ({} as LocalConfig);
+  const localTemplateSyncConfig: LocalConfig = existsSync(localConfigPath)
+    ? (commentJSON.parse(
+        readFileSync(localConfigPath).toString(),
+      ) as unknown as LocalConfig)
+    : { ignore: [] };
 
   let filesToSync: string[];
   if (localTemplateSyncConfig.afterRef) {
@@ -106,6 +126,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 = commentJSON.parse(configStr) as unknown as LocalConfig;
+      config.afterRef = ref;
+      writeFileSync(
+        localConfigPath,
+        commentJSON.stringify(config, null, inferJSONIndent(configStr)),
+      );
+    } else {
+      writeFileSync(
+        localConfigPath,
+        commentJSON.stringify({ afterRef: ref }, null, 4),
+      );
+    }
+  }
+
   return {
     localSkipFiles,
     localFileChanges,

package/src/types.ts

@@ -42,7 +42,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; options: MergePluginOptions | T }[];
 }