refactor: separate cli and commands

Author: martabal

.github/workflows/test.yml

@@ -99,7 +99,7 @@ jobs:
         run: npm ci
 
       - name: Generate shell completions
-        run: npm run generate:completion
+        run: npm run generate:shell-completion
 
       - name: Run ShellCheck
         uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38 #v2.0.0

package-lock.json

@@ -25,11 +25,11 @@
   "scripts": {
     "build": "MINIFY=true vite build",
     "check:typescript": "tsc --noEmit",
-    "check:all": "npm run generate:completion && npm run shellcheck && npm run check:typescript && npm run test && npm run format && npm run lint",
+    "check:all": "npm run generate:shell-completion && npm run shellcheck && npm run check:typescript && npm run test && npm run format && npm run lint",
     "ff-diff": "vite build -l warn && USE_CURRENT_DIR=true node dist/index.js",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "generate:completion": "COMPLETION=true vite build && node dist/shell-completion.js --path ./completions",
+    "generate:shell-completion": "COMPLETION=true vite build && node dist/shell-completion.js --path ./completions",
     "generate:usage": "USAGE=true vite build && node dist/usage.js",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix --fix-suggestions",
@@ -42,7 +42,7 @@
     "@types/node": "24.1.0",
     "@types/selenium-webdriver": "4.1.28",
     "@vitest/coverage-v8": "3.2.4",
-    "oxlint": "1.8.0",
+    "oxlint": "1.9.0",
     "prettier": "3.6.2",
     "typescript": "5.8.3",
     "vite": "7.0.6",

package.json

@@ -3,6 +3,9 @@ import { getDefaultPrefs } from "@commands/default-prefs";
 import { defaultPrefsUserJS } from "@commands/default-prefs-userjs";
 import { diff } from "@commands/diff";
 import { unusedPrefs } from "@commands/unused-prefs";
+import { getArgumentValue, parseKeepArgument } from "@lib/cli";
+import { getInstalledFirefoxPath } from "@lib/firefox";
+import { startsWithNumberDotNumber } from "@lib/helpers";
 
 const CONSOLE_COLORS = {
   GREEN: "\u001B[32m",
@@ -15,7 +18,7 @@ interface SourceCleanupOptions {
   sources: boolean;
 }
 
-export interface OutputOptions {
+interface OutputOptions {
   doNotPrintConsole: boolean;
   saveOutput: boolean;
 }
@@ -31,7 +34,7 @@ export const HELP_ARGS = {
   longOption: "--help",
   doc: "Print help",
 };
-export const HELP_ARGS_VALUES = Object.values(VERSION_ARGS);
+export const HELP_ARGS_VALUES = Object.values(HELP_ARGS);
 
 export const CLI_ARGS = {
   CLEAN_ARCHIVES: "--clean-archives",
@@ -81,6 +84,16 @@ const pathToFirefox: CliOption = {
   longOption: `${CLI_ARGS.FIREFOX_PATH} ${CLI_VALUES.PATH_USAGE}`,
   doc: "Path to the firefox binary",
 };
+
+export const hasAnyArg = (args: readonly string[]): boolean => {
+  return process.argv.some((arg) => args.includes(arg));
+};
+
+const createPrintOptions = (): OutputOptions => ({
+  doNotPrintConsole: process.argv.includes(CLI_ARGS.DO_NOT_PRINT_IN_CONSOLE),
+  saveOutput: process.argv.includes(CLI_ARGS.SAVE_OUTPUT),
+});
+
 const createCleanOptions = (): SourceCleanupOptions => ({
   archives: process.argv.includes(CLI_ARGS.CLEAN_ARCHIVES),
   sources: process.argv.includes(CLI_ARGS.CLEAN_SOURCES),
@@ -91,15 +104,6 @@ const createKeepOptions = (): SourceCleanupOptions => ({
   sources: process.argv.includes(CLI_ARGS.KEEP_SOURCES),
 });
 
-export const hasAnyArg = (args: readonly string[]): boolean => {
-  return process.argv.some((arg) => args.includes(arg));
-};
-
-export const createPrintOptions = (): OutputOptions => ({
-  doNotPrintConsole: process.argv.includes(CLI_ARGS.DO_NOT_PRINT_IN_CONSOLE),
-  saveOutput: process.argv.includes(CLI_ARGS.SAVE_OUTPUT),
-});
-
 export const cleanOptions: SourceCleanupOptions = createCleanOptions();
 export const keepOptions: SourceCleanupOptions = createKeepOptions();
 export const printOptions: OutputOptions = createPrintOptions();
@@ -118,7 +122,7 @@ interface CliOption extends CliDoc {
   readonly shortOption?: string;
 }
 
-export abstract class BaseCli {
+abstract class BaseCli {
   public readonly command?: string;
   public readonly description: string;
   public readonly commands: readonly CliCommand[];
@@ -211,163 +215,192 @@ export abstract class BaseCli {
   }
 }
 
-export class DiffCommand extends BaseCli {
-  public static readonly COMMAND = "diff";
-  public static readonly SMALL_DESCRIPTION =
-    "Compare the default preferences of two firefox versions";
-  public static readonly DESCRIPTION =
-    DiffCommand.SMALL_DESCRIPTION + " and highlight differences";
-
-  public static readonly COMMANDS: readonly CliCommand[] = [
-    {
-      values: [`<${CLI_VALUES.OLD_VERSION}> <${CLI_VALUES.NEW_VERSION}>`],
-      doc: [
-        "First arg is the old version, second arg is the new version",
-        `  Example: diff ${EXAMPLE_VERSION.OLD_VERSION} ${EXAMPLE_VERSION.NEW_VERSION}`,
-      ].join("\n"),
-    },
-  ];
-
+class CleanCommand extends BaseCli {
+  public static readonly COMMAND = "clean";
+  public static readonly SMALL_DESCRIPTION = undefined;
+  public static readonly DESCRIPTION = `Remove files generated by ${APP_NAME}`;
+  public static readonly COMMANDS: readonly CliCommand[] = [];
   public static readonly OPTIONS: readonly CliOption[] = [
     {
-      longOption: CLI_ARGS.CLEAN_ARCHIVES,
+      longOption: `${CLI_ARGS.KEEP} ${CLI_VALUES.VERSION1},${CLI_VALUES.VERSION2}`,
 
-      doc: "Remove archives after retrieving preferences",
+      doc: [
+        "Specify one or more versions whose archives and binaries should be preserved during cleanup",
+        "Provide a comma-separated list of versions to keep",
+        `   Example: ${CLI_ARGS.KEEP} ${EXAMPLE_VERSION.OLD_VERSION},${EXAMPLE_VERSION.NEW_VERSION}`,
+      ].join("\n"),
+      smallDoc: "Version to keep",
     },
     {
-      longOption: CLI_ARGS.CLEAN_SOURCES,
-
-      doc: "Remove binaries after retrieving preferences",
+      longOption: CLI_ARGS.KEEP_ARCHIVES,
+      doc: "Keep all archives",
     },
-    ...printAndSave,
     {
-      longOption: `${CLI_ARGS.COMPARE_USERJS} ${CLI_VALUES.PATH_USAGE}`,
-      doc: "Check for removed or changed keys in the specified user.js file",
+      longOption: CLI_ARGS.KEEP_SOURCES,
+      doc: "Keep all binaries",
     },
   ];
 
   constructor(fail: boolean = true) {
     super(
       fail,
-      DiffCommand.DESCRIPTION,
-      DiffCommand.COMMANDS,
-      DiffCommand.OPTIONS,
+      CleanCommand.DESCRIPTION,
+      CleanCommand.COMMANDS,
+      CleanCommand.OPTIONS,
     );
   }
 
   public async entrypoint(): Promise<void> {
-    await diff();
+    const keptVersions = parseKeepArgument();
+    await clean(keptVersions);
   }
 }
 
-export class UnusedPrefCommand extends BaseCli {
-  public static readonly COMMAND = "unused-prefs-userjs";
+class DefaultPrefsUserJSCommand extends BaseCli {
+  public static readonly COMMAND = "default-prefs-userjs";
   public static readonly SMALL_DESCRIPTION = undefined;
   public static readonly DESCRIPTION =
-    "Identify unused preferences from your user.js file";
+    "Identify default preferences from your user.js file";
   public static readonly COMMANDS: readonly CliCommand[] = [pathUsageUserJS];
-  public static readonly OPTIONS: readonly CliOption[] = [pathToFirefox];
+  public static readonly OPTIONS: readonly CliOption[] = [
+    pathToFirefox,
+    ...printAndSave,
+  ];
 
   constructor(fail: boolean = true) {
     super(
       fail,
-      UnusedPrefCommand.DESCRIPTION,
-      UnusedPrefCommand.COMMANDS,
-      UnusedPrefCommand.OPTIONS,
+      DefaultPrefsUserJSCommand.DESCRIPTION,
+      DefaultPrefsUserJSCommand.COMMANDS,
+      DefaultPrefsUserJSCommand.OPTIONS,
     );
   }
 
   public async entrypoint(): Promise<void> {
-    await unusedPrefs();
+    const [, , , compareUserjs] = process.argv;
+    if (compareUserjs === undefined) {
+      this.usage();
+    }
+    await defaultPrefsUserJS(compareUserjs);
   }
 }
 
-export class CleanCommand extends BaseCli {
-  public static readonly COMMAND = "clean";
+class DefaultPrefsCommand extends BaseCli {
+  public static readonly COMMAND = "default-prefs";
   public static readonly SMALL_DESCRIPTION = undefined;
-  public static readonly DESCRIPTION = `Remove files generated by ${APP_NAME}`;
+  public static readonly DESCRIPTION = `Get a list of all default prefs`;
   public static readonly COMMANDS: readonly CliCommand[] = [];
   public static readonly OPTIONS: readonly CliOption[] = [
-    {
-      longOption: `${CLI_ARGS.KEEP} ${CLI_VALUES.VERSION1},${CLI_VALUES.VERSION2}`,
-
-      doc: [
-        "Specify one or more versions whose archives and binaries should be preserved during cleanup",
-        "Provide a comma-separated list of versions to keep",
-        `   Example: ${CLI_ARGS.KEEP} ${EXAMPLE_VERSION.OLD_VERSION},${EXAMPLE_VERSION.NEW_VERSION}`,
-      ].join("\n"),
-      smallDoc: "Version to keep",
-    },
-    {
-      longOption: CLI_ARGS.KEEP_ARCHIVES,
-      doc: "Keep all archives",
-    },
-    {
-      longOption: CLI_ARGS.KEEP_SOURCES,
-      doc: "Keep all binaries",
-    },
+    ...printAndSave,
+    pathToFirefox,
   ];
 
   constructor(fail: boolean = true) {
     super(
       fail,
-      CleanCommand.DESCRIPTION,
-      CleanCommand.COMMANDS,
-      CleanCommand.OPTIONS,
+      DefaultPrefsCommand.DESCRIPTION,
+      DefaultPrefsCommand.COMMANDS,
+      DefaultPrefsCommand.OPTIONS,
     );
   }
 
   public async entrypoint(): Promise<void> {
-    await clean();
+    const { path } = getInstalledFirefoxPath();
+    await getDefaultPrefs(path);
   }
 }
 
-export class DefaultPrefsCommand extends BaseCli {
-  public static readonly COMMAND = "default-prefs";
-  public static readonly SMALL_DESCRIPTION = undefined;
-  public static readonly DESCRIPTION = `Get a list of all default prefs`;
-  public static readonly COMMANDS: readonly CliCommand[] = [];
+export interface Diff {
+  compareUserJS?: string;
+  oldVersion: string;
+  newVersion: string;
+}
+
+class DiffCommand extends BaseCli {
+  public static readonly COMMAND = "diff";
+  public static readonly SMALL_DESCRIPTION =
+    "Compare the default preferences of two firefox versions";
+  public static readonly DESCRIPTION =
+    DiffCommand.SMALL_DESCRIPTION + " and highlight differences";
+
+  public static readonly COMMANDS: readonly CliCommand[] = [
+    {
+      values: [`<${CLI_VALUES.OLD_VERSION}> <${CLI_VALUES.NEW_VERSION}>`],
+      doc: [
+        "First arg is the old version, second arg is the new version",
+        `  Example: diff ${EXAMPLE_VERSION.OLD_VERSION} ${EXAMPLE_VERSION.NEW_VERSION}`,
+      ].join("\n"),
+    },
+  ];
+
   public static readonly OPTIONS: readonly CliOption[] = [
+    {
+      longOption: CLI_ARGS.CLEAN_ARCHIVES,
+
+      doc: "Remove archives after retrieving preferences",
+    },
+    {
+      longOption: CLI_ARGS.CLEAN_SOURCES,
+
+      doc: "Remove binaries after retrieving preferences",
+    },
     ...printAndSave,
-    pathToFirefox,
+    {
+      longOption: `${CLI_ARGS.COMPARE_USERJS} ${CLI_VALUES.PATH_USAGE}`,
+      doc: "Check for removed or changed keys in the specified user.js file",
+    },
   ];
 
   constructor(fail: boolean = true) {
     super(
       fail,
-      DefaultPrefsCommand.DESCRIPTION,
-      DefaultPrefsCommand.COMMANDS,
-      DefaultPrefsCommand.OPTIONS,
+      DiffCommand.DESCRIPTION,
+      DiffCommand.COMMANDS,
+      DiffCommand.OPTIONS,
     );
   }
 
   public async entrypoint(): Promise<void> {
-    await getDefaultPrefs();
+    const [, , , oldVersion, newVersion] = process.argv;
+
+    if (
+      !oldVersion ||
+      !newVersion ||
+      !startsWithNumberDotNumber(oldVersion) ||
+      !startsWithNumberDotNumber(newVersion)
+    ) {
+      this.usage();
+    }
+
+    const compareUserJS = getArgumentValue(CLI_ARGS.COMPARE_USERJS);
+
+    await diff({ compareUserJS, oldVersion, newVersion });
   }
 }
 
-export class DefaultPrefsUserJSCommand extends BaseCli {
-  public static readonly COMMAND = "default-prefs-userjs";
+class UnusedPrefCommand extends BaseCli {
+  public static readonly COMMAND = "unused-prefs-userjs";
   public static readonly SMALL_DESCRIPTION = undefined;
   public static readonly DESCRIPTION =
-    "Identify default preferences from your user.js file";
+    "Identify unused preferences from your user.js file";
   public static readonly COMMANDS: readonly CliCommand[] = [pathUsageUserJS];
-  public static readonly OPTIONS: readonly CliOption[] = [
-    pathToFirefox,
-    ...printAndSave,
-  ];
+  public static readonly OPTIONS: readonly CliOption[] = [pathToFirefox];
 
   constructor(fail: boolean = true) {
     super(
       fail,
-      DefaultPrefsUserJSCommand.DESCRIPTION,
-      DefaultPrefsUserJSCommand.COMMANDS,
-      DefaultPrefsUserJSCommand.OPTIONS,
+      UnusedPrefCommand.DESCRIPTION,
+      UnusedPrefCommand.COMMANDS,
+      UnusedPrefCommand.OPTIONS,
     );
   }
 
   public async entrypoint(): Promise<void> {
-    await defaultPrefsUserJS();
+    const [, , , compareUserjs] = process.argv;
+    if (compareUserjs === undefined) {
+      this.usage();
+    }
+    await unusedPrefs(compareUserjs);
   }
 }
 
@@ -378,6 +411,7 @@ export const ALL_COMMANDS = [
   UnusedPrefCommand,
   DefaultPrefsUserJSCommand,
 ];
+
 export class Cli extends BaseCli {
   public static readonly COMMANDS: readonly CliCommand[] = ALL_COMMANDS.map(
     (cmd) => ({