pushwork 1.0.4 → 1.0.7

package/src/cli.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
-import { Command } from "commander";
+import { StorageId } from "@automerge/automerge-repo";
+import { Command } from "@commander-js/extra-typings";
 import chalk from "chalk";
 import {
   init,
@@ -12,319 +13,392 @@ import {
   checkout,
   commit,
   url,
-  debug,
-} from "./cli/commands";
+  rm,
+  ls,
+  config,
+  watch,
+} from "./commands";
 
-/**
- * Wrapper for command actions with consistent error handling
- */
-function withErrorHandling<T extends any[], R>(
-  fn: (...args: T) => Promise<R>
-): (...args: T) => Promise<void> {
-  return async (...args: T): Promise<void> => {
-    try {
-      await fn(...args);
-    } catch (error) {
-      console.error(chalk.red(`Error: ${error}`));
-      process.exit(1);
-    }
-  };
-}
-
-const program = new Command();
-
-// get the version from the package.json
 const version = require("../package.json").version;
-
-program
+const program = new Command()
   .name("pushwork")
   .description("Bidirectional directory synchronization using Automerge CRDTs")
-  .version(version);
+  .version(version, "-V, --version", "output the version number");
 
 // Init command
 program
   .command("init")
-  .description("Initialize sync in directory")
-  .argument("<path>", "Directory path to initialize")
-  .option(
-    "--sync-server <url>",
-    "Custom sync server URL (must be used with --sync-server-storage-id)"
+  .summary("Initialize sync in a directory")
+  .argument(
+    "[path]",
+    "Directory path to initialize (default: current directory)",
+    "."
   )
   .option(
-    "--sync-server-storage-id <id>",
-    "Custom sync server storage ID (must be used with --sync-server)"
+    "--sync-server <url> <storage-id...>",
+    "Custom sync server URL and storage ID"
   )
-  .addHelpText(
-    "after",
-    `
-Examples:
-  pushwork init ./my-folder
-  pushwork init ./my-folder --sync-server ws://localhost:3030 --sync-server-storage-id 1d89eba7-f7a4-4e8e-80f2-5f4e2406f507
-  
-Note: Custom sync server options must always be used together.`
-  )
-  .action(
-    withErrorHandling(async (path: string, options) => {
-      // Validate that both sync server options are provided together
-      const hasSyncServer = !!options.syncServer;
-      const hasSyncServerStorageId = !!options.syncServerStorageId;
-
-      if (hasSyncServer && !hasSyncServerStorageId) {
-        console.error(
-          chalk.red("Error: --sync-server requires --sync-server-storage-id")
-        );
-        console.error(
-          chalk.yellow("Both arguments must be provided together.")
-        );
-        process.exit(1);
-      }
-
-      if (hasSyncServerStorageId && !hasSyncServer) {
-        console.error(
-          chalk.red("Error: --sync-server-storage-id requires --sync-server")
-        );
-        console.error(
-          chalk.yellow("Both arguments must be provided together.")
-        );
-        process.exit(1);
-      }
-
-      await init(path, options.syncServer, options.syncServerStorageId);
-    })
-  );
+  .action(async (path, opts) => {
+    const [syncServer, syncServerStorageId] = validateSyncServer(
+      opts.syncServer
+    );
+    await init(path, { syncServer, syncServerStorageId });
+  });
 
 // Clone command
 program
   .command("clone")
-  .description("Clone an existing synced directory")
-  .argument("<url>", "AutomergeUrl of root directory to clone")
-  .argument("<path>", "Target directory path")
-  .option("--force", "Overwrite existing directory")
-  .option(
-    "--sync-server <url>",
-    "Custom sync server URL (must be used with --sync-server-storage-id)"
+  .summary("Clone an existing synced directory")
+  .argument(
+    "<url>",
+    "AutomergeUrl of root directory to clone (format: automerge:XXXXX)"
   )
+  .argument("<path>", "Target directory path")
+  .option("-f, --force", "Overwrite existing directory", false)
   .option(
-    "--sync-server-storage-id <id>",
-    "Custom sync server storage ID (must be used with --sync-server)"
+    "--sync-server <url> <storage-id...>",
+    "Custom sync server URL and storage ID"
   )
-  .addHelpText(
-    "after",
-    `
-Examples:
-  pushwork clone automerge:abc123 ./my-clone
-  pushwork clone automerge:abc123 ./my-clone --force
-  pushwork clone automerge:abc123 ./my-clone --sync-server ws://localhost:3030 --sync-server-storage-id 1d89eba7-f7a4-4e8e-80f2-5f4e2406f507
-  
-Note: Custom sync server options must always be used together.`
-  )
-  .action(
-    withErrorHandling(async (url: string, path: string, options) => {
-      // Validate that both sync server options are provided together
-      const hasSyncServer = !!options.syncServer;
-      const hasSyncServerStorageId = !!options.syncServerStorageId;
-
-      if (hasSyncServer && !hasSyncServerStorageId) {
-        console.error(
-          chalk.red("Error: --sync-server requires --sync-server-storage-id")
-        );
-        console.error(
-          chalk.yellow("Both arguments must be provided together.")
-        );
-        process.exit(1);
-      }
-
-      if (hasSyncServerStorageId && !hasSyncServer) {
-        console.error(
-          chalk.red("Error: --sync-server-storage-id requires --sync-server")
-        );
-        console.error(
-          chalk.yellow("Both arguments must be provided together.")
-        );
-        process.exit(1);
-      }
-
-      await clone(url, path, {
-        force: options.force || false,
-        dryRun: false,
-        verbose: false,
-        syncServer: options.syncServer,
-        syncServerStorageId: options.syncServerStorageId,
-      });
-    })
-  );
+  .option("-v, --verbose", "Verbose output", false)
+  .action(async (url, path, opts) => {
+    const [syncServer, syncServerStorageId] = validateSyncServer(
+      opts.syncServer
+    );
+    await clone(url, path, {
+      force: opts.force,
+      verbose: opts.verbose,
+      syncServer,
+      syncServerStorageId,
+    });
+  });
 
 // Commit command
 program
   .command("commit")
-  .description("Commit local changes (no network sync)")
-  .argument("[path]", "Directory path to commit", ".")
-  .option("--dry-run", "Show what would be committed without applying changes")
-  .action(
-    withErrorHandling(async (path: string, options) => {
-      await commit(path, options.dryRun || false);
-    })
-  );
+  .summary("Save local changes to Automerge documents")
+  .argument(
+    "[path]",
+    "Directory path to commit (default: current directory)",
+    "."
+  )
+  .action(async (path, _opts) => {
+    await commit(path);
+  });
 
 // Sync command
 program
   .command("sync")
-  .description("Run full bidirectional synchronization")
-  .option("--dry-run", "Show what would be done without applying changes")
-  .option("-v, --verbose", "Verbose output")
-  .action(
-    withErrorHandling(async (options) => {
-      await sync({
-        dryRun: options.dryRun || false,
-        verbose: options.verbose || false,
-      });
-    })
-  );
+  .summary("Run full bidirectional synchronization")
+  .argument(
+    "[path]",
+    "Directory path to sync (default: current directory)",
+    "."
+  )
+  .option(
+    "--dry-run",
+    "Show what would be done without applying changes",
+    false
+  )
+  .option("-v, --verbose", "Verbose output", false)
+  .action(async (path, opts) => {
+    await sync(path, {
+      dryRun: opts.dryRun,
+      verbose: opts.verbose,
+    });
+  });
 
 // Diff command
 program
   .command("diff")
-  .description("Show changes in working directory since last sync")
-  .argument("[path]", "Limit diff to specific path", ".")
-  .option("--tool <tool>", "Use external diff tool (meld, vimdiff, etc.)")
-  .option("--name-only", "Show only changed file names")
-  .action(
-    withErrorHandling(async (path: string, options) => {
-      await diff(path, {
-        tool: options.tool,
-        nameOnly: options.nameOnly || false,
-        dryRun: false,
-        verbose: false,
-      });
-    })
-  );
+  .summary("Show changes in working directory")
+  .argument(
+    "[path]",
+    "Limit diff to specific path (default: current directory)",
+    "."
+  )
+  .option("--name-only", "Show only changed file names", false)
+  .action(async (path, opts) => {
+    await diff(path, {
+      nameOnly: opts.nameOnly,
+    });
+  });
 
 // Status command
 program
   .command("status")
-  .description("Show sync status summary")
-  .action(
-    withErrorHandling(async (options) => {
-      await status();
-    })
-  );
+  .summary("Show sync status summary")
+  .argument("[path]", "Directory path (default: current directory)", ".")
+  .option(
+    "-v, --verbose",
+    "Show detailed status including document info and all tracked files",
+    false
+  )
+  .action(async (path, opts) => {
+    await status(path, {
+      verbose: opts.verbose,
+    });
+  });
 
 // Log command
 program
   .command("log")
-  .description("Show sync history")
-  .argument("[path]", "Show history for specific file or directory", ".")
-  .option("--oneline", "Compact one-line per sync format")
+  .summary("Show sync history (experimental)")
+  .argument(
+    "[path]",
+    "Show history for specific file or directory (default: current directory)",
+    "."
+  )
+  .option("--oneline", "Compact one-line per sync format", false)
   .option("--since <date>", "Show syncs since date")
   .option("--limit <n>", "Limit number of syncs shown", "10")
-  .action(
-    withErrorHandling(async (path: string, options) => {
-      await log(path, {
-        oneline: options.oneline || false,
-        since: options.since,
-        limit: parseInt(options.limit),
-        dryRun: false,
-        verbose: false,
-      });
-    })
-  );
+  .action(async (path, opts) => {
+    await log(path, {
+      oneline: opts.oneline,
+      since: opts.since,
+      limit: parseInt(opts.limit),
+    });
+  });
 
 // Checkout command
 program
   .command("checkout")
-  .description("Restore directory to state from previous sync")
+  .summary("Restore to previous sync (experimental)")
   .argument("<sync-id>", "Sync ID to restore to")
-  .argument("[path]", "Specific path to restore", ".")
-  .option("-f, --force", "Force checkout even if there are uncommitted changes")
-  .action(
-    withErrorHandling(async (syncId: string, path: string, options) => {
-      await checkout(syncId, path, {
-        force: options.force || false,
-        dryRun: false,
-        verbose: false,
-      });
-    })
-  );
+  .argument(
+    "[path]",
+    "Specific path to restore (default: current directory)",
+    "."
+  )
+  .option(
+    "-f, --force",
+    "Force checkout even if there are uncommitted changes",
+    false
+  )
+  .action(async (syncId, path, opts) => {
+    await checkout(syncId, path, {
+      force: opts.force,
+    });
+  });
 
 // URL command
 program
   .command("url")
-  .description("Show the Automerge root URL for this repository")
-  .argument("[path]", "Directory path", ".")
-  .addHelpText(
-    "after",
-    `
-Examples:
-  pushwork url           # Show URL for current directory
-  pushwork url ./repo    # Show URL for specific directory
-  
-Note: This command outputs only the URL, making it useful for scripts.`
+  .summary("Show the Automerge root URL")
+  .argument("[path]", "Directory path (default: current directory)", ".")
+  .action(async (path) => {
+    await url(path);
+  });
+
+// Remove command
+program
+  .command("rm")
+  .summary("Remove local pushwork data")
+  .argument("[path]", "Directory path (default: current directory)", ".")
+  .action(async (path) => {
+    await rm(path);
+  });
+
+// List command
+program
+  .command("ls")
+  .summary("List tracked files")
+  .argument("[path]", "Directory path (default: current directory)", ".")
+  .option("-v, --verbose", "Show with Automerge URLs", false)
+  .action(async (path, opts) => {
+    await ls(path, {
+      verbose: opts.verbose,
+    });
+  });
+
+// Config command
+program
+  .command("config")
+  .summary("View or edit configuration")
+  .argument("[path]", "Directory path (default: current directory)", ".")
+  .option("--list", "Show full configuration", false)
+  .option(
+    "--get <key>",
+    "Get specific config value (dot notation, e.g., sync.move_detection_threshold)"
   )
-  .action(
-    withErrorHandling(async (path: string) => {
-      await url(path);
-    })
-  );
+  .action(async (path, opts) => {
+    await config(path, {
+      list: opts.list,
+      get: opts.get,
+    });
+  });
 
-// Debug command
+// Watch command
 program
-  .command("debug")
-  .description("Show internal debug information including lastSyncAt timestamp")
-  .argument("[path]", "Directory path", ".")
+  .command("watch")
+  .summary("Watch directory for changes, build, and sync")
+  .argument(
+    "[path]",
+    "Directory path to sync (default: current directory)",
+    "."
+  )
   .option(
-    "-v, --verbose",
-    "Show verbose debug information including full document contents"
+    "--script <command>",
+    "Build script to run before syncing",
+    "pnpm build"
   )
-  .addHelpText(
-    "after",
-    `
-Examples:
-  pushwork debug           # Show debug info for current directory
-  pushwork debug --verbose # Show verbose debug info including full document contents
-  pushwork debug ./repo    # Show debug info for specific directory
-  
-This command displays internal document state, including the lastSyncAt timestamp
-that gets updated when sync operations make changes.`
+  .option(
+    "--dir <dir>",
+    "Directory to watch for changes (relative to working directory)",
+    "src"
   )
-  .action(
-    withErrorHandling(async (path: string, options) => {
-      await debug(path, {
-        verbose: options.verbose || false,
-      });
+  .option("-v, --verbose", "Show build script output", false)
+  .action(async (path, opts) => {
+    await watch(path, {
+      script: opts.script,
+      watchDir: opts.dir,
+      verbose: opts.verbose,
+    });
+  });
+
+// Completion command (hidden from help)
+program.command("completion", { hidden: true }).action(() => {
+  // Generate completion dynamically from registered commands
+  const commands = program.commands
+    .filter((cmd) => cmd.name() !== "completion") // Exclude self
+    .map((cmd) => {
+      const name = cmd.name();
+      const desc = (cmd.summary() || cmd.description() || "").replace(
+        /'/g,
+        "\\'"
+      );
+      return `'${name}:${desc}'`;
     })
-  );
+    .join(" ");
 
-// Global error handler
-process.on("unhandledRejection", (reason, promise) => {
-  console.error(
-    chalk.red("Unhandled Rejection at:"),
-    promise,
-    chalk.red("reason:"),
-    reason
-  );
-  process.exit(1);
+  // Generate option completions for each command
+  const commandCases = program.commands
+    .filter((cmd) => cmd.name() !== "completion")
+    .map((cmd) => {
+      const options = cmd.options
+        .filter((opt) => opt.flags !== "-h, --help") // Exclude help
+        .map((opt) => {
+          // Parse flags like "-v, --verbose" or "--dry-run"
+          const flags = opt.flags.split(",").map((f) => f.trim());
+          const desc = (opt.description || "")
+            .replace(/'/g, "\\'")
+            .replace(/\n/g, " ");
+
+          // For options with arguments like "--sync-server <url>"
+          // Extract just the flag part
+          const cleanFlags = flags.map((f) => f.split(/\s+/)[0]);
+
+          if (cleanFlags.length > 1) {
+            // Multiple flags (short and long): '(-v --verbose)'{-v,--verbose}'[description]'
+            const short = cleanFlags[0];
+            const long = cleanFlags[1];
+            return `'(${short} ${long})'{${short},${long}}'[${desc}]'`;
+          } else {
+            // Single flag: '--flag[description]'
+            return `'${cleanFlags[0]}[${desc}]'`;
+          }
+        })
+        .join(" \\\n        ");
+
+      return options
+        ? `    ${cmd.name()})
+      _arguments \\
+        ${options}
+      ;;`
+        : "";
+    })
+    .filter(Boolean)
+    .join("\n");
+
+  const completionScript = `
+# pushwork completion for zsh
+_pushwork() {
+  local -a commands
+  commands=(${commands})
+  
+  _arguments -C \\
+    '1: :->command' \\
+    '*::arg:->args'
+  
+  case $state in
+    command)
+      _describe 'command' commands
+      ;;
+    args)
+      case $words[1] in
+${commandCases}
+      esac
+      ;;
+  esac
+}
+
+compdef _pushwork pushwork
+    `.trim();
+
+  console.log(completionScript);
 });
 
-process.on("uncaughtException", (error) => {
-  // Ignore WebSocket errors during shutdown - they're non-critical
-  const errorMessage = error instanceof Error ? error.message : String(error);
-  if (
-    errorMessage.includes("WebSocket") ||
-    errorMessage.includes("connection was established") ||
-    errorMessage.includes("was closed")
-  ) {
-    // Silently ignore WebSocket shutdown errors
-    return;
+// Helper to validate and extract sync server options
+function validateSyncServer(
+  syncServerOpt: string[] | undefined
+): [string | undefined, StorageId | undefined] {
+  if (!syncServerOpt) {
+    return [undefined, undefined];
   }
 
-  console.error(chalk.red("Uncaught Exception:"), error);
+  if (syncServerOpt.length < 2) {
+    console.error(
+      chalk.red("Error: --sync-server requires both URL and storage ID")
+    );
+    process.exit(1);
+  }
+
+  const [syncServer, syncServerStorageId] = syncServerOpt;
+  return [syncServer, syncServerStorageId as StorageId];
+}
+
+process.on("unhandledRejection", (error) => {
+  console.log(chalk.bgRed.white(" ERROR "));
+  if (error instanceof Error && error.stack) {
+    console.log(chalk.red(error.stack));
+  } else {
+    console.error(chalk.red(error));
+  }
   process.exit(1);
 });
 
-// Parse arguments
-program.parse();
+// Configure help colors using Commander v13's built-in color support
+program
+  .configureHelp({
+    styleTitle: (str) => chalk.bold(str),
+    styleCommandText: (str) => chalk.white(str),
+    styleCommandDescription: (str) => chalk.dim(str),
+    styleOptionText: (str) => chalk.green(str),
+    styleArgumentText: (str) => chalk.cyan(str),
+    subcommandTerm: (cmd) => {
+      const opts = cmd.options
+        .filter((opt) => opt.flags !== "-h, --help")
+        .map((opt) => opt.short || opt.long)
+        .join(", ");
 
-// Show help if no arguments provided
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-}
+      const name = chalk.white(cmd.name());
+      const args = cmd.registeredArguments
+        .map((arg) =>
+          arg.required
+            ? chalk.cyan(`<${arg.name()}>`)
+            : chalk.dim(`[${arg.name()}]`)
+        )
+        .join(" ");
+
+      return [name, args, opts && chalk.dim(`[${opts}]`)]
+        .filter(Boolean)
+        .join(" ");
+    },
+  })
+  .addHelpText(
+    "after",
+    chalk.dim(
+      '\nEnable tab completion by adding this to your ~/.zshrc:\neval "$(pushwork completion)"'
+    )
+  );
+
+program.parseAsync();