creevey 0.10.0-beta.8 → 0.10.0-rc.0

package/dist/types.d.ts

@@ -1,11 +1,11 @@
-import type { StoryContextForEnhancers, DecoratorFunction } from '@storybook/csf';
+import * as v from 'valibot';
 import type { Worker as ClusterWorker } from 'cluster';
-import type Pixelmatch from 'pixelmatch';
-import type { ODiffOptions } from 'odiff-bin';
 import type { expect } from 'chai';
 import type EventEmitter from 'events';
-import { LaunchOptions } from 'playwright-core';
-export type DiffOptions = typeof Pixelmatch extends (x1: any, x2: any, x3: any, x4: any, x5: any, options?: infer T) => void ? T : never;
+import type { ODiffOptions } from 'odiff-bin';
+import type { LaunchOptions } from 'playwright-core';
+import type { PixelmatchOptions } from 'pixelmatch';
+import type { StoryContextForEnhancers, DecoratorFunction } from 'storybook/internal/types';
 export interface SetStoriesData {
     v?: number;
     globalParameters: {
@@ -88,6 +88,10 @@ export interface BrowserConfigObject {
      * Storybook's globals to set in a specific browser
      * @see https://github.com/storybookjs/storybook/blob/v6.0.0/docs/essentials/toolbars-and-globals.md
      */
+    storybookGlobals?: StorybookGlobals;
+    /**
+     * @deprecated Use `storybookGlobals` instead
+     */
     _storybookGlobals?: StorybookGlobals;
     /**
      * Specify custom docker image. Used only with `useDocker == true`
@@ -114,11 +118,17 @@ export interface BrowserConfigObject {
         platformName?: string;
         [name: string]: unknown;
     };
-    playwrightOptions?: Omit<LaunchOptions, 'logger'>;
+    playwrightOptions?: Omit<LaunchOptions, 'logger'> & {
+        trace?: {
+            screenshots?: boolean;
+            snapshots?: boolean;
+            sources?: boolean;
+        };
+    };
 }
 export type StorybookGlobals = Record<string, unknown>;
 export type BrowserConfig = boolean | string | BrowserConfigObject;
-export type CreeveyWebdriverConstructor = new (browser: string, gridUrl: string, config: Config, options: Options) => CreeveyWebdriver;
+export type CreeveyWebdriverConstructor = new (browser: string, gridUrl: string, config: Config, options: WorkerOptions) => CreeveyWebdriver;
 export interface CreeveyWebdriver {
     getSessionId(): Promise<string>;
     openBrowser(fresh?: boolean): Promise<CreeveyWebdriver | null>;
@@ -140,6 +150,7 @@ export interface DockerAuth {
     serveraddress?: string;
 }
 export type BaseReporter = new (runner: EventEmitter, options: {
+    reportDir: string;
     reporterOptions: any;
 }) => void;
 export interface Config {
@@ -157,6 +168,11 @@ export interface Config {
      * Url where storybook hosted on
      */
     resolveStorybookUrl?: () => Promise<string>;
+    /**
+     * Command to automatically start Storybook if it is not running.
+     * For example, `npm run storybook` or `yarn storybook` etc.
+     */
+    storybookAutorunCmd?: string;
     /**
      * Absolute path to directory with reference images
      * @default path.join(process.cwd(), './images')
@@ -170,8 +186,9 @@ export interface Config {
     /**
      * Specify a custom reporter for test results. Creevey accepts only mocha-like reporters
      * @optional
+     * @default 'creevey'
      */
-    reporter: BaseReporter;
+    reporter: BaseReporter | 'creevey' | 'teamcity' | 'junit';
     /**
      * Options which are used by reporter
      */
@@ -188,11 +205,12 @@ export interface Config {
     testTimeout: number;
     /**
      * Define pixelmatch diff options
-     * @default { threshold: 0.05, includeAA: false }
+     * @default { threshold: 0.1, includeAA: false }
      */
-    diffOptions: DiffOptions;
+    diffOptions: PixelmatchOptions;
     /**
-     *
+     * Define odiff diff options
+     * @default { threshold: 0.1, antialiasing: true }
      */
     odiffOptions: ODiffOptions;
     /**
@@ -212,20 +230,17 @@ export interface Config {
     /**
      * Creevey has two built-in stories providers.
      *
-     * `nodejsStoriesProvider` - The first one is used by default except if CSFv3 is enabled in Storybook.
-     * This provider builds and runs storybook in nodejs env, that allows write interaction tests by using Selenium API.
-     * The downside is it depends from project build specific and slightly increases init time.
-     *
-     * `browserStoriesProvider` - The second one is used by default with CSFv3 storybook feature.
-     * It load stories from storybook which is running in browser, like storyshots or loki do it.
+     * `browserStoriesProvider` - Extracts stories directly from the Storybook UI. It loads stories from storybook which is running in browser, like storyshots or loki do it.
      * The downside of this, you can't use interaction tests in Creevey, unless you use CSFv3.
      * Where you can define `play` method for each story
      *
+     * `hybridStoriesProvider` - Combines stories from Storybook with tests from separate files. This is the default provider used in the configuration.
+     *
      * Usage
      * ``` typescript
-     * import { nodejsStoriesProvider as provider } from 'creevey'
-     * // or
      * import { browserStoriesProvider as provider } from 'creevey'
+     * // or
+     * import { hybridStoriesProvider as provider } from 'creevey'
      *
      * // Creevey config
      * module.exports = {
@@ -286,26 +301,36 @@ export interface StoriesProvider {
     providerName?: string;
 }
 export type CreeveyConfig = Partial<Config>;
-export interface Options {
-    _: string[];
-    config?: string;
-    port: number;
-    ui: boolean;
-    update: boolean | string;
-    debug: boolean;
-    trace: boolean;
-    browser?: string;
-    /**
-     * @deprecated use {@link Config.reporter} instead
-     */
-    reporter?: string;
-    screenDir?: string;
-    reportDir?: string;
-    gridUrl?: string;
-    storybookUrl?: string;
-    failFast?: boolean;
-    odiff?: boolean;
-}
+export declare const OptionsSchema: v.ObjectSchema<{
+    readonly ui: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly storybookStart: v.OptionalSchema<v.UnionSchema<[v.StringSchema<undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
+    readonly config: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly debug: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly port: v.NumberSchema<undefined>;
+    readonly failFast: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly reportDir: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly screenDir: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly storybookUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly storybookPort: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+    readonly reporter: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly odiff: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly trace: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly docker: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+}, undefined>;
+export declare const WorkerOptionsSchema: v.ObjectSchema<{
+    readonly browser: v.StringSchema<undefined>;
+    readonly storybookUrl: v.StringSchema<undefined>;
+    readonly gridUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly config: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly debug: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly trace: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly reportDir: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly screenDir: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly odiff: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+    readonly port: v.NumberSchema<undefined>;
+}, undefined>;
+export type Options = v.InferOutput<typeof OptionsSchema>;
+export type WorkerOptions = v.InferOutput<typeof WorkerOptionsSchema>;
 export type WorkerError = 'browser' | 'test' | 'unknown';
 export type WorkerMessage = {
     type: 'ready';
@@ -376,8 +401,14 @@ export interface Images {
 export type TestStatus = 'unknown' | 'pending' | 'running' | 'failed' | 'approved' | 'success' | 'retrying';
 export interface TestResult {
     status: 'failed' | 'success';
+    retries: number;
     images?: Partial<Record<string, Images>>;
     error?: string;
+    duration?: number;
+    attachments?: string[];
+    sessionId?: string;
+    browserName?: string;
+    workerId?: number;
 }
 export declare class ImagesError extends Error {
     images?: string | Partial<Record<string, string>>;
@@ -410,8 +441,8 @@ export interface BaseCreeveyTestContext {
         imageName?: string;
         screenshot: Buffer;
     }[];
-    matchImage: (image: Buffer, imageName?: string) => Promise<void>;
-    matchImages: (images: Record<string, Buffer>) => Promise<void>;
+    matchImage: (image: Buffer | string, imageName?: string) => Promise<void>;
+    matchImages: (images: Record<string, Buffer | string>) => Promise<void>;
 }
 export interface CreeveyTestContext extends BaseCreeveyTestContext {
     takeScreenshot: () => Promise<Buffer>;
@@ -421,6 +452,8 @@ export interface CreeveyTestContext extends BaseCreeveyTestContext {
 export declare enum TEST_EVENTS {
     RUN_BEGIN = "start",
     RUN_END = "end",
+    SUITE_BEGIN = "suite",
+    SUITE_END = "suite end",
     TEST_BEGIN = "test",
     TEST_END = "test end",
     TEST_FAIL = "fail",
@@ -441,19 +474,27 @@ export interface FakeTest {
     title: string;
     fullTitle: () => string;
     titlePath: () => string[];
-    currentRetry: () => number;
+    currentRetry: () => number | undefined;
     retires: () => number;
     slow: () => number;
     duration?: number;
     state?: 'failed' | 'passed';
     speed?: 'slow' | 'medium' | 'fast';
-    err?: unknown;
+    err?: string;
     attachments?: string[];
+    creevey: {
+        sessionId: string;
+        browserName: string;
+        workerId: number;
+        willRetry: boolean;
+        images: Partial<Record<string, Partial<Images>>>;
+    };
 }
 export interface CreeveyStatus {
     isRunning: boolean;
     tests: Partial<Record<string, TestData>>;
     browsers: string[];
+    isUpdateMode: boolean;
 }
 export interface CreeveyUpdate {
     isRunning?: boolean;

package/dist/types.js

@@ -1,6 +1,39 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_EVENTS = exports.ImagesError = exports.StorybookEvents = void 0;
+exports.TEST_EVENTS = exports.ImagesError = exports.WorkerOptionsSchema = exports.OptionsSchema = exports.StorybookEvents = void 0;
 exports.noop = noop;
 exports.isDefined = isDefined;
 exports.isTest = isTest;
@@ -12,6 +45,7 @@ exports.isProcessMessage = isProcessMessage;
 exports.isWorkerMessage = isWorkerMessage;
 exports.isStoriesMessage = isStoriesMessage;
 exports.isTestMessage = isTestMessage;
+const v = __importStar(require("valibot"));
 var StorybookEvents;
 (function (StorybookEvents) {
     StorybookEvents["SET_STORIES"] = "setStories";
@@ -24,6 +58,34 @@ var StorybookEvents;
     StorybookEvents["SET_GLOBALS"] = "setGlobals";
     StorybookEvents["UPDATE_GLOBALS"] = "updateGlobals";
 })(StorybookEvents || (exports.StorybookEvents = StorybookEvents = {}));
+exports.OptionsSchema = v.object({
+    ui: v.optional(v.boolean()),
+    storybookStart: v.optional(v.union([v.string(), v.boolean()])),
+    config: v.optional(v.string()),
+    debug: v.optional(v.boolean()),
+    port: v.number(),
+    failFast: v.optional(v.boolean()),
+    reportDir: v.optional(v.string()),
+    screenDir: v.optional(v.string()),
+    storybookUrl: v.optional(v.string()),
+    storybookPort: v.optional(v.number()),
+    reporter: v.optional(v.string()),
+    odiff: v.optional(v.boolean()),
+    trace: v.optional(v.boolean()),
+    docker: v.optional(v.boolean()),
+});
+exports.WorkerOptionsSchema = v.object({
+    browser: v.string(),
+    storybookUrl: v.string(),
+    gridUrl: v.optional(v.string()),
+    config: v.optional(v.string()),
+    debug: v.optional(v.boolean()),
+    trace: v.optional(v.boolean()),
+    reportDir: v.optional(v.string()),
+    screenDir: v.optional(v.string()),
+    odiff: v.optional(v.boolean()),
+    port: v.number(),
+});
 class ImagesError extends Error {
     images;
 }
@@ -32,6 +94,8 @@ var TEST_EVENTS;
 (function (TEST_EVENTS) {
     TEST_EVENTS["RUN_BEGIN"] = "start";
     TEST_EVENTS["RUN_END"] = "end";
+    TEST_EVENTS["SUITE_BEGIN"] = "suite";
+    TEST_EVENTS["SUITE_END"] = "suite end";
     TEST_EVENTS["TEST_BEGIN"] = "test";
     TEST_EVENTS["TEST_END"] = "test end";
     TEST_EVENTS["TEST_FAIL"] = "fail";

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAojBA,oBAEC;AAED,8BAEC;AAED,wBASC;AAED,4BAEC;AAED,4BAEC;AAGD,gCAEC;AAED,oCAEC;AAED,4CAEC;AAED,0CAEC;AAED,4CAEC;AAED,sCAEC;AA3jBD,IAAY,eAUX;AAVD,WAAY,eAAe;IACzB,6CAA0B,CAAA;IAC1B,wDAAqC,CAAA;IACrC,iDAA8B,CAAA;IAC9B,mDAAgC,CAAA;IAChC,iDAA8B,CAAA;IAC9B,gEAA6C,CAAA;IAC7C,wDAAqC,CAAA;IACrC,6CAA0B,CAAA;IAC1B,mDAAgC,CAAA;AAClC,CAAC,EAVW,eAAe,+BAAf,eAAe,QAU1B;AAsWD,MAAa,WAAY,SAAQ,KAAK;IACpC,MAAM,CAA4C;CACnD;AAFD,kCAEC;AAwCD,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,iCAAkB,CAAA;IAClB,iCAAkB,CAAA;AACpB,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAwGD,SAAgB,IAAI;IAClB,UAAU;AACZ,CAAC;AAED,SAAgB,SAAS,CAAI,KAA2B;IACtD,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAED,SAAgB,MAAM,CAAC,CAA8B;IACnD,OAAO,CACL,SAAS,CAAC,CAAC,CAAC;QACZ,QAAQ,CAAC,CAAC,CAAC;QACX,IAAI,IAAI,CAAC;QACT,SAAS,IAAI,CAAC;QACd,OAAO,CAAC,CAAC,EAAE,IAAI,QAAQ;QACvB,OAAO,CAAC,CAAC,OAAO,IAAI,QAAQ,CAC7B,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,IAAI,QAAQ,IAAI,CAAC,IAAI,IAAI,CAAC;AAC3C,CAAC;AAED,SAAgB,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,IAAI,QAAQ,CAAC;AAC9B,CAAC;AAED,8DAA8D;AAC9D,SAAgB,UAAU,CAAC,CAAU;IACnC,OAAO,OAAO,CAAC,IAAI,UAAU,CAAC;AAChC,CAAC;AAED,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,YAAY,WAAW,IAAI,QAAQ,IAAI,KAAK,CAAC;AAC3D,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,OAAO,CAAC;AACjD,CAAC;AAED,SAAgB,eAAe,CAAC,OAAgB;IAC9C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,QAAQ,CAAC;AAChE,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,SAAS,CAAC;AACjE,CAAC;AAED,SAAgB,aAAa,CAAC,OAAgB;IAC5C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC;AAC9D,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqlBA,oBAEC;AAED,8BAEC;AAED,wBASC;AAED,4BAEC;AAED,4BAEC;AAGD,gCAEC;AAED,oCAEC;AAED,4CAEC;AAED,0CAEC;AAED,4CAEC;AAED,sCAEC;AAvoBD,2CAA6B;AA8B7B,IAAY,eAUX;AAVD,WAAY,eAAe;IACzB,6CAA0B,CAAA;IAC1B,wDAAqC,CAAA;IACrC,iDAA8B,CAAA;IAC9B,mDAAgC,CAAA;IAChC,iDAA8B,CAAA;IAC9B,gEAA6C,CAAA;IAC7C,wDAAqC,CAAA;IACrC,6CAA0B,CAAA;IAC1B,mDAAgC,CAAA;AAClC,CAAC,EAVW,eAAe,+BAAf,eAAe,QAU1B;AA4SY,QAAA,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3B,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAC9D,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CAChC,CAAC,CAAC;AAEU,QAAA,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAgEH,MAAa,WAAY,SAAQ,KAAK;IACpC,MAAM,CAA4C;CACnD;AAFD,kCAEC;AAwCD,IAAY,WASX;AATD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;IACf,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,iCAAkB,CAAA;IAClB,iCAAkB,CAAA;AACpB,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAkHD,SAAgB,IAAI;IAClB,UAAU;AACZ,CAAC;AAED,SAAgB,SAAS,CAAI,KAA2B;IACtD,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAED,SAAgB,MAAM,CAAC,CAA8B;IACnD,OAAO,CACL,SAAS,CAAC,CAAC,CAAC;QACZ,QAAQ,CAAC,CAAC,CAAC;QACX,IAAI,IAAI,CAAC;QACT,SAAS,IAAI,CAAC;QACd,OAAO,CAAC,CAAC,EAAE,IAAI,QAAQ;QACvB,OAAO,CAAC,CAAC,OAAO,IAAI,QAAQ,CAC7B,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,IAAI,QAAQ,IAAI,CAAC,IAAI,IAAI,CAAC;AAC3C,CAAC;AAED,SAAgB,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,IAAI,QAAQ,CAAC;AAC9B,CAAC;AAED,8DAA8D;AAC9D,SAAgB,UAAU,CAAC,CAAU;IACnC,OAAO,OAAO,CAAC,IAAI,UAAU,CAAC;AAChC,CAAC;AAED,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,YAAY,WAAW,IAAI,QAAQ,IAAI,KAAK,CAAC;AAC3D,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,OAAO,CAAC;AACjD,CAAC;AAED,SAAgB,eAAe,CAAC,OAAgB;IAC9C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,QAAQ,CAAC;AAChE,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,SAAS,CAAC;AACjE,CAAC;AAED,SAAgB,aAAa,CAAC,OAAgB;IAC5C,OAAO,gBAAgB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC;AAC9D,CAAC"}

package/docs/cli.md

@@ -0,0 +1,80 @@
+## Creevey CLI Commands and Options
+
+Creevey provides two main commands for different purposes:
+
+### Commands
+
+#### `creevey test [options]`
+
+Run visual regression tests.
+
+**Options:**
+
+- `--ui` — Launch web UI for running tests and reviewing test results
+- `-s, --storybook-start [cmd]` — Start Storybook automatically (optional command can be specified)
+- `-c, --config <config>` — Path to config file (default: `.creevey/config.ts` or `creevey.config.ts`)
+- `-d, --debug` — Enable debug mode (also enables recording video and traces if Playwright is used)
+- `-p, --port <port>` — Port for UI server (default: `3000`)
+- `--fail-fast` — Stop tests after first failure
+- `--report-dir <dir>` — Directory for test reports
+- `--screen-dir <dir>` — Directory for reference images
+- `--storybook-url <url>` — Storybook server URL
+- `--storybook-port <port>` — Storybook server port
+- `--reporter <reporter>` — **[DEPRECATED]** Use config file instead
+- `--odiff` — Use odiff for image comparison
+- `--trace` — Enable trace mode (more verbose than debug)
+- `--no-docker` — Disable Docker usage
+
+**Examples:**
+
+```bash
+# Run tests with UI
+creevey test --ui
+
+# Start Storybook automatically and run tests
+creevey test -s --ui
+
+# Run tests with custom config and debug mode
+creevey test -c ./my-config.ts --debug
+
+# Run tests with fail-fast mode
+creevey test --fail-fast
+
+# Run tests without Docker
+creevey test --no-docker
+```
+
+#### `creevey report [reportDir]`
+
+Launch web UI to review and approve test results from a previous test run.
+
+**Options:**
+
+- `-c, --config <config>` — Path to config file
+- `-p, --port <port>` — Port for UI server (default: `3000`)
+- `--screen-dir <dir>` — Directory for reference images
+
+**Examples:**
+
+```bash
+# Launch report UI with default report directory
+creevey report
+
+# Launch report UI with specific report directory
+creevey report ./custom-report
+
+# Launch report UI on custom port
+creevey report -p 8080
+```
+
+### Global Options
+
+These options are available for all commands:
+
+- `--help, -h` — Show help information
+- `--version, -v` — Show version information
+
+### Migration Notes
+
+- The `--reporter` option has been deprecated. Configure reporters in your config file instead.
+- The `-u, --update` option has been removed. Use the `report` command instead.