snapdrift 0.2.1 → 0.4.0

package/lib/cli.mjs

@@ -4,10 +4,11 @@ import { execSync } from 'node:child_process';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { runBaselineCapture } from './capture-routes.mjs';
-import { generateDriftReport, shouldFailDriftCheck } from './compare-results.mjs';
+import { loadSnapdriftConfig } from '@snapdrift/adapter-fs';
+import { shouldFailDriftCheck } from '@snapdrift/manifest';
+import { createProvider } from './provider.mjs';
+import { SnapFallbackError, SnapSkipError } from './snap-provider.mjs';
 import { generateHtmlReport } from './report.mjs';
-import { loadSnapdriftConfig } from './snapdrift-config.mjs';
 
 /** @typedef {import('../types/visual-diff-types').VisualDiffSummary} DriftSummary */
 
@@ -24,13 +25,17 @@ export const LOCAL_DIFF_SUBDIR = 'diff';
  *   routes: string[],
  *   baselineDir: string,
  *   currentDir: string,
- *   diffDir: string
+ *   diffDir: string,
+ *   to?: 'snap' | 'local',
+ *   from?: 'snap',
+ *   acceptCrossEngine?: boolean,
+ *   fromSnapAction?: string
  * }} CliOptions
  */
 
 /**
  * Parse CLI arguments from process.argv (or a provided argv array).
- * Supported commands: capture, diff
+ * Supported commands: capture, diff, migrate-baselines, init
  * Supported flags:
  *   --open              Open the HTML report after diff
  *   --config <path>     Path to snapdrift.json (default: .github/snapdrift.json)
@@ -38,6 +43,10 @@ export const LOCAL_DIFF_SUBDIR = 'diff';
  *   --baseline-dir <p>  Override local baseline directory (default: .snapdrift/baseline)
  *   --current-dir <p>   Override local current-capture directory (default: .snapdrift/current)
  *   --diff-dir <p>      Override local diff-output directory (default: .snapdrift/diff)
+ *   --to <snap|local>   Migration target (migrate-baselines command)
+ *   --from <snap>       Migration source (migrate-baselines --to local)
+ *   --accept-cross-engine  Allow importing baselines from a different capture engine
+ *   --from-snap-action <path>  Snap action workflow YAML path (init command)
  *
  * @param {string[]} argv - process.argv
  * @returns {CliOptions}
@@ -53,6 +62,13 @@ export function parseArgs(argv) {
   let baselineDir = path.resolve(LOCAL_SNAPDRIFT_DIR, LOCAL_BASELINE_SUBDIR);
   let currentDir = path.resolve(LOCAL_SNAPDRIFT_DIR, LOCAL_CURRENT_SUBDIR);
   let diffDir = path.resolve(LOCAL_SNAPDRIFT_DIR, LOCAL_DIFF_SUBDIR);
+  /** @type {'snap' | 'local' | undefined} */
+  let to;
+  /** @type {'snap' | undefined} */
+  let from;
+  let acceptCrossEngine = false;
+  /** @type {string | undefined} */
+  let fromSnapAction;
 
   for (let i = 1; i < args.length; i++) {
     const arg = args[i];
@@ -73,10 +89,24 @@ export function parseArgs(argv) {
       currentDir = path.resolve(args[++i]);
     } else if (arg === '--diff-dir' && i + 1 < args.length) {
       diffDir = path.resolve(args[++i]);
+    } else if (arg === '--to' && i + 1 < args.length) {
+      const toVal = args[++i];
+      if (toVal === 'snap' || toVal === 'local') {
+        to = toVal;
+      }
+    } else if (arg === '--from' && i + 1 < args.length) {
+      const fromVal = args[++i];
+      if (fromVal === 'snap') {
+        from = fromVal;
+      }
+    } else if (arg === '--accept-cross-engine') {
+      acceptCrossEngine = true;
+    } else if (arg === '--from-snap-action' && i + 1 < args.length) {
+      fromSnapAction = args[++i];
     }
   }
 
