Type options and add --force option

Author: mbg

pr-checks/sync_back.test.ts

@@ -11,6 +11,7 @@ import * as path from "node:path";
 import { afterEach, beforeEach, describe, it } from "node:test";
 
 import {
+  Options,
   scanGeneratedWorkflows,
   updateSyncTs,
   updateTemplateFiles,
@@ -21,6 +22,8 @@ let workflowDir: string;
 let checksDir: string;
 let syncTsPath: string;
 
+const defaultOptions: Options = { verbose: false, force: false };
+
 beforeEach(() => {
   /** Set up temporary directories and files for testing */
   testDir = fs.mkdtempSync(path.join(os.tmpdir(), "sync-back-test-"));
@@ -150,7 +153,7 @@ const steps = [
       "actions/setup-go": { version: "v6" },
     };
 
-    const result = updateSyncTs(syncTsPath, actionVersions);
+    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
     assert.equal(result, true);
 
     const updatedContent = fs.readFileSync(syncTsPath, "utf8");
@@ -176,7 +179,7 @@ const steps = [
       "actions/setup-node": { version: "v5", comment: " Latest version" },
     };
 
-    const result = updateSyncTs(syncTsPath, actionVersions);
+    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
     assert.equal(result, true);
 
     const updatedContent = fs.readFileSync(syncTsPath, "utf8");
@@ -203,7 +206,7 @@ const steps = [
       "actions/setup-node": { version: "v5" },
     };
 
-    const result = updateSyncTs(syncTsPath, actionVersions);
+    const result = updateSyncTs(defaultOptions, syncTsPath, actionVersions);
     assert.equal(result, false);
   });
 });
@@ -228,7 +231,11 @@ steps:
       "actions/setup-node": { version: "v5", comment: " Latest" },
     };
 
-    const result = updateTemplateFiles(checksDir, actionVersions);
+    const result = updateTemplateFiles(
+      defaultOptions,
+      checksDir,
+      actionVersions,
+    );
     assert.equal(result.length, 1);
     assert.ok(result.includes(templatePath));
 
@@ -256,7 +263,11 @@ steps:
       },
     };
 
-    const result = updateTemplateFiles(checksDir, actionVersions);
+    const result = updateTemplateFiles(
+      defaultOptions,
+      checksDir,
+      actionVersions,
+    );
     assert.equal(result.length, 1);
 
     const updatedContent = fs.readFileSync(templatePath, "utf8");

pr-checks/sync_back.ts

@@ -29,6 +29,12 @@ const CHECKS_DIR = path.join(THIS_DIR, "checks");
 const WORKFLOW_DIR = path.join(THIS_DIR, "..", ".github", "workflows");
 const SYNC_TS_PATH = path.join(THIS_DIR, "sync.ts");
 
+/** Command-line options for this program. */
+export type Options = {
+  verbose: boolean;
+  force: boolean;
+};
+
 /** Records information about the version of an Action with an optional comment. */
 type ActionVersion = { version: string; comment?: string };
 
@@ -122,11 +128,13 @@ export function scanGeneratedWorkflows(
 /**
  * Update hardcoded action versions in pr-checks/sync.ts
  *
+ * @param options - The command-line options.
  * @param syncTsPath - Path to sync.ts file
  * @param actionVersions - Map of action names to versions (may include comments)
  * @returns True if the file was modified, false otherwise
  */
 export function updateSyncTs(
+  options: Options,
   syncTsPath: string,
   actionVersions: Record<string, ActionVersion>,
 ): boolean {
@@ -150,7 +158,7 @@ export function updateSyncTs(
     );
   }
 
-  if (content !== originalContent) {
+  if (content !== originalContent || options.force) {
     fs.writeFileSync(syncTsPath, content, "utf8");
     console.info(`Updated ${syncTsPath}`);
     return true;
@@ -163,11 +171,13 @@ export function updateSyncTs(
 /**
  * Update action versions in template files in pr-checks/checks/
  *
+ * @param options - The command-line options.
  * @param checksDir - Path to pr-checks/checks directory
  * @param actionVersions - Map of action names to versions (may include comments)
  * @returns List of files that were modified
  */
 export function updateTemplateFiles(
+  options: Options,
   checksDir: string,
   actionVersions: Record<string, ActionVersion>,
 ): string[] {
@@ -200,7 +210,7 @@ export function updateTemplateFiles(
     );
 
     // Write the YAML document back to the file if we made changes.
-    if (modified) {
+    if (modified || options.force) {
       fs.writeFileSync(
         filePath,
         yaml.stringify(doc, { lineWidth: 0, flowCollectionPadding: false }),
@@ -222,6 +232,11 @@ function main(): number {
         short: "v",
         default: false,
       },
+      force: {
+        type: "boolean",
+        short: "f",
+        default: false,
+      },
     },
     strict: true,
   });
@@ -248,12 +263,16 @@ function main(): number {
   const modifiedFiles: string[] = [];
 
   // Update sync.ts
-  if (updateSyncTs(SYNC_TS_PATH, actionVersions)) {
+  if (updateSyncTs(values, SYNC_TS_PATH, actionVersions)) {
     modifiedFiles.push(SYNC_TS_PATH);
   }
 
   // Update template files
-  const templateModified = updateTemplateFiles(CHECKS_DIR, actionVersions);
+  const templateModified = updateTemplateFiles(
+    values,
+    CHECKS_DIR,
+    actionVersions,
+  );
   modifiedFiles.push(...templateModified);
 
   if (modifiedFiles.length > 0) {