@reshotdev/screenshot 0.0.1-beta.0

package/src/index.js

@@ -0,0 +1,462 @@
+#!/usr/bin/env node
+
+// index.js - Reshot CLI entry point
+// Consolidated command structure for ease of use while maintaining power features
+
+require("dotenv").config({
+  path: require("path").join(__dirname, "..", ".env"),
+});
+
+const { Command } = require("commander");
+const chalk = require("chalk");
+const pkg = require("../package.json");
+
+const program = new Command();
+
+program
+  .name("reshot")
+  .description("Visual documentation that stays in sync")
+  .version(pkg.version);
+
+// ============================================================================
+// CORE COMMANDS (Primary workflow)
+// ============================================================================
+
+// Setup: Interactive wizard for initial configuration
+program
+  .command("setup")
+  .description("Interactive setup wizard (auth, config, features)")
+  .option("--offline", "Skip authentication (local-only mode)")
+  .option("--force", "Force re-initialization even if already set up")
+  .action(async (options) => {
+    try {
+      const setupWizard = require("./commands/setup-wizard");
+      await setupWizard(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Sync: Upload traces and documentation to platform
+program
+  .command("sync")
+  .description("Upload Playwright traces and documentation to Reshot")
+  .option("--trace-dir <path>", "Path to test-results directory")
+  .option("--traces", "Sync traces only")
+  .option("--docs", "Sync documentation only")
+  .option("--dry-run", "Preview what would be synced")
+  .option("-v, --verbose", "Show detailed output")
+  .action(async (options) => {
+    try {
+      const syncCommand = require("./commands/sync");
+      await syncCommand({
+        traceDir: options.traceDir,
+        traces: options.traces,
+        docs: options.docs,
+        dryRun: options.dryRun,
+        verbose: options.verbose,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Status: View project status, sync jobs, and drift summary
+program
+  .command("status")
+  .description("View project status, sync history, and drift summary")
+  .option("--jobs", "Show only sync job history")
+  .option("--drifts", "Show only drift queue")
+  .option("--config", "Show only configuration")
+  .option("--limit <n>", "Limit number of items shown", parseInt)
+  .option("--json", "Output as JSON")
+  .action(async (options) => {
+    try {
+      const statusCommand = require("./commands/status");
+      await statusCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Studio: Launch visual management UI
+program
+  .command("studio")
+  .description("Launch Reshot Studio (visual management UI)")
+  .option("--port <port>", "Port for web UI", "4300")
+  .option("--host <host>", "Host for web UI", "127.0.0.1")
+  .option("--no-open", "Do not automatically open browser")
+  .action(async (options) => {
+    try {
+      const uiCommand = require("./commands/ui");
+      await uiCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Validate: Check configuration and documentation bindings
+program
+  .command("validate")
+  .description("Validate configuration and documentation bindings")
+  .option("--strict", "Fail on warnings (zombie links, unbound files)")
+  .option("--fix", "Attempt to auto-fix issues where possible")
+  .option("-v, --verbose", "Show detailed validation output")
+  .action(async (options) => {
+    try {
+      const validateCommand = require("./commands/validate-docs");
+      if (typeof validateCommand.validateDocSync === "function") {
+        await validateCommand.validateDocSync(options);
+      } else {
+        await validateCommand.validateDocs(options);
+      }
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// ============================================================================
+// VISUAL CAPTURE COMMANDS
+// ============================================================================
+
+// Run: Execute scenarios from config (automated visual capture)
+program
+  .command("run")
+  .description("Execute visual capture scenarios from config")
+  .option("-s, --scenarios <keys>", "Comma-separated list of scenario keys")
+  .option("--no-headless", "Run browser in visible mode")
+  .option("--variant <json>", "Override variant configuration as JSON")
+  .option("--all-variants", "Run all configured variant combinations")
+  .option("--no-variants", "Skip variant expansion")
+  .option(
+    "-f, --format <format>",
+    "Output format: step-by-step-images | summary-video",
+  )
+  .option(
+    "-c, --concurrency <n>",
+    "Number of parallel browser workers",
+    parseInt,
+  )
+  .option("--diff", "Enable baseline comparison")
+  .option("--no-diff", "Disable baseline comparison")
+  .option("--no-privacy", "Disable privacy masking")
+  .option("--no-style", "Disable style processing")
+  .option("--cloud", "Compare against cloud baselines")
+  .option("--debug", "Enable verbose debug logging")
+  .action(async (options) => {
+    if (options.debug) {
+      process.env.RESHOT_DEBUG = "1";
+    }
+    try {
+      const runCommand = require("./commands/run");
+      const scenarioKeys = options.scenarios
+        ? options.scenarios.split(",").map((s) => s.trim())
+        : null;
+      await runCommand({
+        scenarioKeys,
+        headless: options.headless,
+        variant: options.variant,
+        allVariants: options.allVariants,
+        noVariants: options.variants === false,
+        noPrivacy: options.privacy === false,
+        noStyle: options.style === false,
+        format: options.format,
+        diff: options.diff,
+        cloud: options.cloud,
+        concurrency: options.concurrency,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      if (options.debug && error.stack) {
+        console.error(chalk.gray(error.stack));
+      }
+      process.exit(1);
+    }
+  });
+
+// Record: Interactive visual recording from live browser
+program
+  .command("record [title]")
+  .description("Interactively record visuals from a live browser session")
+  .option("--browser", "Launch Chrome with remote debugging before recording")
+  .option("-p, --port <port>", "Chrome debugging port (default: 9222)")
+  .option("--url <url>", "URL to open when launching browser")
+  .option("--debug", "Enable verbose debug logging")
+  .action(async (title, options) => {
+    if (options.debug) {
+      process.env.RESHOT_DEBUG = "1";
+    }
+    try {
+      // If --browser flag, launch Chrome first
+      if (options.browser) {
+        const chromeCommand = require("./commands/chrome");
+        await chromeCommand({
+          port: options.port || "9222",
+          url: options.url || "about:blank",
+        });
+        // Give Chrome time to start
+        await new Promise((resolve) => setTimeout(resolve, 2000));
+      }
+
+      const recordCommand = require("./commands/record");
+      await recordCommand(title);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      if (options.debug && error.stack) {
+        console.error(chalk.gray(error.stack));
+      }
+      process.exit(1);
+    }
+  });
+
+// Import tests: Import existing Playwright tests into Reshot
+program
+  .command("import-tests")
+  .description("Import existing Playwright tests and create journey mappings")
+  .option("--dry-run", "Preview mappings without saving")
+  .option("--no-interactive", "Run without prompts")
+  .action(async (options) => {
+    try {
+      const importTestsCommand = require("./commands/import-tests");
+      await importTestsCommand({
+        dryRun: options.dryRun,
+        interactive: options.interactive,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// ============================================================================
+// PUBLISHING & INTEGRATION COMMANDS
+// ============================================================================
+
+// Publish: Upload generated assets to platform with versioning
+program
+  .command("publish")
+  .description("Publish visual assets to Reshot platform")
+  .option("--tag <tag>", "Version tag (e.g., v1.2, release-2024-01)")
+  .option("-m, --message <message>", "Commit message for this publish")
+  .option("--video <path>", "Explicit video file to upload with this publish")
+  .option("--dry-run", "Preview without uploading")
+  .option("-f, --force", "Skip confirmation prompts")
+  .option("--output-json", "Write structured result to .reshot/output/publish-result.json")
+  .action(async (options) => {
+    try {
+      const publishCommand = require("./commands/publish");
+      await publishCommand({
+        ...options,
+        outputJson: options.outputJson,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Pull: Generate asset map for build pipelines
+program
+  .command("pull")
+  .description("Pull asset map for your build pipeline")
+  .option("-f, --format <format>", "Output format: json, ts, csv", "json")
+  .option("-o, --output <path>", "Output file path")
+  .option("--full", "Include full metadata in TypeScript output")
+  .option("--status <status>", "Filter: approved, pending, all", "approved")
+  .action(async (options) => {
+    try {
+      const pullCommand = require("./commands/pull");
+      await pullCommand({
+        format: options.format,
+        output: options.output,
+        full: options.full,
+        status: options.status,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// CI: CI/CD integration commands
+const ciCommand = program
+  .command("ci")
+  .description("CI/CD integration commands");
+
+ciCommand
+  .command("setup")
+  .description("Interactive CI/CD setup wizard (GitHub Actions, etc.)")
+  .action(async () => {
+    try {
+      const ciSetup = require("./commands/ci-setup");
+      await ciSetup();
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+ciCommand
+  .command("run")
+  .description("Run capture + publish in one step (CI-optimized)")
+  .option("-c, --config <path>", "Path to docsync.config.json")
+  .option("--tag <tag>", "Version tag for publish")
+  .option("-m, --message <message>", "Commit message for publish")
+  .option("--dry-run", "Preview without uploading")
+  .option("--no-publish", "Run capture only, skip publish")
+  .action(async (options) => {
+    try {
+      const ciRun = require("./commands/ci-run");
+      await ciRun(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// ============================================================================
+// DRIFT MANAGEMENT COMMANDS
+// ============================================================================
+
+// Drifts: View and manage documentation drifts
+program
+  .command("drifts [action] [id]")
+  .description("View and manage documentation drifts")
+  .addHelpText(
+    "after",
+    `
+Actions:
+  list              List all drifts (default)
+  show <id>         Show drift details
+  approve <id>      Approve a drift
+  reject <id>       Reject a drift
+  ignore <id>       Mark drift as ignored
+  sync <id>         Mark as manually synced (external_host)
+  approve-all       Approve all pending drifts
+  reject-all        Reject all pending drifts
+  validate          Validate journey bindings
+`,
+  )
+  .option("--status <status>", "Filter: PENDING, APPROVED, REJECTED, IGNORED")
+  .option("--journey <key>", "Filter by journey key")
+  .option("-v, --verbose", "Show detailed information")
+  .action(async (action, id, options) => {
+    try {
+      const driftsCommand = require("./commands/drifts");
+      // Map action/id to the expected subcommand/args format
+      const subcommand = action || "list";
+      const args = id ? [id] : [];
+      await driftsCommand(subcommand, args, options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// ============================================================================
+// UTILITY COMMANDS (Hidden from main help, but available)
+// ============================================================================
+
+// Auth: Standalone authentication (for re-auth scenarios)
+program
+  .command("auth", { hidden: true })
+  .description("Authenticate with Reshot Cloud")
+  .action(async () => {
+    try {
+      const authCommand = require("./commands/auth");
+      await authCommand();
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Init: Standalone initialization (for manual config)
+program
+  .command("init", { hidden: true })
+  .description("Initialize Reshot configuration")
+  .action(async () => {
+    try {
+      const initCommand = require("./commands/init");
+      await initCommand();
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Chrome: Launch Chrome with debugging (absorbed into record --browser)
+program
+  .command("chrome", { hidden: true })
+  .description("Launch Chrome with remote debugging")
+  .option("-p, --port <port>", "Remote debugging port", "9222")
+  .option("--url <url>", "URL to open after launch", "about:blank")
+  .action(async (options) => {
+    try {
+      const chromeCommand = require("./commands/chrome");
+      await chromeCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Ingest: Alias for sync (backward compatibility)
+program
+  .command("ingest", { hidden: true })
+  .description("Upload traces and docs (alias for sync)")
+  .option("--trace-dir <path>", "Path to test-results directory")
+  .option("--dry-run", "Preview what would be synced")
+  .action(async (options) => {
+    console.log(
+      chalk.yellow("Note: 'ingest' is now 'sync'. Running sync...\n"),
+    );
+    try {
+      const syncCommand = require("./commands/sync");
+      await syncCommand({
+        traceDir: options.traceDir,
+        dryRun: options.dryRun,
+      });
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// UI: Alias for studio (backward compatibility)
+program
+  .command("ui", { hidden: true })
+  .description("Launch Reshot Studio (alias for studio)")
+  .option("--port <port>", "Port for web UI", "4300")
+  .option("--host <host>", "Host for web UI", "127.0.0.1")
+  .option("--no-open", "Do not automatically open browser")
+  .action(async (options) => {
+    try {
+      const uiCommand = require("./commands/ui");
+      await uiCommand(options);
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+// Init-docs: Alias hidden (merged into setup wizard)
+program
+  .command("init-docs", { hidden: true })
+  .description("Initialize documentation sync (use setup instead)")
+  .action(async () => {
+    try {
+      const initDocsCommand = require("./commands/init-docs");
+      await initDocsCommand();
+    } catch (error) {
+      console.error(chalk.red("Error:"), error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);