refactor: proper cli with commander

fix: fix path in "checkBroadcast"

Author: PaulRBerg

.vscode/settings.json

@@ -10,5 +10,9 @@
     "source.fixAll.biome": "explicit",
     "source.organizeImports.biome": "explicit"
   },
+  "search.exclude": {
+    "**/data": true,
+    "**/node_modules": true
+  },
   "typescript.tsdk": "node_modules/typescript/lib"
 }

bun.lock

@@ -4,6 +4,7 @@
     "": {
       "name": "@sablier/deployments",
       "dependencies": {
+        "commander": "^14.0.0",
         "lodash": "^4.17",
         "viem": "^2.31",
       },
@@ -165,7 +166,7 @@
 
     "@rollup/rollup-win32-x64-msvc": ["@rollup/[email protected]", "", { "os": "win32", "cpu": "x64" }, "sha512-lpPE1cLfP5oPzVjKMx10pgBmKELQnFJXHgvtHCtuJWOv8MxqdEIMNtgHgBFf7Ea2/7EuVwa9fodWUfXAlXZLZQ=="],
 
-    "@sablier/devkit": ["@sablier/devkit@github:sablier-labs/devkit#f40cb57", {}, "sablier-labs-devkit-f40cb57"],
+    "@sablier/devkit": ["@sablier/devkit@github:sablier-labs/devkit#61ae1a5", {}, "sablier-labs-devkit-61ae1a5"],
 
     "@scure/base": ["@scure/[email protected]", "", {}, "sha512-9rE6EOVeIQzt5TSu4v+K523F8u6DhBsoZWPGKlnCshhlDhy0kJzUX4V+tr2dWmzF1GdekvThABoEQBGBQI7xZw=="],
 
@@ -261,7 +262,7 @@
 
     "combined-stream": ["[email protected]", "", { "dependencies": { "delayed-stream": "~1.0.0" } }, "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg=="],
 
-    "commander": ["commander@13.1.0", "", {}, "sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw=="],
+    "commander": ["commander@14.0.0", "", {}, "sha512-2uM9rYjPvyq39NwLRqaiLtWHyDC1FvryJDa2ATTVims5YAS4PupsEQsDvP14FqhFr0P49CYDugi59xaxJlTXRA=="],
 
     "cross-spawn": ["[email protected]", "", { "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" } }, "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA=="],
 
@@ -609,6 +610,8 @@
 
     "execa/is-stream": ["[email protected]", "", {}, "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA=="],
 
+    "lint-staged/commander": ["[email protected]", "", {}, "sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw=="],
+
     "log-update/slice-ansi": ["[email protected]", "", { "dependencies": { "ansi-styles": "^6.2.1", "is-fullwidth-code-point": "^5.0.0" } }, "sha512-bSiSngZ/jWeX93BqeIAbImyTbEihizcwNjFoRUIY/T1wWQsfsm2Vw1agPKylXvQTU7iASGdHhyqRlqQzfz+Htg=="],
 
     "micromatch/picomatch": ["[email protected]", "", {}, "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA=="],

cli/print/aliases.ts renamed to cli/commands/print/aliases.ts

@@ -1,5 +1,6 @@
 import { logger } from "@src/internal/logger";
 import { sablier } from "@src/sablier";
