refactor: process exit in cli instead of in modules

Author: northword

packages/scaffold/src/cli.ts

@@ -1,3 +1,5 @@
+import type { Base } from "./core/base.js";
+import type { Context, OverrideConfig } from "./types/index.js";
 import process from "node:process";
 import { Command } from "commander";
 import pkg from "../package.json" with { type: "json" };
@@ -26,11 +28,11 @@ async function main() {
     .description("Build the plugin")
     .option("--dev", "Builds the plugin in dev mode")
     .option("--dist <dir>", "The relative path for the new output directory (default: build)")
-    .action((options) => {
+    .action(async (options) => {
       process.env.NODE_ENV = options.dev ? "development" : "production";
-      Config.loadConfig({
+      await runCommand(Build, {
         dist: options.dist,
-      }).then(ctx => new Build(ctx).run());
+      });
     });
 
   cli
@@ -45,32 +47,29 @@ async function main() {
     //   "--only-start",
     //   "skip building website before deploy it (default: false)",
     // )
-    .action((_options) => {
-      Config.loadConfig({}).then(ctx => new Serve(ctx).run());
+    .action(async (_options) => {
+      await runCommand(Serve, {});
     });
 
   cli.command("test")
     .description("Run tests")
     .option("--abort-on-fail", "Abort the test suite on first failure")
     .option("--exit-on-finish", "Exit the test suite after all tests have run")
     .option("--no-watch", "Exit the test suite after all tests have run")
-    .action((options) => {
+    .action(async (options) => {
       process.env.NODE_ENV = "test";
-
-      Config.loadConfig({
+      await runCommand(Test, {
         test: {
           abortOnFail: options.abortOnFail,
           watch: !options.exitOnFinish && options.watch,
         },
-      }).then((ctx) => {
-        new Test(ctx).run();
       });
     });
 
   cli
     .command("create")
     .description("Create the plugin template")
-    .action((_options: any) => {
+    .action(async (_options: any) => {
       logger.error("The create not yet implemented");
       // new Create().run();
     });
@@ -83,15 +82,15 @@ async function main() {
     .option("-y, --yes", "Skip confirmation")
     .action(async (version, options) => {
       process.env.NODE_ENV = "production";
-      Config.loadConfig({
+      await runCommand(Release, {
         release: {
           bumpp: {
             release: version,
             preid: options.preid,
             confirm: !options.yes,
           },
         },
-      }).then(ctx => new Release(ctx).run());
+      });
     });
 
   cli.arguments("<command>").action((cmd) => {
@@ -100,7 +99,18 @@ async function main() {
   });
 
   cli.parse();
-  // globalOpts = cli.optsWithGlobals();
+}
+
+type Constructor<T> = new (ctx: Context) => T;
+
+export async function runCommand<T extends Base>(
+  CommandClass: Constructor<T>,
+  config: OverrideConfig,
+) {
+  const ctx = await Config.loadConfig(config);
+  const instance = new CommandClass(ctx);
+  process.on("SIGINT", instance.exit.bind(instance));
+  await instance.run();
 }
 
 export default async function mainWithErrorHandler() {

packages/scaffold/src/core/base.ts

@@ -6,7 +6,9 @@ export abstract class Base {
     this.ctx = ctx;
   }
 
-  abstract run(): any;
+  abstract run(): void | Promise<void>;
+
+  abstract exit(): void;
 
   get logger() {
     return this.ctx.logger;

packages/scaffold/src/core/builder.ts

@@ -231,4 +231,6 @@ export default class Build extends Base {
     zip.addLocalFolder(`${dist}/addon`);
     zip.writeZip(`${dist}/${xpiName}.xpi`);
   }
+
+  exit() {}
 }

packages/scaffold/src/core/releaser/index.ts

@@ -197,6 +197,8 @@ export default class Release extends Base {
     return false;
   }
 
+  exit() {}
+
   get resolvedCommitMessage() {
     return this.ctx.release.bumpp.commit.replace("%s", this.ctx.version);
   }

packages/scaffold/src/core/server.ts

@@ -20,10 +20,6 @@ export default class Serve extends Base {
   }
 
   async run() {
-    // Handle interrupt signal (Ctrl+C) to gracefully terminate Zotero process
-    // Must be placed at the top to prioritize registration of events to prevent web-ext interference
-    process.on("SIGINT", this.exit);
-
     this.runner = new ZoteroRunner({
       binary: {
         path: this.zoteroBinPath,

packages/scaffold/src/core/tester/index.ts

@@ -32,10 +32,6 @@ export default class Test extends Base {
   }
 
   async run() {
-    // Handle interrupt signal (Ctrl+C) to gracefully terminate Zotero process
-    // Must be placed at the top to prioritize registration of events to prevent web-ext interference
-    process.on("SIGINT", this.exit);
-
     // Empty dirs
     await emptyDir(TESTER_PROFILE_DIR);
     await emptyDir(TESTER_DATA_DIR);
@@ -149,7 +145,7 @@ export default class Test extends Base {
       process.exit(0);
   };
 
-  private exit = (code?: string | number) => {
+  exit = (code?: string | number) => {
     if (code === "SIGINT") {
       this.logger.info("Tester shutdown by user request");
     }