Migrate Cliffy commands to clipanion

deno.jsonc

@@ -651,5 +651,8 @@
       "src/resources/projects/website/search/fuse.min.js",
       "src/resources/projects/website/search/quarto-search.js"
     ]
+  },
+  "imports": {
+    "clipanion": "npm:clipanion@^4.0.0-rc.4"
   }
 }

package/src/bld.ts

@@ -1,131 +1,74 @@
 /*
  * package.ts
  *
- * Copyright (C) 2020-2022 Posit Software, PBC
+ * Copyright (C) 2020-2024 Posit Software, PBC
  */
-import { Command } from "cliffy/command/mod.ts";
-import { packageCommand } from "./cmd/pkg-cmd.ts";
-import { configure } from "./common/configure.ts";
+import { Builtins, Cli } from "npm:clipanion";
+import { ConfigureCommand } from "./common/configure.ts";
 import { mainRunner } from "../../src/core/main.ts";
+import { PackageCommand } from "./cmd/pkg-cmd.ts";
 
-import { prepareDist } from "./common/prepare-dist.ts";
-import { updateHtmlDependencies } from "./common/update-html-dependencies.ts";
-import { makeInstallerDeb } from "./linux/installer.ts";
-import { makeInstallerMac } from "./macos/installer.ts";
+import { PrepareDistCommand } from "./common/prepare-dist.ts";
+import { UpdateHTMLDependenciesCommand } from "./common/update-html-dependencies.ts";
+import { MakeInstallerDebCommand } from "./linux/installer.ts";
+import { MakeInstallerMacCommand } from "./macos/installer.ts";
 import {
-  compileQuartoLatexmkCommand,
+  CompileQuartoLatexmkCommand,
 } from "./common/compile-quarto-latexmk.ts";
-import { makeInstallerWindows } from "./windows/installer.ts";
+import { MakeInstallerWindowsCommand } from "./windows/installer.ts";
 
-import { appendLogOptions } from "../../src/core/log.ts";
+import { addLoggingOptions } from "../../src/core/log.ts";
 import {
-  cycleDependenciesCommand,
-  parseSwcLogCommand,
+  CycleDependenciesCommand,
+  ParseSwcLogCommand,
 } from "./common/cyclic-dependencies.ts";
 import {
-  archiveBinaryDependencies,
-  checkBinaryDependencies,
+  ArchiveBinaryDependenciesCommand,
+  CheckBinaryDependenciesCommand,
 } from "./common/archive-binary-dependencies.ts";
-import { updatePandoc } from "./common/update-pandoc.ts";
-import { validateBundle } from "./common/validate-bundle.ts";
-import { makeInstallerExternal } from "./ext/installer.ts";
+import { UpdatePandocCommand } from "./common/update-pandoc.ts";
+import { ValidateBundleCommand } from "./common/validate-bundle.ts";
+import { MakeInstallerExternalCommand } from "./ext/installer.ts";
 