+import { Command } from "commander";
 import _ from "lodash";
 
 type AliasRow = {
@@ -8,7 +9,7 @@ type AliasRow = {
   releaseName: string;
 };
 
-async function main(): Promise<void> {
+async function printAliases(): Promise<void> {
   const rows: AliasRow[] = [];
 
   for (const release of sablier.releases.getAll()) {
@@ -55,4 +56,6 @@ async function main(): Promise<void> {
   }
 }
 
-main();
+export const aliasesCommand = new Command("aliases")
+  .description("Display all contract aliases across releases")
+  .action(printAliases);

cli/commands/print/chains.ts

@@ -0,0 +1,21 @@
+import { mainnets, testnets } from "@src/chains";
+import { Command } from "commander";
+import _ from "lodash";
+
+export const chainCommand = new Command("chains")
+  .description("List all supported mainnet and testnet chains")
+  .action(() => {
+    console.log("🌐 Mainnets:");
+    console.log(
+      _.values(mainnets)
+        .map((c) => `• ${c.slug}`)
+        .join("\n"),
+    );
+
+    console.log("\n🧪 Testnets:");
+    console.log(
+      _.values(testnets)
+        .map((c) => `• ${c.slug}`)
+        .join("\n"),
+    );
+  });

cli/print/missing-broadcasts.ts renamed to cli/commands/print/missing-broadcasts.ts

@@ -1,19 +1,9 @@
-/**
- * @file This script checks for missing broadcasts for a given protocol. It will look at the releases
- * and check if the associated broadcasts exist in the data directory. The script does not check
- * for all chains, only the ones listed in the releases.
- *
- * Usage:
- *   bun run cli/print/missing-broadcasts.ts airdrops
- *   bun run cli/print/missing-broadcasts.ts flow
- *   bun run cli/print/missing-broadcasts.ts lockup
- */
-
 import { Protocol } from "@src/enums";
 import { checkBroadcast } from "@src/internal/helpers";
 import { logger } from "@src/internal/logger";
 import { sablier } from "@src/sablier";
 import type { Sablier } from "@src/types";
+import { Command } from "commander";
 import _ from "lodash";
 
 const EMOJIS = {
@@ -26,17 +16,12 @@ const EMOJIS = {
   warning: "⚠️",
 } as const;
 
-/* -------------------------------------------------------------------------- */
-/*                                    MAIN                                    */
-/* -------------------------------------------------------------------------- */
-
-async function main(): Promise<void> {
+async function checkMissingBroadcasts(protocol: Sablier.Protocol): Promise<void> {
   const missing: Record<string, Sablier.Chain[]> = {};
-  const protocolArg = parseArgs();
 
-  console.log(`${EMOJIS.folder} Checking ${protocolArg} broadcasts...\n`);
+  console.log(`${EMOJIS.folder} Checking ${protocol} broadcasts...\n`);
 
-  const releases = sablier.releases.getAll({ protocol: protocolArg });
+  const releases = sablier.releases.getAll({ protocol });
   for (const r of releases) {
     for (const d of r.deployments) {
       const chain = sablier.chains.getOrThrow(d.chainId);
@@ -103,7 +88,6 @@ async function main(): Promise<void> {
     console.log(); // Empty line between versions
   }
 
-  // Print summary
   const totalMissing = _.values(missing).flat().length;
   const mainnetCount = _.values(missing)
     .flat()
@@ -118,27 +102,27 @@ async function main(): Promise<void> {
   console.log(`${EMOJIS.testnet} Missing testnet broadcasts: ${testnetCount}\n`);
 }
 
-main();
-
-/* -------------------------------------------------------------------------- */
-/*                                   HELPERS                                  */
-/* -------------------------------------------------------------------------- */
-
-function parseArgs(): Sablier.Protocol {
-  const protocolArg = process.argv[2] as Sablier.Protocol;
-  const available = _.values(Protocol);
-  if (!protocolArg || !available.includes(protocolArg)) {
-    const msg = `Error: Please provide one of these protocols: ${available.join(", ")}`;
-    logger.error(msg);
-    throw new Error(msg);
-  }
-
-  return protocolArg;
-}
-
 function printSectionHeader(text: string): void {
   const separator = "═".repeat(50);
   console.log(`\n${separator}`);
   console.log(text);
   console.log(`${separator}\n`);
 }
+
+export const missingBroadcastsCommand = new Command("missing-broadcasts")
+  .description("Check for missing broadcasts for a given protocol")
+  .option("-p, --protocol <protocol>", `Protocol to check (${_.values(Protocol).join(", ")})`)
+  .action(async (options: { protocol?: Sablier.Protocol }) => {
+    if (!options.protocol) {
+      logger.error("Error: Protocol is required. Use -p or --protocol to specify.");
+      process.exit(1);
+    }
+
+    const available = _.values(Protocol);
+    if (!available.includes(options.protocol)) {
+      logger.error(`Error: Please provide one of these protocols: ${available.join(", ")}`);
+      process.exit(1);
+    }
+
+    await checkMissingBroadcasts(options.protocol);
+  });

cli/index.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import { aliasesCommand } from "./commands/print/aliases";
+import { chainCommand } from "./commands/print/chains";
+import { missingBroadcastsCommand } from "./commands/print/missing-broadcasts";
+
+const program = new Command();
+
+program.name("sablier-cli").description("CLI for Sablier deployment utilities");
+
+// Create the print subcommand
+const printCommand = new Command("print").description("Print various deployment information");
+
+// Add commands to the print subcommand
+printCommand.addCommand(aliasesCommand);
+printCommand.addCommand(chainCommand);
+printCommand.addCommand(missingBroadcastsCommand);
+
+// Add the print command to the main program
+program.addCommand(printCommand);
+
+// Parse command line arguments
+program.parse();

cli/print/chains.ts

@@ -1,4 +1,5 @@
-set shell := ["bash", "-euo", "pipefail", "-c"]
+# See https://github.com/sablier-labs/devkit/blob/main/just/base.just
+import "./node_modules/@sablier/devkit/just/base.just"
 
 # ---------------------------------------------------------------------------- #
 #                                    RECIPES                                   #
@@ -8,15 +9,6 @@ set shell := ["bash", "-euo", "pipefail", "-c"]
 default:
     just --list
 
-# Check code with Biome
-biome-check:
-    bun biome check .
-
-# Fix code with Biome and update imports
-biome-write:
-    bun biome check --write .
-    bun biome lint --write --only correctness/noUnusedImports .
-
 # Build the project
 build: clean tsc-build
 alias b := build
@@ -25,29 +17,20 @@ alias b := build
 clean:
     bunx rimraf dist
 
-# Run all code checks
-full-check: biome-check prettier-check tsc-check
-alias c := full-check
-alias fc := full-check
-
-# Run all code fixes
-full-write: biome-write prettier-write
-
-# Install dependencies
-install *args:
-    bun install {{ args }}
-
-# Check markdown and yaml files with Prettier
-prettier-check:
-    bun prettier --cache --check "**/*.{md,yml}"
+# Run print CLI commands.
+[group("print")]
+@print-aliases:
+    just cli print aliases
 
-# Fix markdown and yaml files with Prettier
-prettier-write:
-    bun prettier --cache --write "**/*.{md,yml}"
+# Run print CLI commands.
+[group("print")]
+@print-chains:
+    just cli print chains
 
-# Run print CLI script. See the files under ./cli/print for available scripts
-@print script *args:
-    bun run cli/print/{{ script }}.ts {{ args }}
+# Run print CLI commands.
+[group("print")]
+@print-missing-broadcasts protocol:
+    just cli print missing-broadcasts --protocol {{ protocol }}
 
 # Setup Husky
 setup:
@@ -71,6 +54,13 @@ tsc-build:
     bun tsc -p tsconfig.build.json
     bun tsc-alias -p tsconfig.build.json
 
-# Type check TypeScript
-tsc-check:
-    bun tsc -p tsconfig.json --noEmit
+
+# ---------------------------------------------------------------------------- #
+#                               RECIPES: PRIVATE                               #
+# ---------------------------------------------------------------------------- #
+
+
+# Run CLI commands. Usage: just cli <command> [args]
+[private]
+@cli *args:
+    bun run cli {{ args }}

justfile

@@ -18,6 +18,7 @@
     "@types/node": "^22.14",
     "@vitest/ui": "^3.1",
     "axios": "^1.8",
+    "commander": "^14.0.0",
     "fs-extra": "^11.3",
     "globby": "^14.1",
     "husky": "^9.1",

package.json

@@ -3,9 +3,14 @@ import type { Sablier } from "@src/types";
 import * as fs from "fs-extra";
 import { log } from "./logger";
 
-const ROOT_DIR = path.join(__dirname, "..");
+const ROOT_DIR = path.join(__dirname, "..", "..");
 const DATA_DIR = path.join(ROOT_DIR, "data");
 
+// Ensuring that the `ROOT_DIR` is correctly set.
+if (!fs.existsSync(path.join(ROOT_DIR, "package.json"))) {
+  throw new Error("ROOT_DIR is not correctly set");
+}
+
 /**
  * @example
  * data/