happo 6.9.0 → 6.10.1

package/dist/cli/main.js

@@ -2,12 +2,15 @@
 import {
   startServer
 } from "./chunk-JTRP4JVC.js";
+import {
+  validateSkip
+} from "./chunk-ML3Z5Z22.js";
 import {
   fetchWithRetry
-} from "./chunk-BESQLM5F.js";
+} from "./chunk-UTRRH3WF.js";
 import {
   package_default
-} from "./chunk-P4EXA4AX.js";
+} from "./chunk-64XRFVHC.js";
 
 // src/cli/index.ts
 import path3 from "node:path";
@@ -808,7 +811,8 @@ async function resolveEnvironment(cliArgs, env = process.env) {
     fallbackShas: resolveFallbackShas(cliArgs, nonNullBeforeSha),
     githubToken: cliArgs.githubToken,
     ci: !!env.CI,
-    skippedExamples: cliArgs.skippedExamples
+    skip: cliArgs.skip,
+    only: cliArgs.only
   };
   if (debugMode) {
     console.log("[HAPPO] Raw environment", getRawEnv(env));
@@ -817,6 +821,27 @@ async function resolveEnvironment(cliArgs, env = process.env) {
   return result;
 }
 
+// src/isomorphic/parseOnly.ts
+function isOnlyItem(item) {
+  if (typeof item !== "object" || item === null) return false;
+  const record = item;
+  const hasComponent = typeof record["component"] === "string";
+  const hasStoryFile = typeof record["storyFile"] === "string";
+  if (hasComponent && hasStoryFile) return false;
+  if (hasStoryFile) return record["variant"] === void 0;
+  if (hasComponent) return record["variant"] === void 0;
+  return false;
+}
+function validateOnly(json) {
+  const parsed = JSON.parse(json);
+  if (!Array.isArray(parsed) || !parsed.every(isOnlyItem)) {
+    throw new TypeError(
+      "--only must be a JSON array of {component} or {storyFile} objects (variant is not supported)"
+    );
+  }
+  return parsed;
+}
+
 // src/cli/parseOptions.ts
 var parseOptions = {
   version: {
@@ -895,8 +920,14 @@ var parseOptions = {
   sha: {
     type: "string"
   },
+  skip: {
+    type: "string"
+  },
   skippedExamples: {
     type: "string"
+  },
+  only: {
+    type: "string"
   }
 };
 
@@ -1194,7 +1225,7 @@ function createReporter(opts = {}) {
 
 // src/cli/index.ts
 async function getVersion() {
-  const packageJson = await import("./package-4NRNRUE3.js");
+  const packageJson = await import("./package-TU7REKQ6.js");
   return packageJson.default.version;
 }
 function parseDashdashCommandParts(rawArgs) {
@@ -1286,6 +1317,11 @@ Options:
   --notify <emails>     One or more (comma-separated) email addresses to notify with results
   --nonce <nonce>       Nonce to use for Cypress/Playwright comparison
   --githubToken <token> GitHub token to use for posting Happo statuses as comments. Use in combination with the \`githubApiUrl\` configuration option. (default: auto-detected from environment)
+  --skip <json> JSON array of {component, variant} objects to skip in this run and borrow from the nearest baseline report instead
+  --only <json> JSON array of {component} or {storyFile} objects to include in this run (all other stories are skipped); only supported for the Storybook integration
+
+Finalize command options:
+  --skippedExamples <json> JSON array of {component, variant, target} objects to skip when finalizing; borrowed from the nearest baseline report
 
 Flake command options:
   --allProjects         List flakes across all projects (default: current project)
@@ -1314,7 +1350,8 @@ Examples:
 
   happo -- playwright test
 
-  --skippedExamples <json>  JSON array of examples to skip in the finalize command (e.g. '[{"component":"Button","variant":"primary","target":"chrome"}]')
+  happo --skip '[{"component":"Button","variant":"Primary"}]'
+  happo --only '[{"component":"Button"},{"storyFile":"./src/Input.stories.tsx"}]'
 
   happo finalize
   happo finalize --nonce my-unique-nonce
@@ -1373,19 +1410,38 @@ async function main(rawArgs = process.argv, logger = console) {
     const environment = await resolveEnvironment(args.values);
     const configFilePath = makeAbsolute(args.values.config || findConfigFile());
     const config = await loadConfigFile(configFilePath, environment, logger);
+    if (args.values.project !== void 0) {
+      config.project = args.values.project;
+    }
     const command = args.positionals[0];
     if (args.dashdashCommandParts) {
+      let validatedSkipJSON;
+      if (environment.skip) {
+        try {
+          validateSkip(environment.skip);
+        } catch (e) {
+          logger.error(
+            "[HAPPO] Invalid --skip:",
+            e instanceof Error ? e.message : String(e)
+          );
+          process.exitCode = 1;
+          return;
+        }
+        validatedSkipJSON = environment.skip;
+      }
       await handleE2ECommand(
         config,
         environment,
         args.dashdashCommandParts,
         configFilePath,
-        logger
+        logger,
+        validatedSkipJSON
       );
       return;
     }
     if (command === "finalize") {
-      await handleFinalizeCommand(config, environment, logger);
+      const finalizeEnvironment = args.values.skippedExamples ? { ...environment, skip: args.values.skippedExamples } : environment;
+      await handleFinalizeCommand(config, finalizeEnvironment, logger);
       return;
     }
     if (command === "flake") {
@@ -1439,16 +1495,100 @@ async function main(rawArgs = process.argv, logger = console) {
 async function handleDefaultCommand(config, environment, logger) {
   logger.log("Running happo tests...");
   const [startJob, createAsyncComparison, createAsyncReport, prepareSnapRequests] = await Promise.all([
-    (await import("./startJob-JAO5FUA2.js")).default,
-    (await import("./createAsyncComparison-CQLGQXY2.js")).default,
-    (await import("./createAsyncReport-4ZD53TJC.js")).default,
-    (await import("./prepareSnapRequests-2LHSGFZV.js")).default
+    (await import("./startJob-33HGTT4N.js")).default,
+    (await import("./createAsyncComparison-WLPUS2NJ.js")).default,
+    (await import("./createAsyncReport-2ZTQOHDA.js")).default,
+    (await import("./prepareSnapRequests-WBXFGB4B.js")).default
   ]);
   await startJob(config, environment, logger);
   try {
-    const snapRequestIds = await prepareSnapRequests(config);
+    let skip;
+    let baselineSha;
+    if (environment.skip) {
+      const supportedTypes = ["storybook", "custom"];
+      if (!supportedTypes.includes(config.integration.type)) {
+        logger.error(
+          `[HAPPO] --skip is not supported for integration type '${config.integration.type}'. Supported types: ${supportedTypes.join(", ")}`
+        );
+        process.exitCode = 1;
+        return;
+      }
+      try {
+        skip = validateSkip(environment.skip);
+      } catch (e) {
+        logger.error(
+          "[HAPPO] Invalid --skip:",
+          e instanceof Error ? e.message : String(e)
+        );
+        process.exitCode = 1;
+        return;
+      }
+      if (config.integration.type !== "storybook" && skip.some((item) => "storyFile" in item)) {
+        logger.error(
+          `[HAPPO] storyFile items in --skip are only supported for the storybook integration (current integration: '${config.integration.type}')`
+        );
+        process.exitCode = 1;
+        return;
+      }
+      const findBaselineReport = (await import("./findBaselineReport-2SHS2OH7.js")).default;
+      baselineSha = await findBaselineReport(environment, config, logger);
+      if (!baselineSha) {
+        logger.log(
+          "[HAPPO] No baseline report found for --skip run. Generating a full report instead."
+        );
+        skip = void 0;
+      }
+    }
+    let only;
+    if (environment.only) {
+      if (config.integration.type !== "storybook") {
+        logger.error(
+          `[HAPPO] --only is not supported for integration type '${config.integration.type}'. Supported types: storybook`
+        );
+        process.exitCode = 1;
+        return;
+      }
+      try {
+        only = validateOnly(environment.only);
+      } catch (e) {
+        logger.error(
+          "[HAPPO] Invalid --only:",
+          e instanceof Error ? e.message : String(e)
+        );
+        process.exitCode = 1;
+        return;
+      }
+      if (!baselineSha) {
+        const findBaselineReport = (await import("./findBaselineReport-2SHS2OH7.js")).default;
+        baselineSha = await findBaselineReport(environment, config, logger);
+        if (!baselineSha) {
+          logger.log(
+            "[HAPPO] No baseline report found for --only run. Excluded stories will not be borrowed from a baseline."
+          );
+        }
+      }
+    }
+    const { snapRequestIds, resolvedSkip } = await prepareSnapRequests(config, skip, only);
+    let allSnapRequestIds = snapRequestIds;
+    if (skip && baselineSha) {
+      const createExtendsReportSnapRequest = (await import("./createExtendsReportSnapRequest-4ZSBNCPL.js")).default;
+      const extendsRequestId = await createExtendsReportSnapRequest(
+        baselineSha,
+        resolvedSkip ?? skip,
+        config
+      );
+      allSnapRequestIds = [...snapRequestIds, extendsRequestId];
+    } else if (only && baselineSha && resolvedSkip && resolvedSkip.length > 0) {
+      const createExtendsReportSnapRequest = (await import("./createExtendsReportSnapRequest-4ZSBNCPL.js")).default;
+      const extendsRequestId = await createExtendsReportSnapRequest(
+        baselineSha,
+        resolvedSkip,
+        config
+      );
+      allSnapRequestIds = [...snapRequestIds, extendsRequestId];
+    }
     const asyncReport = await createAsyncReport(
-      snapRequestIds,
+      allSnapRequestIds,
       config,
       environment,
       logger
@@ -1475,7 +1615,7 @@ async function handleDefaultCommand(config, environment, logger) {
   } catch (e) {
     const message = e instanceof Error ? e.message : String(e);
     logger.error(`${config.integration.type} run failed: ${message}`, e);
-    const cancelJob = (await import("./cancelJob-Y4WJCCU6.js")).default;
+    const cancelJob = (await import("./cancelJob-4I7RBUQG.js")).default;
     await cancelJob("failure", message, config, environment, logger);
     process.exitCode = 1;
     return;
@@ -1486,7 +1626,7 @@ async function handleFinalizeCommand(config, environment, logger) {
   logger.log("Config:", config);
   logger.log("Environment:", environment);
   try {
-    const finalizeAll = (await import("./wrapper-7RE2N7Y3.js")).finalizeAll;
+    const finalizeAll = (await import("./wrapper-CCHBHKT2.js")).finalizeAll;
     await finalizeAll({ happoConfig: config, environment, logger });
   } catch (e) {
     logger.error(e instanceof Error ? e.message : String(e), e);
@@ -1514,7 +1654,7 @@ async function handleFlakeCommand(config, {
     process.exitCode = 1;
     return;
   }
-  const { default: getFlakes, formatFlakeOutput } = await import("./getFlakes-6ZGTWZTM.js");
+  const { default: getFlakes, formatFlakeOutput } = await import("./getFlakes-DLKH2VLM.js");
   const project = allProjects ? void 0 : projectOverride ?? config.project;
   const flakes = await getFlakes(
     {
@@ -1538,7 +1678,7 @@ async function handleFlakeCommand(config, {
   process.exitCode = 0;
 }
 var E2E_INTEGRATION_TYPES = ["cypress", "playwright"];
-async function handleE2ECommand(config, environment, dashdashCommandParts, configFilePath, logger) {
+async function handleE2ECommand(config, environment, dashdashCommandParts, configFilePath, logger, skipJSON) {
   if (!E2E_INTEGRATION_TYPES.includes(config.integration.type)) {
     logger.error(
       `Unsupported integration type used for e2e command: ${config.integration.type}. Supported integration types for e2e are: ${E2E_INTEGRATION_TYPES.join(", ")}`
@@ -1556,13 +1696,14 @@ async function handleE2ECommand(config, environment, dashdashCommandParts, confi
   logger.log("Config:", config);
   logger.log("Environment:", environment);
   logger.log("Dashdash command parts:", dashdashCommandParts);
-  const runWithWrapper = (await import("./wrapper-7RE2N7Y3.js")).default;
+  const runWithWrapper = (await import("./wrapper-CCHBHKT2.js")).default;
   const exitCode = await runWithWrapper(
     dashdashCommandParts,
     config,
     environment,
     logger,
-    configFilePath
+    configFilePath,
+    skipJSON
   );
   process.exitCode = exitCode;
 }