-// Core command dispatch
-export async function quartoBld(args: string[]) {
-  const rootCommand = new Command()
-    .name("quarto-bld [command]")
-    .version("0.1")
-    .description(
-      "Utility that implements packaging and distribution of quarto cli",
-    )
-    .option(
-      "-s, --signing-identity [id:string]",
-      "Signing identity to use when signing any files.",
-      { global: true },
-    )
-    .throwErrors();
+const commands: (typeof PackageCommand)[] = [
+  ArchiveBinaryDependenciesCommand,
+  CheckBinaryDependenciesCommand,
+  CompileQuartoLatexmkCommand,
+  ConfigureCommand,
+  CycleDependenciesCommand,
+  MakeInstallerDebCommand,
+  MakeInstallerExternalCommand,
+  MakeInstallerMacCommand,
+  MakeInstallerWindowsCommand,
+  ParseSwcLogCommand,
+  PrepareDistCommand,
+  UpdateHTMLDependenciesCommand,
+  UpdatePandocCommand,
+  ValidateBundleCommand,
+]
 
-  getCommands().forEach((command) => {
-    rootCommand.command(command.getName(), appendLogOptions(command));
-  });
 
-  await rootCommand.parse(args);
-}
+class QuartoBld extends Cli {
+  constructor() {
+    super({
+      binaryLabel: "Utility that implements packaging and distribution of quarto cli",
+      binaryName: 'quarto-bld',
+      binaryVersion: "0.1",
+    });
 
-if (import.meta.main) {
-  await mainRunner(() => quartoBld(Deno.args));
+    [
+      ...commands,
+      Builtins.HelpCommand
+    ].forEach((command) => {
+      addLoggingOptions(command);
+      this.register(command);
+    });
+  }
 }
 
-// Supported package commands
-function getCommands() {
-  // deno-lint-ignore no-explicit-any
-  const commands: Command<any>[] = [];
-  commands.push(
-    packageCommand(configure)
-      .name("configure")
-      .description(
-        "Configures this machine for running developer version of Quarto",
-      ),
-  );
-  commands.push(
-    packageCommand(updateHtmlDependencies)
-      .name("update-html-dependencies")
-      .description(
-        "Updates Bootstrap, themes, and JS/CSS dependencies based upon the version in configuration",
-      ),
-  );
-  commands.push(
-    packageCommand(archiveBinaryDependencies)
-      .name("archive-bin-deps")
-      .description("Downloads and archives our binary dependencies."),
-  );
-  commands.push(
-    packageCommand(checkBinaryDependencies)
-      .name("check-bin-deps")
-      .description("Checks the paths and URLs of our binary dependencies."),
-  );
-  commands.push(
-    packageCommand(prepareDist)
-      .name("prepare-dist")
-      .description("Prepares the distribution directory for packaging."),
-  );
-  commands.push(
-    packageCommand(validateBundle)
-      .name("validate-bundle")
-      .description("Validate a JS bundle built using prepare-dist")
-  );
-  commands.push(
-    packageCommand(makeInstallerMac)
-      .name("make-installer-mac")
-      .description("Builds Mac OS installer"),
-  );
-  commands.push(
-    packageCommand(makeInstallerDeb)
-      .name("make-installer-deb")
-      .description("Builds Linux deb installer"),
-  );
-  commands.push(
-    packageCommand(makeInstallerWindows)
-      .name("make-installer-win")
-      .description("Builds Windows installer"),
-  );
-  commands.push(
-    packageCommand(makeInstallerExternal)
-      .name("make-installer-dir")
-      .description("Copies Quarto-only files, omitting dependencies, to specified location (for use in third party packaging)"),
-  );
-  commands.push(
-    compileQuartoLatexmkCommand(),
-  );
-  commands.push(
-    cycleDependenciesCommand(),
-  );
-  commands.push(
-    parseSwcLogCommand(),
-  );
-  commands.push(
-    updatePandoc(),
-  );
-
-  return commands;
+if (import.meta.main) {
+  await mainRunner(async () => {
+    const quartoBld = new QuartoBld();
+    await quartoBld.runExit(Deno.args);
+  });
 }

package/src/cmd/pkg-cmd.ts

@@ -1,57 +1,40 @@
 /*
 * pkg-cmd.ts
 *
-* Copyright (C) 2020-2022 Posit Software, PBC
+* Copyright (C) 2020-2024 Posit Software, PBC
 *
 */
-import { Command } from "cliffy/command/mod.ts";
+import { Command, Option } from "npm:clipanion";
 import { join } from "../../../src/deno_ral/path.ts";
 
 import { printConfiguration } from "../common/config.ts";
 
 import {
-  Configuration,
   kValidArch,
   kValidOS,
   readConfiguration,
 } from "../common/config.ts";
 
-export const kLogLevel = "logLevel";
-export const kVersion = "setVersion";
+export abstract class PackageCommand extends Command {
+  arch = Option.String("-a,--arch", {description: "Architecture for this command (" + kValidArch.join(", ") + ")"});
+  os = Option.String("-o,--os", {description: "Operating system for this command (" + kValidOS.join(", ") + ")"});
+  version = Option.String("-sv,--set-version", {description: "Version to set when preparing this distribution"});
 
-export function packageCommand(run: (config: Configuration) => Promise<void>) {
-  return new Command().option(
-    "-sv, --set-version [version:string]",
-    "Version to set when preparing this distribution",
-  ).option(
-    "-o, --os [os:string]",
-    "Operating system for this command (" + kValidOS.join(", ") + ")",
-  )
-    .option(
-      "-a, --arch [arch:string]",
-      "Architecture for this command (" + kValidArch.join(", ") + ")",
-    )
-    // deno-lint-ignore no-explicit-any
-    .action(async (args: Record<string, any>) => {
-      const version = args[kVersion];
-      const os = args["os"];
-      const arch = args["arch"];
+  get config() {
+    return readConfiguration(this.version, this.os, this.arch);
+  }
 
-      // Read the version and configuration
-      const config = readConfiguration(version, os, arch);
-
-      // Set up the bin and share environment for any downstream code
-      Deno.env.set("QUARTO_BIN_PATH", config.directoryInfo.bin);
-      Deno.env.set(
+  async execute() {
+    // Set up the bin and share environment for any downstream code
+    const { directoryInfo } = this.config;
+    Deno.env.set("QUARTO_BIN_PATH", directoryInfo.bin);
+    Deno.env.set(
         "QUARTO_SHARE_PATH",
-        join(config.directoryInfo.src, "resources"),
-      );
-      Deno.env.set("QUARTO_DEBUG", "true");
-
-      // Print the configuration
-      printConfiguration(config);
+        join(directoryInfo.src, "resources"),
+    );
+    Deno.env.set("QUARTO_DEBUG", "true");
 
-      // Run the command
-      await run(config);
-    });
+    // Print the configuration
+    printConfiguration(this.config);
+  }
 }

package/src/common/archive-binary-dependencies.ts

@@ -1,10 +1,11 @@
 /*
  * archive-binary-dependencies.ts
  *
- * Copyright (C) 2020-2022 Posit Software, PBC
+ * Copyright (C) 2020-2024 Posit Software, PBC
  */
 import { join } from "../../../src/deno_ral/path.ts";
 import { info } from "../../../src/deno_ral/log.ts";
+import { Command } from "npm:clipanion";
 
 import { execProcess } from "../../../src/core/process.ts";
 import { Configuration, withWorkingDir } from "./config.ts";
@@ -14,6 +15,7 @@ import {
   kDependencies,
   PlatformDependency,
 } from "./dependencies/dependencies.ts";
+import { PackageCommand } from "../cmd/pkg-cmd.ts";
 
 const kBucket = "s3://rstudio-buildtools/quarto";
 const kBucketBaseUrl = "https://s3.amazonaws.com/rstudio-buildtools/quarto";
@@ -197,3 +199,29 @@ async function download(
     );
   }
 }
+
+export class ArchiveBinaryDependenciesCommand extends PackageCommand {
+  static paths = [["archive-bin-deps"]];
+
+  static usage = Command.Usage({
+    description: "Downloads and archives our binary dependencies.",
+  });
+
+  async execute() {
+    await super.execute();
+    await archiveBinaryDependencies(this.config)
+  }
+}
+
+export class CheckBinaryDependenciesCommand extends PackageCommand {
+  static paths = [["check-bin-deps"]];
+
+  static usage = Command.Usage({
+    description: "Checks the paths and URLs of our binary dependencies.",
+  });
+
+  async execute() {
+    await super.execute();
+    await checkBinaryDependencies(this.config)
+  }
+}