-  return { command, open, configPath, routes, baselineDir, currentDir, diffDir };
+  return { command, open, configPath, routes, baselineDir, currentDir, diffDir, to, from, acceptCrossEngine, fromSnapAction };
 }
 
 /**
@@ -95,10 +125,10 @@ export function printSummary(summary) {
 
   const statusIcon =
     summary.status === 'clean'
-      ? '\u2705' // ✅
+      ? '✅' // ✅
       : summary.status === 'changes-detected'
-        ? '\uD83D\uDFE1' // 🟡
-        : '\u274C'; // ❌
+        ? '🟡' // 🟡
+        : '❌'; // ❌
   const statusLabel =
     summary.status === 'clean'
       ? 'Clean'
@@ -106,7 +136,7 @@ export function printSummary(summary) {
         ? 'Drift detected'
         : summary.status ?? 'Unknown';
 
-  process.stdout.write(`\n${statusIcon}  SnapDrift \u2014 ${statusLabel}\n`);
+  process.stdout.write(`\n${statusIcon}  SnapDrift — ${statusLabel}\n`);
   process.stdout.write(`   Routes:   ${total}\n`);
   process.stdout.write(`   Matched:  ${matched}\n`);
   if (changed > 0) process.stdout.write(`   Changed:  ${changed}\n`);
@@ -118,7 +148,7 @@ export function printSummary(summary) {
     process.stdout.write('\n   Changed routes:\n');
     for (const item of summary.changed) {
       const pct = ((item.mismatchRatio ?? 0) * 100).toFixed(2);
-      process.stdout.write(`     \u2022 ${item.id} (${pct}% diff)\n`);
+      process.stdout.write(`     • ${item.id} (${pct}% diff)\n`);
     }
   }
 
@@ -149,12 +179,29 @@ function openFile(filePath) {
  */
 export async function runCaptureCommand(opts) {
   process.stdout.write(`Capturing baseline to ${opts.baselineDir} ...\n`);
-  const { selectedRouteIds } = await runBaselineCapture({
-    configPath: opts.configPath,
-    routeIds: opts.routes.length > 0 ? opts.routes : undefined,
-    outDir: opts.baselineDir
-  });
-  process.stdout.write(`Captured ${selectedRouteIds.length} route(s) to ${opts.baselineDir}\n`);
+  const { config } = await loadSnapdriftConfig(opts.configPath);
+  const provider = createProvider(config.provider ?? 'local', config);
+  try {
+    const { selectedRouteIds } = await provider.capture({
+      configPath: opts.configPath,
+      routeIds: opts.routes.length > 0 ? opts.routes : undefined,
+      outDir: opts.baselineDir
+    });
+    process.stdout.write(`Captured ${selectedRouteIds.length} route(s) to ${opts.baselineDir}\n`);
+  } catch (error) {
+    if (error instanceof SnapFallbackError) {
+      process.stdout.write('Falling back to local provider for capture...\n');
+      const localProvider = createProvider('local');
+      const { selectedRouteIds } = await localProvider.capture({
+        configPath: opts.configPath,
+        routeIds: opts.routes.length > 0 ? opts.routes : undefined,
+        outDir: opts.baselineDir
+      });
+      process.stdout.write(`Captured ${selectedRouteIds.length} route(s) to ${opts.baselineDir}\n`);
+      return;
+    }
+    throw error;
+  }
 }
 
 /**
@@ -167,12 +214,30 @@ export async function runCaptureCommand(opts) {
 export async function runDiffCommand(opts) {
   process.stdout.write(`Capturing current screenshots to ${opts.currentDir} ...\n`);
   const { config } = await loadSnapdriftConfig(opts.configPath);
+  const provider = createProvider(config.provider ?? 'local', config);
 
-  const currentCapture = await runBaselineCapture({
-    configPath: opts.configPath,
-    routeIds: opts.routes.length > 0 ? opts.routes : undefined,
-    outDir: opts.currentDir
-  });
+  let currentCapture;
+  let usedLocalFallback = false;
+  try {
+    currentCapture = await provider.capture({
+      configPath: opts.configPath,
+      routeIds: opts.routes.length > 0 ? opts.routes : undefined,
+      outDir: opts.currentDir
+    });
+  } catch (error) {
+    if (error instanceof SnapFallbackError) {
+      process.stdout.write('Falling back to local provider for capture...\n');
+      const localProvider = createProvider('local');
+      currentCapture = await localProvider.capture({
+        configPath: opts.configPath,
+        routeIds: opts.routes.length > 0 ? opts.routes : undefined,
+        outDir: opts.currentDir
+      });
+      usedLocalFallback = true;
+    } else {
+      throw error;
+    }
+  }
 
   process.stdout.write('Comparing against baseline ...\n');
 
@@ -184,16 +249,28 @@ export async function runDiffCommand(opts) {
   const markdownPath = path.join(opts.diffDir, 'summary.md');
   const htmlPath = path.join(opts.diffDir, 'report.html');
 
-  const { summary, markdown } = await generateDriftReport({
-    configPath: opts.configPath,
-    routeIds: opts.routes.length > 0 ? opts.routes : undefined,
-    baselineResultsPath,
-    baselineManifestPath,
-    currentResultsPath: currentCapture.resultsPath,
-    currentManifestPath: currentCapture.manifestPath,
-    baselineRunDir: opts.baselineDir,
-    currentRunDir: currentCapture.screenshotsRoot
-  });
+  const diffProvider = usedLocalFallback ? createProvider('local') : provider;
+  let diffResult;
+  try {
+    diffResult = await diffProvider.diff({
+      configPath: opts.configPath,
+      routeIds: opts.routes.length > 0 ? opts.routes : undefined,
+      baselineResultsPath,
+      baselineManifestPath,
+      currentResultsPath: currentCapture.resultsPath,
+      currentManifestPath: currentCapture.manifestPath,
+      baselineRunDir: opts.baselineDir,
+      currentRunDir: currentCapture.screenshotsRoot
+    });
+  } catch (error) {
+    if (error instanceof SnapSkipError) {
+      process.stdout.write('Visual regression skipped (Snap unavailable, warn-and-skip mode).\n');
+      return;
+    }
+    throw error;
+  }
+
+  const { summary, markdown } = diffResult;
 
   const html = await generateHtmlReport(summary, {
     baselineRunDir: opts.baselineDir,
@@ -219,6 +296,58 @@ export async function runDiffCommand(opts) {
   }
 }
 
+/**
+ * Run the `migrate-baselines` command — migrate baselines between local and Snap.
+ *
+ * @param {CliOptions} opts
+ * @returns {Promise<void>}
+ */
+export async function runMigrateBaselinesCommand(opts) {
+  if (!opts.to || (opts.to !== 'snap' && opts.to !== 'local')) {
+    process.stderr.write('Usage: snapdrift migrate-baselines --to <snap|local> [--from snap] [--accept-cross-engine] [--config <path>] [--baseline-dir <dir>]\n');
+    process.exitCode = 1;
+    return;
+  }
+
+  if (opts.to === 'local' && opts.from !== 'snap') {
+    process.stderr.write('Error: --to local requires --from snap\n');
+    process.exitCode = 1;
+    return;
+  }
+
+  if (opts.acceptCrossEngine && opts.to !== 'local') {
+    process.stderr.write('Error: --accept-cross-engine is only valid with --to local\n');
+    process.exitCode = 1;
+    return;
+  }
+
+  const { runMigrateToSnap, runMigrateToLocal } = await import('./migrate-baselines.mjs');
+  const { config } = await loadSnapdriftConfig(opts.configPath);
+
+  if (opts.to === 'snap') {
+    await runMigrateToSnap(config, opts);
+  } else {
+    await runMigrateToLocal(config, opts);
+  }
+}
+
+/**
+ * Run the `init` command — initialize snapdrift config from a Snap action workflow.
+ *
+ * @param {CliOptions} opts
+ * @returns {Promise<void>}
+ */
+export async function runInitCommand(opts) {
+  if (!opts.fromSnapAction) {
+    process.stderr.write('Usage: snapdrift init --from-snap-action <workflow-yaml-path>\n');
+    process.exitCode = 1;
+    return;
+  }
+
+  const { runInitFromAction } = await import('./init-from-action.mjs');
+  await runInitFromAction(opts.fromSnapAction);
+}
+
 /**
  * Main CLI entry point — parse args and dispatch to the appropriate command.
  *
@@ -232,10 +361,14 @@ export async function main(argv) {
     await runCaptureCommand(opts);
   } else if (opts.command === 'diff') {
     await runDiffCommand(opts);
+  } else if (opts.command === 'migrate-baselines') {
+    await runMigrateBaselinesCommand(opts);
+  } else if (opts.command === 'init') {
+    await runInitCommand(opts);
   } else {
     process.stderr.write(
-      `Unknown command: ${opts.command}\nUsage: snapdrift <capture|diff> [options]\n`
+      `Unknown command: ${opts.command}\nUsage: snapdrift <capture|diff|migrate-baselines|init> [options]\n`
     );
     process.exitCode = 1;
   }
-}
+}