@cucumber/cucumber 10.1.0 → 10.2.1

package/lib/api/types.d.ts

@@ -1,55 +1,84 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Writable } from 'node:stream';
-import { ISupportCodeLibrary } from '../support_code_library_builder/types';
-import { FormatOptions, IPublishConfig } from '../formatter';
-import { PickleOrder } from '../models/pickle_order';
-import { IRuntimeOptions } from '../runtime';
+import { JsonObject } from 'type-fest';
+import { IPublishConfig } from '../publish';
 import { IConfiguration } from '../configuration';
+import { IPickleOrder } from '../filter';
 /**
+ * Options for {@link loadConfiguration}
  * @public
  */
 export interface ILoadConfigurationOptions {
     /**
-     * Path to load configuration file from (defaults to `cucumber.(js|cjs|mjs|json)` if omitted).
+     * Path to load configuration file from, or `false` to skip
+     * @default `cucumber.(json|yaml|yml|js|cjs|mjs)`
      */
-    file?: string;
+    file?: string | false;
     /**
-     * Zero or more profile names from which to source configuration (if omitted or empty, the `default` profile will be used).
+     * Zero or more profile names from which to source configuration in the file
+     * @remarks
+     * If omitted or empty, the `default` profile will be used.
      */
     profiles?: string[];
     /**
-     * Ad-hoc configuration options to be applied over the top of whatever is loaded from the configuration file/profiles.
+     * Ad-hoc configuration options to be merged over the top of whatever is
+     * loaded from the configuration file/profiles
      */
     provided?: Partial<IConfiguration>;
 }
 /**
+ * Response from {@link loadConfiguration}
  * @public
  */
 export interface IResolvedConfiguration {
     /**
-     * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.
+     * The final flat configuration object resolved from the configuration
+     * file/profiles plus any extra provided
      */
     useConfiguration: IConfiguration;
     /**
-     * The format that can be passed into `runCucumber`.
+     * The format that can be passed into {@link runCucumber}
      */
     runConfiguration: IRunConfiguration;
 }
 /**
+ * Options relating to sources (i.e. feature files) - where to load them from,
+ * how to interpret, filter and order them
  * @public
  */
 export interface ISourcesCoordinates {
+    /**
+     * Default Gherkin dialect
+     * @remarks
+     * Used if no dialect is specified in the feature file itself.
+     */
     defaultDialect: string;
+    /**
+     * Paths and/or glob expressions to feature files
+     */
     paths: string[];
+    /**
+     * Regular expressions of which scenario names should match one of to be run
+     */
     names: string[];
+    /**
+     * Tag expression to filter which scenarios should be run
+     */
     tagExpression: string;
-    order: PickleOrder;
+    /**
+     * Run in the order defined, or in a random order
+     */
+    order: IPickleOrder;
 }
 /**
+ * A pickle that has been successfully compiled from a source
  * @public
  */
 export interface IPlannedPickle {
+    /**
+     * Name of the pickle (after parameter resolution)
+     */
     name: string;
     uri: string;
     location: {
@@ -58,6 +87,7 @@ export interface IPlannedPickle {
     };
 }
 /**
+ * An error encountered when parsing a source
  * @public
  */
 export interface ISourcesError {
@@ -66,46 +96,133 @@ export interface ISourcesError {
         line: number;
         column?: number;
     };
+    /**
+     * Error message explaining what went wrong with the parse
+     */
     message: string;
 }
 /**
+ * Response from {@link loadSources}
  * @public
  */
 export interface ILoadSourcesResult {
+    /**
+     * Pickles that have been successfully compiled, in the order they would be
+     * run in
+     */
     plan: IPlannedPickle[];
+    /**
+     * Any errors encountered when parsing sources
+     */
     errors: ISourcesError[];
 }
 /**
+ * Options relating to user code (aka support code) - where to load it from and
+ * how to preprocess it
  * @public
  */
 export interface ISupportCodeCoordinates {
+    /**
+     * Names of transpilation modules to load, via `require()`
+     */
     requireModules: string[];
+    /**
+     * Paths and/or glob expressions of user code to load, via `require()`
+     */
     requirePaths: string[];
+    /**
+     * Paths and/or glob expressions of user code to load, via `import()`
+     */
     importPaths: string[];
 }
 /**
+ * Options for {@link loadSupport}
  * @public
+ * @remarks
+ * A subset of {@link IRunConfiguration}
  */
 export interface ILoadSupportOptions {
+    /**
+     * @remarks
+     * This is needed because the default support path locations are derived from
+     * feature file locations.
+     */
     sources: ISourcesCoordinates;
     support: ISupportCodeCoordinates;
 }
 /**
+ * Options relating to behaviour when actually running tests
  * @public
  */
-export interface IRunOptionsRuntime extends IRuntimeOptions {
+export interface IRunOptionsRuntime {
+    /**
+     * Perform a dry run, where a test run is prepared but nothing is executed
+     */
+    dryRun: boolean;
+    /**
+     * Stop running tests when a test fails
+     */
+    failFast: boolean;
+    /**
+     * Filter out stack frames from Cucumber's code when formatting stack traces
+     */
+    filterStacktraces: boolean;
+    /**
+     * Run tests in parallel with the given number of worker processes
+     */
     parallel: number;
+    /**
+     * Retry failing tests up to the given number of times
+     */
+    retry: number;
+    /**
+     * Tag expression to filter which scenarios can be retried
+     */
+    retryTagFilter: string;
+    /**
+     * Fail the test run if there are pending steps
+     */
+    strict: boolean;
+    /**
+     * Parameters to be passed to the World
+     * @remarks
+     * The value must be a JSON-serializable object.
+     */
+    worldParameters: JsonObject;
 }
 /**
+ * Options relating to formatters - which ones to use, where to write their
+ * output, how they should behave
  * @public
  */
 export interface IRunOptionsFormats {
+    /**
+     * Name/path of the formatter to use for `stdout` output
+     */
     stdout: string;
+    /**
+     * Zero or more mappings of file output path (key) to name/path of the
+     * formatter to use (value)
+     * @example
+     * \{
+     *   "./reports/cucumber.html": "html",
+     *   "./reports/custom.txt": "./custom-formatter.js"
+     * \}
+     */
     files: Record<string, string>;
+    /**
+     * Options for report publication, or `false` to disable publication
+     */
     publish: IPublishConfig | false;
-    options: FormatOptions;
+    /**
+     * Options to be provided to formatters
+     * @remarks
+     * The value must be a JSON-serializable object.
+     */
+    options: JsonObject;
 }
 /**
+ * Structured configuration object suitable for passing to {@link runCucumber}
  * @public
  */
 export interface IRunConfiguration {
@@ -115,14 +232,32 @@ export interface IRunConfiguration {
     formats: IRunOptionsFormats;
 }
 /**
+ * A collection of user-defined code and setup ("support code") that can be
+ * used for a test run
  * @public
+ * @remarks
+ * This is mostly a marker interface. The actual instance is a complex object
+ * that you shouldn't interact with directly, but some functions return and/or
+ * accept it as a means of optimising a test workflow.
  */
-export type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISupportCodeLibrary;
+export interface ISupportCodeLibrary {
+    readonly originalCoordinates: ISupportCodeCoordinates;
+}
 /**
+ * Either an actual {@link ISupportCodeLibrary | support code library}, or the
+ * {@link ISupportCodeCoordinates | coordinates} required to create and
+ * populate one
  * @public
+ * @remarks
+ * This alias exists because {@link runCucumber} will accept an existing
+ * support code library in its options and thus avoid trying to load it again,
+ * improving performance and avoiding cache issues for use cases where multiple
+ * test runs happen within the same process. Note this is only useful in serial
+ * mode, as parallel workers will each load the support code themselves anyway.
  */
-export type { ISupportCodeLibrary };
+export type ISupportCodeCoordinatesOrLibrary = ISupportCodeCoordinates | ISupportCodeLibrary;
 /**
+ * Options for {@link runCucumber}
  * @public
  */
 export interface IRunOptions {
@@ -132,44 +267,53 @@ export interface IRunOptions {
     formats: IRunOptionsFormats;
 }
 /**
- * Contextual data about the project environment.
- *
+ * Contextual data about the project environment
  * @public
  */
 export interface IRunEnvironment {
     /**
-     * Working directory for the project (defaults to `process.cwd()` if omitted).
+     * Working directory for the project
+     * @default process.cwd()
      */
     cwd?: string;
     /**
-     * Writable stream where the test run's main output is written (defaults to `process.stdout` if omitted).
+     * Writable stream where the test run's main formatter output is written
+     * @default process.stdout
      */
     stdout?: Writable;
     /**
-     * Writable stream where the test run's warning/error output is written (defaults to `process.stderr` if omitted).
+     * Writable stream where the test run's warning/error output is written
+     * @default process.stderr
      */
     stderr?: Writable;
     /**
-     * Environment variables (defaults to `process.env` if omitted).
+     * Environment variables
+     * @default process.env
      */
     env?: NodeJS.ProcessEnv;
     /**
-     * Whether debug logging is enabled.
+     * Whether debug logging should be emitted to {@link IRunEnvironment.stderr}
+     * @default false
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/debugging.md}
      */
     debug?: boolean;
 }
 /**
- * Result of a Cucumber test run.
- *
+ * Response from {@link runCucumber}
  * @public
  */
 export interface IRunResult {
     /**
-     * Whether the test run was overall successful i.e. no failed scenarios. The exact meaning can vary based on the `strict` configuration option.
+     * Whether the test run was overall successful
+     * @remarks
+     * The exact meaning can vary based on the `strict` configuration option.
      */
     success: boolean;
     /**
-     * The support code library that was used in the test run; can be reused in subsequent `runCucumber` calls.
+     * The support code library that was used in the test run
+     * @remarks
+     * This can be reused in subsequent {@link runCucumber} calls,
+     * see {@link ISupportCodeCoordinatesOrLibrary}
      */
     support: ISupportCodeLibrary;
 }

package/lib/api/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport { FormatOptions, IPublishConfig } from '../formatter'\nimport { PickleOrder } from '../models/pickle_order'\nimport { IRuntimeOptions } from '../runtime'\nimport { IConfiguration } from '../configuration'\n\n/**\n * @public\n */\nexport interface ILoadConfigurationOptions {\n  /**\n   * Path to load configuration file from (defaults to `cucumber.(js|cjs|mjs|json)` if omitted).\n   */\n  file?: string\n  /**\n   * Zero or more profile names from which to source configuration (if omitted or empty, the `default` profile will be used).\n   */\n  profiles?: string[]\n  /**\n   * Ad-hoc configuration options to be applied over the top of whatever is loaded from the configuration file/profiles.\n   */\n  provided?: Partial<IConfiguration>\n}\n\n/**\n * @public\n */\nexport interface IResolvedConfiguration {\n  /**\n   * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.\n   */\n  useConfiguration: IConfiguration\n  /**\n   * The format that can be passed into `runCucumber`.\n   */\n  runConfiguration: IRunConfiguration\n}\n\n/**\n * @public\n */\nexport interface ISourcesCoordinates {\n  defaultDialect: string\n  paths: string[]\n  names: string[]\n  tagExpression: string\n  order: PickleOrder\n}\n\n/**\n * @public\n */\nexport interface IPlannedPickle {\n  name: string\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n}\n\n/**\n * @public\n */\nexport interface ISourcesError {\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n  message: string\n}\n\n/**\n * @public\n */\nexport interface ILoadSourcesResult {\n  plan: IPlannedPickle[]\n  errors: ISourcesError[]\n}\n\n/**\n * @public\n */\nexport interface ISupportCodeCoordinates {\n  requireModules: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n\n/**\n * @public\n */\nexport interface ILoadSupportOptions {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n}\n\n/**\n * @public\n */\nexport interface IRunOptionsRuntime extends IRuntimeOptions {\n  parallel: number\n}\n\n/**\n * @public\n */\nexport interface IRunOptionsFormats {\n  stdout: string\n  files: Record<string, string>\n  publish: IPublishConfig | false\n  options: FormatOptions\n}\n\n/**\n * @public\n */\nexport interface IRunConfiguration {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n}\n\n/**\n * @public\n */\nexport type ISupportCodeCoordinatesOrLibrary =\n  | ISupportCodeCoordinates\n  | ISupportCodeLibrary\n\n/**\n * @public\n */\nexport type { ISupportCodeLibrary }\n\n/**\n * @public\n */\nexport interface IRunOptions {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinatesOrLibrary\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n}\n\n/**\n * Contextual data about the project environment.\n *\n * @public\n */\nexport interface IRunEnvironment {\n  /**\n   * Working directory for the project (defaults to `process.cwd()` if omitted).\n   */\n  cwd?: string\n  /**\n   * Writable stream where the test run's main output is written (defaults to `process.stdout` if omitted).\n   */\n  stdout?: Writable\n  /**\n   * Writable stream where the test run's warning/error output is written (defaults to `process.stderr` if omitted).\n   */\n  stderr?: Writable\n  /**\n   * Environment variables (defaults to `process.env` if omitted).\n   */\n  env?: NodeJS.ProcessEnv\n  /**\n   * Whether debug logging is enabled.\n   */\n  debug?: boolean\n}\n\n/**\n * Result of a Cucumber test run.\n *\n * @public\n */\nexport interface IRunResult {\n  /**\n   * Whether the test run was overall successful i.e. no failed scenarios. The exact meaning can vary based on the `strict` configuration option.\n   */\n  success: boolean\n  /**\n   * The support code library that was used in the test run; can be reused in subsequent `runCucumber` calls.\n   */\n  support: ISupportCodeLibrary\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\nimport { JsonObject } from 'type-fest'\nimport { IPublishConfig } from '../publish'\nimport { IConfiguration } from '../configuration'\nimport { IPickleOrder } from '../filter'\n\n/**\n * Options for {@link loadConfiguration}\n * @public\n */\nexport interface ILoadConfigurationOptions {\n  /**\n   * Path to load configuration file from, or `false` to skip\n   * @default `cucumber.(json|yaml|yml|js|cjs|mjs)`\n   */\n  file?: string | false\n  /**\n   * Zero or more profile names from which to source configuration in the file\n   * @remarks\n   * If omitted or empty, the `default` profile will be used.\n   */\n  profiles?: string[]\n  /**\n   * Ad-hoc configuration options to be merged over the top of whatever is\n   * loaded from the configuration file/profiles\n   */\n  provided?: Partial<IConfiguration>\n}\n\n/**\n * Response from {@link loadConfiguration}\n * @public\n */\nexport interface IResolvedConfiguration {\n  /**\n   * The final flat configuration object resolved from the configuration\n   * file/profiles plus any extra provided\n   */\n  useConfiguration: IConfiguration\n  /**\n   * The format that can be passed into {@link runCucumber}\n   */\n  runConfiguration: IRunConfiguration\n}\n\n/**\n * Options relating to sources (i.e. feature files) - where to load them from,\n * how to interpret, filter and order them\n * @public\n */\nexport interface ISourcesCoordinates {\n  /**\n   * Default Gherkin dialect\n   * @remarks\n   * Used if no dialect is specified in the feature file itself.\n   */\n  defaultDialect: string\n  /**\n   * Paths and/or glob expressions to feature files\n   */\n  paths: string[]\n  /**\n   * Regular expressions of which scenario names should match one of to be run\n   */\n  names: string[]\n  /**\n   * Tag expression to filter which scenarios should be run\n   */\n  tagExpression: string\n  /**\n   * Run in the order defined, or in a random order\n   */\n  order: IPickleOrder\n}\n\n/**\n * A pickle that has been successfully compiled from a source\n * @public\n */\nexport interface IPlannedPickle {\n  /**\n   * Name of the pickle (after parameter resolution)\n   */\n  name: string\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n}\n\n/**\n * An error encountered when parsing a source\n * @public\n */\nexport interface ISourcesError {\n  uri: string\n  location: {\n    line: number\n    column?: number\n  }\n  /**\n   * Error message explaining what went wrong with the parse\n   */\n  message: string\n}\n\n/**\n * Response from {@link loadSources}\n * @public\n */\nexport interface ILoadSourcesResult {\n  /**\n   * Pickles that have been successfully compiled, in the order they would be\n   * run in\n   */\n  plan: IPlannedPickle[]\n  /**\n   * Any errors encountered when parsing sources\n   */\n  errors: ISourcesError[]\n}\n\n/**\n * Options relating to user code (aka support code) - where to load it from and\n * how to preprocess it\n * @public\n */\nexport interface ISupportCodeCoordinates {\n  /**\n   * Names of transpilation modules to load, via `require()`\n   */\n  requireModules: string[]\n  /**\n   * Paths and/or glob expressions of user code to load, via `require()`\n   */\n  requirePaths: string[]\n  /**\n   * Paths and/or glob expressions of user code to load, via `import()`\n   */\n  importPaths: string[]\n}\n\n/**\n * Options for {@link loadSupport}\n * @public\n * @remarks\n * A subset of {@link IRunConfiguration}\n */\nexport interface ILoadSupportOptions {\n  /**\n   * @remarks\n   * This is needed because the default support path locations are derived from\n   * feature file locations.\n   */\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n}\n\n/**\n * Options relating to behaviour when actually running tests\n * @public\n */\nexport interface IRunOptionsRuntime {\n  /**\n   * Perform a dry run, where a test run is prepared but nothing is executed\n   */\n  dryRun: boolean\n  /**\n   * Stop running tests when a test fails\n   */\n  failFast: boolean\n  /**\n   * Filter out stack frames from Cucumber's code when formatting stack traces\n   */\n  filterStacktraces: boolean\n  /**\n   * Run tests in parallel with the given number of worker processes\n   */\n  parallel: number\n  /**\n   * Retry failing tests up to the given number of times\n   */\n  retry: number\n  /**\n   * Tag expression to filter which scenarios can be retried\n   */\n  retryTagFilter: string\n  /**\n   * Fail the test run if there are pending steps\n   */\n  strict: boolean\n  /**\n   * Parameters to be passed to the World\n   * @remarks\n   * The value must be a JSON-serializable object.\n   */\n  worldParameters: JsonObject\n}\n\n/**\n * Options relating to formatters - which ones to use, where to write their\n * output, how they should behave\n * @public\n */\nexport interface IRunOptionsFormats {\n  /**\n   * Name/path of the formatter to use for `stdout` output\n   */\n  stdout: string\n  /**\n   * Zero or more mappings of file output path (key) to name/path of the\n   * formatter to use (value)\n   * @example\n   * \\{\n   *   \"./reports/cucumber.html\": \"html\",\n   *   \"./reports/custom.txt\": \"./custom-formatter.js\"\n   * \\}\n   */\n  files: Record<string, string>\n  /**\n   * Options for report publication, or `false` to disable publication\n   */\n  publish: IPublishConfig | false\n  /**\n   * Options to be provided to formatters\n   * @remarks\n   * The value must be a JSON-serializable object.\n   */\n  options: JsonObject\n}\n\n/**\n * Structured configuration object suitable for passing to {@link runCucumber}\n * @public\n */\nexport interface IRunConfiguration {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinates\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n}\n\n/**\n * A collection of user-defined code and setup (\"support code\") that can be\n * used for a test run\n * @public\n * @remarks\n * This is mostly a marker interface. The actual instance is a complex object\n * that you shouldn't interact with directly, but some functions return and/or\n * accept it as a means of optimising a test workflow.\n */\nexport interface ISupportCodeLibrary {\n  readonly originalCoordinates: ISupportCodeCoordinates\n}\n\n/**\n * Either an actual {@link ISupportCodeLibrary | support code library}, or the\n * {@link ISupportCodeCoordinates | coordinates} required to create and\n * populate one\n * @public\n * @remarks\n * This alias exists because {@link runCucumber} will accept an existing\n * support code library in its options and thus avoid trying to load it again,\n * improving performance and avoiding cache issues for use cases where multiple\n * test runs happen within the same process. Note this is only useful in serial\n * mode, as parallel workers will each load the support code themselves anyway.\n */\nexport type ISupportCodeCoordinatesOrLibrary =\n  | ISupportCodeCoordinates\n  | ISupportCodeLibrary\n\n/**\n * Options for {@link runCucumber}\n * @public\n */\nexport interface IRunOptions {\n  sources: ISourcesCoordinates\n  support: ISupportCodeCoordinatesOrLibrary\n  runtime: IRunOptionsRuntime\n  formats: IRunOptionsFormats\n}\n\n/**\n * Contextual data about the project environment\n * @public\n */\nexport interface IRunEnvironment {\n  /**\n   * Working directory for the project\n   * @default process.cwd()\n   */\n  cwd?: string\n  /**\n   * Writable stream where the test run's main formatter output is written\n   * @default process.stdout\n   */\n  stdout?: Writable\n  /**\n   * Writable stream where the test run's warning/error output is written\n   * @default process.stderr\n   */\n  stderr?: Writable\n  /**\n   * Environment variables\n   * @default process.env\n   */\n  env?: NodeJS.ProcessEnv\n  /**\n   * Whether debug logging should be emitted to {@link IRunEnvironment.stderr}\n   * @default false\n   * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/debugging.md}\n   */\n  debug?: boolean\n}\n\n/**\n * Response from {@link runCucumber}\n * @public\n */\nexport interface IRunResult {\n  /**\n   * Whether the test run was overall successful\n   * @remarks\n   * The exact meaning can vary based on the `strict` configuration option.\n   */\n  success: boolean\n  /**\n   * The support code library that was used in the test run\n   * @remarks\n   * This can be reused in subsequent {@link runCucumber} calls,\n   * see {@link ISupportCodeCoordinatesOrLibrary}\n   */\n  support: ISupportCodeLibrary\n}\n"]}

package/lib/cli/helpers.d.ts

@@ -6,9 +6,9 @@ import { Readable } from 'node:stream';
 import { IdGenerator } from '@cucumber/messages';
 import { EventDataCollector } from '../formatter/helpers';
 import PickleFilter from '../pickle_filter';
-import { ISupportCodeLibrary } from '../support_code_library_builder/types';
-import { PickleOrder } from '../models/pickle_order';
+import { SupportCodeLibrary } from '../support_code_library_builder/types';
 import { ILogger } from '../logger';
+import { IPickleOrder } from '../filter';
 interface IParseGherkinMessageStreamRequest {
     cwd?: string;
     eventBroadcaster: EventEmitter;
@@ -27,11 +27,11 @@ interface IParseGherkinMessageStreamRequest {
  * @param pickleFilter
  */
 export declare function parseGherkinMessageStream({ eventBroadcaster, eventDataCollector, gherkinMessageStream, order, pickleFilter, }: IParseGherkinMessageStreamRequest): Promise<string[]>;
-export declare function orderPickles<T = string>(pickleIds: T[], order: PickleOrder, logger: ILogger): void;
+export declare function orderPickles<T = string>(pickleIds: T[], order: IPickleOrder, logger: ILogger): void;
 export declare function emitMetaMessage(eventBroadcaster: EventEmitter, env: NodeJS.ProcessEnv): Promise<void>;
 export declare function emitSupportCodeMessages({ eventBroadcaster, supportCodeLibrary, newId, }: {
     eventBroadcaster: EventEmitter;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
     newId: IdGenerator.NewId;
 }): void;
 export {};

package/lib/cli/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/cli/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,sDAAwB;AACxB,gFAA0C;AAC1C,6DAA8C;AAE9C,8EAA0D;AAC1D,oDAAgD;AAOhD,wCAAoC;AAapC;;;;;;;;GAQG;AACI,KAAK,UAAU,yBAAyB,CAAC,EAC9C,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EACL,YAAY,GACsB;IAClC,OAAO,MAAM,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAA2B,EAAE,EAAE;YAC9D,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;YAC3C,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAA;gBAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAA;gBAC1B,MAAM,eAAe,GAAG,kBAAkB,CAAC,kBAAkB,CAC3D,MAAM,CAAC,GAAG,CACX,CAAA;gBACD,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE;oBACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;iBACtB;aACF;QACH,CAAC,CAAC,CAAA;QACF,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAClC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;YACpC,OAAO,CAAC,MAAM,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;QACF,oBAAoB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC;AA5BD,8DA4BC;AAED,+CAA+C;AAC/C,SAAgB,YAAY,CAC1B,SAAc,EACd,KAAkB,EAClB,MAAe;IAEf,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;IACtC,QAAQ,IAAI,EAAE;QACZ,KAAK,SAAS;YACZ,MAAK;QACP,KAAK,QAAQ;YACX,IAAI,IAAI,KAAK,EAAE,EAAE;gBACf,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAClE,MAAM,CAAC,IAAI,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAA;gBAClD,IAAA,8BAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAA;aAC5B;iBAAM;gBACL,IAAA,8BAAO,EAAC,SAAS,EAAE,IAAI,CAAC,CAAA;aACzB;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;KACJ;AACH,CAAC;AAvBD,oCAuBC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;KACnB;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC;AAEM,KAAK,UAAU,eAAe,CACnC,gBAA8B,EAC9B,GAAsB;IAEtB,MAAM,IAAI,GAAkB;QAC1B,eAAe,EAAE,QAAQ,CAAC,OAAO;QACjC,cAAc,EAAE;YACd,OAAO,EAAP,iBAAO;YACP,IAAI,EAAE,aAAa;SACpB;QACD,GAAG,EAAE;YACH,IAAI,EAAE,iBAAE,CAAC,IAAI,EAAE;SAChB;QACD,EAAE,EAAE;YACF,IAAI,EAAE,iBAAE,CAAC,QAAQ,EAAE;YACnB,OAAO,EAAE,iBAAE,CAAC,OAAO,EAAE;SACtB;QACD,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;SAC/B;QACD,EAAE,EAAE,IAAA,wBAAmB,EAAC,GAAG,CAAC;KAC7B,CAAA;IACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;QAChC,IAAI;KACL,CAAC,CAAA;AACJ,CAAC;AA1BD,0CA0BC;AAED,MAAM,mBAAmB,GAAG,CAAC,MAAmB,EAAE,EAAE,CAAC,CAAC;IACpD,GAAG,EAAE,MAAM,CAAC,GAAG;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB;CACF,CAAC,CAAA;AAEF,SAAS,kBAAkB,CACzB,kBAAuC,EACvC,gBAA8B,EAC9B,KAAwB;IAExB,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,qBAAqB;SACjE,cAAc,EAAE;QACjB,IAAI,aAAa,CAAC,OAAO,EAAE;YACzB,SAAQ;SACT;QACD,MAAM,MAAM,GACV,kBAAkB,CAAC,qBAAqB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;QACtE,MAAM,QAAQ,GAAsB;YAClC,aAAa,EAAE;gBACb,EAAE,EAAE,KAAK,EAAE;gBACX,IAAI,EAAE,aAAa,CAAC,IAAI;gBACxB,+BAA+B,EAAE,aAAa,CAAC,oBAAoB;gBACnE,kBAAkB,EAAE,aAAa,CAAC,aAAa;gBAC/C,cAAc,EAAE,aAAa,CAAC,cAAc;gBAC5C,eAAe,EAAE,mBAAmB,CAAC,MAAM,CAAC;aAC7C;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KAC5C;AACH,CAAC;AAED,SAAS,2BAA2B,CAClC,kBAAuC,EACvC,gBAA8B;IAE9B,KAAK,MAAM,sBAAsB,IAAI,kBAAkB,CAAC,uBAAuB,EAAE;QAC/E,MAAM,QAAQ,GAAsB;YAClC,sBAAsB;SACvB,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KAC5C;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,kBAAuC,EACvC,gBAA8B;IAE9B,kBAAkB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;QAC5D,MAAM,QAAQ,GAAsB;YAClC,cAAc,EAAE;gBACd,EAAE,EAAE,cAAc,CAAC,EAAE;gBACrB,OAAO,EAAE;oBACP,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACzC,IAAI,EACF,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;wBACxC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,mBAAmB;wBACxD,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,kBAAkB;iBAC5D;gBACD,eAAe,EAAE,mBAAmB,CAAC,cAAc,CAAC;aACrD;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,kBAAuC,EACvC,gBAA8B;IAE9B,CAAC;IAAA,EAAE;SACA,MAAM,CACL,kBAAkB,CAAC,6BAA6B,EAChD,kBAAkB,CAAC,4BAA4B,CAChD;SACA,OAAO,CAAC,CAAC,sBAA8C,EAAE,EAAE;QAC1D,MAAM,QAAQ,GAAsB;YAClC,IAAI,EAAE;gBACJ,EAAE,EAAE,sBAAsB,CAAC,EAAE;gBAC7B,IAAI,EAAE,sBAAsB,CAAC,IAAI;gBACjC,aAAa,EAAE,sBAAsB,CAAC,aAAa;gBACnD,eAAe,EAAE,mBAAmB,CAAC,sBAAsB,CAAC;aAC7D;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACN,CAAC;AAED,SAAS,gBAAgB,CACvB,kBAAuC,EACvC,gBAA8B;IAE9B,CAAC;IAAA,EAAE;SACA,MAAM,CACL,kBAAkB,CAAC,4BAA4B,EAC/C,kBAAkB,CAAC,2BAA2B,CAC/C;SACA,OAAO,CAAC,CAAC,qBAA4C,EAAE,EAAE;QACxD,MAAM,QAAQ,GAAsB;YAClC,IAAI,EAAE;gBACJ,EAAE,EAAE,qBAAqB,CAAC,EAAE;gBAC5B,eAAe,EAAE,mBAAmB,CAAC,qBAAqB,CAAC;aAC5D;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACN,CAAC;AAED,SAAgB,uBAAuB,CAAC,EACtC,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,GAKN;IACC,kBAAkB,CAAC,kBAAkB,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAA;IAC/D,2BAA2B,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACjE,mBAAmB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACzD,iBAAiB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACvD,gBAAgB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;AACxD,CAAC;AAdD,0DAcC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport { Readable } from 'node:stream'\nimport os from 'node:os'\nimport shuffle from 'knuth-shuffle-seeded'\nimport * as messages from '@cucumber/messages'\nimport { IdGenerator } from '@cucumber/messages'\nimport detectCiEnvironment from '@cucumber/ci-environment'\nimport { doesHaveValue } from '../value_checker'\nimport { EventDataCollector } from '../formatter/helpers'\nimport PickleFilter from '../pickle_filter'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport TestCaseHookDefinition from '../models/test_case_hook_definition'\nimport TestRunHookDefinition from '../models/test_run_hook_definition'\nimport { PickleOrder } from '../models/pickle_order'\nimport { version } from '../version'\nimport { ILogger } from '../logger'\nimport { ILineAndUri } from '../types'\n\ninterface IParseGherkinMessageStreamRequest {\n  cwd?: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  gherkinMessageStream: Readable\n  order: string\n  pickleFilter: PickleFilter\n}\n\n/**\n * Process a stream of envelopes from Gherkin and resolve to an array of filtered, ordered pickle Ids\n *\n * @param eventBroadcaster\n * @param eventDataCollector\n * @param gherkinMessageStream\n * @param order\n * @param pickleFilter\n */\nexport async function parseGherkinMessageStream({\n  eventBroadcaster,\n  eventDataCollector,\n  gherkinMessageStream,\n  order,\n  pickleFilter,\n}: IParseGherkinMessageStreamRequest): Promise<string[]> {\n  return await new Promise<string[]>((resolve, reject) => {\n    const result: string[] = []\n    gherkinMessageStream.on('data', (envelope: messages.Envelope) => {\n      eventBroadcaster.emit('envelope', envelope)\n      if (doesHaveValue(envelope.pickle)) {\n        const pickle = envelope.pickle\n        const pickleId = pickle.id\n        const gherkinDocument = eventDataCollector.getGherkinDocument(\n          pickle.uri\n        )\n        if (pickleFilter.matches({ gherkinDocument, pickle })) {\n          result.push(pickleId)\n        }\n      }\n    })\n    gherkinMessageStream.on('end', () => {\n      orderPickles(result, order, console)\n      resolve(result)\n    })\n    gherkinMessageStream.on('error', reject)\n  })\n}\n\n// Orders the pickleIds in place - morphs input\nexport function orderPickles<T = string>(\n  pickleIds: T[],\n  order: PickleOrder,\n  logger: ILogger\n): void {\n  const [type, seed] = splitOrder(order)\n  switch (type) {\n    case 'defined':\n      break\n    case 'random':\n      if (seed === '') {\n        const newSeed = Math.floor(Math.random() * 1000 * 1000).toString()\n        logger.warn(`Random order using seed: ${newSeed}`)\n        shuffle(pickleIds, newSeed)\n      } else {\n        shuffle(pickleIds, seed)\n      }\n      break\n    default:\n      throw new Error(\n        'Unrecgonized order type. Should be `defined` or `random`'\n      )\n  }\n}\n\nfunction splitOrder(order: string) {\n  if (!order.includes(':')) {\n    return [order, '']\n  }\n  return order.split(':')\n}\n\nexport async function emitMetaMessage(\n  eventBroadcaster: EventEmitter,\n  env: NodeJS.ProcessEnv\n): Promise<void> {\n  const meta: messages.Meta = {\n    protocolVersion: messages.version,\n    implementation: {\n      version,\n      name: 'cucumber-js',\n    },\n    cpu: {\n      name: os.arch(),\n    },\n    os: {\n      name: os.platform(),\n      version: os.release(),\n    },\n    runtime: {\n      name: 'node.js',\n      version: process.versions.node,\n    },\n    ci: detectCiEnvironment(env),\n  }\n  eventBroadcaster.emit('envelope', {\n    meta,\n  })\n}\n\nconst makeSourceReference = (source: ILineAndUri) => ({\n  uri: source.uri,\n  location: {\n    line: source.line,\n  },\n})\n\nfunction emitParameterTypes(\n  supportCodeLibrary: ISupportCodeLibrary,\n  eventBroadcaster: EventEmitter,\n  newId: IdGenerator.NewId\n): void {\n  for (const parameterType of supportCodeLibrary.parameterTypeRegistry\n    .parameterTypes) {\n    if (parameterType.builtin) {\n      continue\n    }\n    const source =\n      supportCodeLibrary.parameterTypeRegistry.lookupSource(parameterType)\n    const envelope: messages.Envelope = {\n      parameterType: {\n        id: newId(),\n        name: parameterType.name,\n        preferForRegularExpressionMatch: parameterType.preferForRegexpMatch,\n        regularExpressions: parameterType.regexpStrings,\n        useForSnippets: parameterType.useForSnippets,\n        sourceReference: makeSourceReference(source),\n      },\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  }\n}\n\nfunction emitUndefinedParameterTypes(\n  supportCodeLibrary: ISupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  for (const undefinedParameterType of supportCodeLibrary.undefinedParameterTypes) {\n    const envelope: messages.Envelope = {\n      undefinedParameterType,\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  }\n}\n\nfunction emitStepDefinitions(\n  supportCodeLibrary: ISupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  supportCodeLibrary.stepDefinitions.forEach((stepDefinition) => {\n    const envelope: messages.Envelope = {\n      stepDefinition: {\n        id: stepDefinition.id,\n        pattern: {\n          source: stepDefinition.pattern.toString(),\n          type:\n            typeof stepDefinition.pattern === 'string'\n              ? messages.StepDefinitionPatternType.CUCUMBER_EXPRESSION\n              : messages.StepDefinitionPatternType.REGULAR_EXPRESSION,\n        },\n        sourceReference: makeSourceReference(stepDefinition),\n      },\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  })\n}\n\nfunction emitTestCaseHooks(\n  supportCodeLibrary: ISupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[]\n    .concat(\n      supportCodeLibrary.beforeTestCaseHookDefinitions,\n      supportCodeLibrary.afterTestCaseHookDefinitions\n    )\n    .forEach((testCaseHookDefinition: TestCaseHookDefinition) => {\n      const envelope: messages.Envelope = {\n        hook: {\n          id: testCaseHookDefinition.id,\n          name: testCaseHookDefinition.name,\n          tagExpression: testCaseHookDefinition.tagExpression,\n          sourceReference: makeSourceReference(testCaseHookDefinition),\n        },\n      }\n      eventBroadcaster.emit('envelope', envelope)\n    })\n}\n\nfunction emitTestRunHooks(\n  supportCodeLibrary: ISupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[]\n    .concat(\n      supportCodeLibrary.beforeTestRunHookDefinitions,\n      supportCodeLibrary.afterTestRunHookDefinitions\n    )\n    .forEach((testRunHookDefinition: TestRunHookDefinition) => {\n      const envelope: messages.Envelope = {\n        hook: {\n          id: testRunHookDefinition.id,\n          sourceReference: makeSourceReference(testRunHookDefinition),\n        },\n      }\n      eventBroadcaster.emit('envelope', envelope)\n    })\n}\n\nexport function emitSupportCodeMessages({\n  eventBroadcaster,\n  supportCodeLibrary,\n  newId,\n}: {\n  eventBroadcaster: EventEmitter\n  supportCodeLibrary: ISupportCodeLibrary\n  newId: IdGenerator.NewId\n}): void {\n  emitParameterTypes(supportCodeLibrary, eventBroadcaster, newId)\n  emitUndefinedParameterTypes(supportCodeLibrary, eventBroadcaster)\n  emitStepDefinitions(supportCodeLibrary, eventBroadcaster)\n  emitTestCaseHooks(supportCodeLibrary, eventBroadcaster)\n  emitTestRunHooks(supportCodeLibrary, eventBroadcaster)\n}\n"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/cli/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,sDAAwB;AACxB,gFAA0C;AAC1C,6DAA8C;AAE9C,8EAA0D;AAC1D,oDAAgD;AAMhD,wCAAoC;AAcpC;;;;;;;;GAQG;AACI,KAAK,UAAU,yBAAyB,CAAC,EAC9C,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EACL,YAAY,GACsB;IAClC,OAAO,MAAM,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAA2B,EAAE,EAAE;YAC9D,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;YAC3C,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAA;gBAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAA;gBAC1B,MAAM,eAAe,GAAG,kBAAkB,CAAC,kBAAkB,CAC3D,MAAM,CAAC,GAAG,CACX,CAAA;gBACD,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE;oBACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;iBACtB;aACF;QACH,CAAC,CAAC,CAAA;QACF,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAClC,YAAY,CAAC,MAAM,EAAE,KAAqB,EAAE,OAAO,CAAC,CAAA;YACpD,OAAO,CAAC,MAAM,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;QACF,oBAAoB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC;AA5BD,8DA4BC;AAED,+CAA+C;AAC/C,SAAgB,YAAY,CAC1B,SAAc,EACd,KAAmB,EACnB,MAAe;IAEf,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;IACtC,QAAQ,IAAI,EAAE;QACZ,KAAK,SAAS;YACZ,MAAK;QACP,KAAK,QAAQ;YACX,IAAI,IAAI,KAAK,EAAE,EAAE;gBACf,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAClE,MAAM,CAAC,IAAI,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAA;gBAClD,IAAA,8BAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAA;aAC5B;iBAAM;gBACL,IAAA,8BAAO,EAAC,SAAS,EAAE,IAAI,CAAC,CAAA;aACzB;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;KACJ;AACH,CAAC;AAvBD,oCAuBC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;KACnB;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC;AAEM,KAAK,UAAU,eAAe,CACnC,gBAA8B,EAC9B,GAAsB;IAEtB,MAAM,IAAI,GAAkB;QAC1B,eAAe,EAAE,QAAQ,CAAC,OAAO;QACjC,cAAc,EAAE;YACd,OAAO,EAAP,iBAAO;YACP,IAAI,EAAE,aAAa;SACpB;QACD,GAAG,EAAE;YACH,IAAI,EAAE,iBAAE,CAAC,IAAI,EAAE;SAChB;QACD,EAAE,EAAE;YACF,IAAI,EAAE,iBAAE,CAAC,QAAQ,EAAE;YACnB,OAAO,EAAE,iBAAE,CAAC,OAAO,EAAE;SACtB;QACD,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;SAC/B;QACD,EAAE,EAAE,IAAA,wBAAmB,EAAC,GAAG,CAAC;KAC7B,CAAA;IACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;QAChC,IAAI;KACL,CAAC,CAAA;AACJ,CAAC;AA1BD,0CA0BC;AAED,MAAM,mBAAmB,GAAG,CAAC,MAAmB,EAAE,EAAE,CAAC,CAAC;IACpD,GAAG,EAAE,MAAM,CAAC,GAAG;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB;CACF,CAAC,CAAA;AAEF,SAAS,kBAAkB,CACzB,kBAAsC,EACtC,gBAA8B,EAC9B,KAAwB;IAExB,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,qBAAqB;SACjE,cAAc,EAAE;QACjB,IAAI,aAAa,CAAC,OAAO,EAAE;YACzB,SAAQ;SACT;QACD,MAAM,MAAM,GACV,kBAAkB,CAAC,qBAAqB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;QACtE,MAAM,QAAQ,GAAsB;YAClC,aAAa,EAAE;gBACb,EAAE,EAAE,KAAK,EAAE;gBACX,IAAI,EAAE,aAAa,CAAC,IAAI;gBACxB,+BAA+B,EAAE,aAAa,CAAC,oBAAoB;gBACnE,kBAAkB,EAAE,aAAa,CAAC,aAAa;gBAC/C,cAAc,EAAE,aAAa,CAAC,cAAc;gBAC5C,eAAe,EAAE,mBAAmB,CAAC,MAAM,CAAC;aAC7C;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KAC5C;AACH,CAAC;AAED,SAAS,2BAA2B,CAClC,kBAAsC,EACtC,gBAA8B;IAE9B,KAAK,MAAM,sBAAsB,IAAI,kBAAkB,CAAC,uBAAuB,EAAE;QAC/E,MAAM,QAAQ,GAAsB;YAClC,sBAAsB;SACvB,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KAC5C;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,kBAAsC,EACtC,gBAA8B;IAE9B,kBAAkB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;QAC5D,MAAM,QAAQ,GAAsB;YAClC,cAAc,EAAE;gBACd,EAAE,EAAE,cAAc,CAAC,EAAE;gBACrB,OAAO,EAAE;oBACP,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACzC,IAAI,EACF,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;wBACxC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,mBAAmB;wBACxD,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,kBAAkB;iBAC5D;gBACD,eAAe,EAAE,mBAAmB,CAAC,cAAc,CAAC;aACrD;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,kBAAsC,EACtC,gBAA8B;IAE9B,CAAC;IAAA,EAAE;SACA,MAAM,CACL,kBAAkB,CAAC,6BAA6B,EAChD,kBAAkB,CAAC,4BAA4B,CAChD;SACA,OAAO,CAAC,CAAC,sBAA8C,EAAE,EAAE;QAC1D,MAAM,QAAQ,GAAsB;YAClC,IAAI,EAAE;gBACJ,EAAE,EAAE,sBAAsB,CAAC,EAAE;gBAC7B,IAAI,EAAE,sBAAsB,CAAC,IAAI;gBACjC,aAAa,EAAE,sBAAsB,CAAC,aAAa;gBACnD,eAAe,EAAE,mBAAmB,CAAC,sBAAsB,CAAC;aAC7D;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACN,CAAC;AAED,SAAS,gBAAgB,CACvB,kBAAsC,EACtC,gBAA8B;IAE9B,CAAC;IAAA,EAAE;SACA,MAAM,CACL,kBAAkB,CAAC,4BAA4B,EAC/C,kBAAkB,CAAC,2BAA2B,CAC/C;SACA,OAAO,CAAC,CAAC,qBAA4C,EAAE,EAAE;QACxD,MAAM,QAAQ,GAAsB;YAClC,IAAI,EAAE;gBACJ,EAAE,EAAE,qBAAqB,CAAC,EAAE;gBAC5B,eAAe,EAAE,mBAAmB,CAAC,qBAAqB,CAAC;aAC5D;SACF,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACN,CAAC;AAED,SAAgB,uBAAuB,CAAC,EACtC,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,GAKN;IACC,kBAAkB,CAAC,kBAAkB,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAA;IAC/D,2BAA2B,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACjE,mBAAmB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACzD,iBAAiB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;IACvD,gBAAgB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;AACxD,CAAC;AAdD,0DAcC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport { Readable } from 'node:stream'\nimport os from 'node:os'\nimport shuffle from 'knuth-shuffle-seeded'\nimport * as messages from '@cucumber/messages'\nimport { IdGenerator } from '@cucumber/messages'\nimport detectCiEnvironment from '@cucumber/ci-environment'\nimport { doesHaveValue } from '../value_checker'\nimport { EventDataCollector } from '../formatter/helpers'\nimport PickleFilter from '../pickle_filter'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport TestCaseHookDefinition from '../models/test_case_hook_definition'\nimport TestRunHookDefinition from '../models/test_run_hook_definition'\nimport { version } from '../version'\nimport { ILogger } from '../logger'\nimport { ILineAndUri } from '../types'\nimport { IPickleOrder } from '../filter'\n\ninterface IParseGherkinMessageStreamRequest {\n  cwd?: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  gherkinMessageStream: Readable\n  order: string\n  pickleFilter: PickleFilter\n}\n\n/**\n * Process a stream of envelopes from Gherkin and resolve to an array of filtered, ordered pickle Ids\n *\n * @param eventBroadcaster\n * @param eventDataCollector\n * @param gherkinMessageStream\n * @param order\n * @param pickleFilter\n */\nexport async function parseGherkinMessageStream({\n  eventBroadcaster,\n  eventDataCollector,\n  gherkinMessageStream,\n  order,\n  pickleFilter,\n}: IParseGherkinMessageStreamRequest): Promise<string[]> {\n  return await new Promise<string[]>((resolve, reject) => {\n    const result: string[] = []\n    gherkinMessageStream.on('data', (envelope: messages.Envelope) => {\n      eventBroadcaster.emit('envelope', envelope)\n      if (doesHaveValue(envelope.pickle)) {\n        const pickle = envelope.pickle\n        const pickleId = pickle.id\n        const gherkinDocument = eventDataCollector.getGherkinDocument(\n          pickle.uri\n        )\n        if (pickleFilter.matches({ gherkinDocument, pickle })) {\n          result.push(pickleId)\n        }\n      }\n    })\n    gherkinMessageStream.on('end', () => {\n      orderPickles(result, order as IPickleOrder, console)\n      resolve(result)\n    })\n    gherkinMessageStream.on('error', reject)\n  })\n}\n\n// Orders the pickleIds in place - morphs input\nexport function orderPickles<T = string>(\n  pickleIds: T[],\n  order: IPickleOrder,\n  logger: ILogger\n): void {\n  const [type, seed] = splitOrder(order)\n  switch (type) {\n    case 'defined':\n      break\n    case 'random':\n      if (seed === '') {\n        const newSeed = Math.floor(Math.random() * 1000 * 1000).toString()\n        logger.warn(`Random order using seed: ${newSeed}`)\n        shuffle(pickleIds, newSeed)\n      } else {\n        shuffle(pickleIds, seed)\n      }\n      break\n    default:\n      throw new Error(\n        'Unrecgonized order type. Should be `defined` or `random`'\n      )\n  }\n}\n\nfunction splitOrder(order: string) {\n  if (!order.includes(':')) {\n    return [order, '']\n  }\n  return order.split(':')\n}\n\nexport async function emitMetaMessage(\n  eventBroadcaster: EventEmitter,\n  env: NodeJS.ProcessEnv\n): Promise<void> {\n  const meta: messages.Meta = {\n    protocolVersion: messages.version,\n    implementation: {\n      version,\n      name: 'cucumber-js',\n    },\n    cpu: {\n      name: os.arch(),\n    },\n    os: {\n      name: os.platform(),\n      version: os.release(),\n    },\n    runtime: {\n      name: 'node.js',\n      version: process.versions.node,\n    },\n    ci: detectCiEnvironment(env),\n  }\n  eventBroadcaster.emit('envelope', {\n    meta,\n  })\n}\n\nconst makeSourceReference = (source: ILineAndUri) => ({\n  uri: source.uri,\n  location: {\n    line: source.line,\n  },\n})\n\nfunction emitParameterTypes(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter,\n  newId: IdGenerator.NewId\n): void {\n  for (const parameterType of supportCodeLibrary.parameterTypeRegistry\n    .parameterTypes) {\n    if (parameterType.builtin) {\n      continue\n    }\n    const source =\n      supportCodeLibrary.parameterTypeRegistry.lookupSource(parameterType)\n    const envelope: messages.Envelope = {\n      parameterType: {\n        id: newId(),\n        name: parameterType.name,\n        preferForRegularExpressionMatch: parameterType.preferForRegexpMatch,\n        regularExpressions: parameterType.regexpStrings,\n        useForSnippets: parameterType.useForSnippets,\n        sourceReference: makeSourceReference(source),\n      },\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  }\n}\n\nfunction emitUndefinedParameterTypes(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  for (const undefinedParameterType of supportCodeLibrary.undefinedParameterTypes) {\n    const envelope: messages.Envelope = {\n      undefinedParameterType,\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  }\n}\n\nfunction emitStepDefinitions(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  supportCodeLibrary.stepDefinitions.forEach((stepDefinition) => {\n    const envelope: messages.Envelope = {\n      stepDefinition: {\n        id: stepDefinition.id,\n        pattern: {\n          source: stepDefinition.pattern.toString(),\n          type:\n            typeof stepDefinition.pattern === 'string'\n              ? messages.StepDefinitionPatternType.CUCUMBER_EXPRESSION\n              : messages.StepDefinitionPatternType.REGULAR_EXPRESSION,\n        },\n        sourceReference: makeSourceReference(stepDefinition),\n      },\n    }\n    eventBroadcaster.emit('envelope', envelope)\n  })\n}\n\nfunction emitTestCaseHooks(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[]\n    .concat(\n      supportCodeLibrary.beforeTestCaseHookDefinitions,\n      supportCodeLibrary.afterTestCaseHookDefinitions\n    )\n    .forEach((testCaseHookDefinition: TestCaseHookDefinition) => {\n      const envelope: messages.Envelope = {\n        hook: {\n          id: testCaseHookDefinition.id,\n          name: testCaseHookDefinition.name,\n          tagExpression: testCaseHookDefinition.tagExpression,\n          sourceReference: makeSourceReference(testCaseHookDefinition),\n        },\n      }\n      eventBroadcaster.emit('envelope', envelope)\n    })\n}\n\nfunction emitTestRunHooks(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[]\n    .concat(\n      supportCodeLibrary.beforeTestRunHookDefinitions,\n      supportCodeLibrary.afterTestRunHookDefinitions\n    )\n    .forEach((testRunHookDefinition: TestRunHookDefinition) => {\n      const envelope: messages.Envelope = {\n        hook: {\n          id: testRunHookDefinition.id,\n          sourceReference: makeSourceReference(testRunHookDefinition),\n        },\n      }\n      eventBroadcaster.emit('envelope', envelope)\n    })\n}\n\nexport function emitSupportCodeMessages({\n  eventBroadcaster,\n  supportCodeLibrary,\n  newId,\n}: {\n  eventBroadcaster: EventEmitter\n  supportCodeLibrary: SupportCodeLibrary\n  newId: IdGenerator.NewId\n}): void {\n  emitParameterTypes(supportCodeLibrary, eventBroadcaster, newId)\n  emitUndefinedParameterTypes(supportCodeLibrary, eventBroadcaster)\n  emitStepDefinitions(supportCodeLibrary, eventBroadcaster)\n  emitTestCaseHooks(supportCodeLibrary, eventBroadcaster)\n  emitTestRunHooks(supportCodeLibrary, eventBroadcaster)\n}\n"]}

package/lib/configuration/check_schema.js

@@ -34,13 +34,13 @@ const schema = yup.object().shape({
     format: yup
         .array()
         .of(yup.lazy((val) => Array.isArray(val)
-        ? yup.array().of(yup.string()).min(2).max(2)
+        ? yup.array().of(yup.string()).min(1).max(2)
         : yup.string())),
     formatOptions: yup.object(),
     import: yup.array().of(yup.string()),
     language: yup.string().oneOf(Object.keys(gherkin_1.dialects)),
     name: yup.array().of(yup.string()),
-    order: yup.string().oneOf(['defined', 'random']),
+    order: yup.string().matches(/^random:.*|random|defined$/),
     paths: yup.array().of(yup.string()),
     parallel: yup.number().integer().min(0),
     publish: yup.boolean(),

package/lib/configuration/check_schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"check_schema.js","sourceRoot":"","sources":["../../src/configuration/check_schema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA0B;AAC1B,+CAA4C;AAG5C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;IAChC,SAAS,EAAE,GAAG,CAAC,OAAO,EAAE;IACxB,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;IACnB,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE;IACvB,MAAM,EAAE,GAAG;SACR,KAAK,EAAE;SACP,EAAE,CACD,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACf,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CACjB,CACF;IACH,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACpC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAQ,CAAC,CAAC;IACnD,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAChD,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACnC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE;IACtB,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE;IAC3B,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACrC,aAAa,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IAC3C,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACpC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE;IAC5B,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;IAClB,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE;CAC9B,CAAC,CAAA;AAEF,SAAgB,WAAW,CAAC,aAAkB;IAC5C,OAAO,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE;QACxC,UAAU,EAAE,KAAK;QACjB,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;KACnB,CAA4B,CAAA;AAC/B,CAAC;AAND,kCAMC","sourcesContent":["import * as yup from 'yup'\nimport { dialects } from '@cucumber/gherkin'\nimport { IConfiguration } from './types'\n\nconst schema = yup.object().shape({\n  backtrace: yup.boolean(),\n  dryRun: yup.boolean(),\n  exit: yup.boolean(),\n  failFast: yup.boolean(),\n  format: yup\n    .array()\n    .of(\n      yup.lazy((val) =>\n        Array.isArray(val)\n          ? yup.array().of(yup.string()).min(2).max(2)\n          : yup.string()\n      )\n    ),\n  formatOptions: yup.object(),\n  import: yup.array().of(yup.string()),\n  language: yup.string().oneOf(Object.keys(dialects)),\n  name: yup.array().of(yup.string()),\n  order: yup.string().oneOf(['defined', 'random']),\n  paths: yup.array().of(yup.string()),\n  parallel: yup.number().integer().min(0),\n  publish: yup.boolean(),\n  publishQuiet: yup.boolean(),\n  require: yup.array().of(yup.string()),\n  requireModule: yup.array().of(yup.string()),\n  retry: yup.number().integer().min(0),\n  retryTagFilter: yup.string(),\n  strict: yup.boolean(),\n  tags: yup.string(),\n  worldParameters: yup.object(),\n})\n\nexport function checkSchema(configuration: any): Partial<IConfiguration> {\n  return schema.validateSync(configuration, {\n    abortEarly: false,\n    strict: true,\n    stripUnknown: true,\n  }) as Partial<IConfiguration>\n}\n"]}
+{"version":3,"file":"check_schema.js","sourceRoot":"","sources":["../../src/configuration/check_schema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA0B;AAC1B,+CAA4C;AAG5C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;IAChC,SAAS,EAAE,GAAG,CAAC,OAAO,EAAE;IACxB,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;IACnB,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE;IACvB,MAAM,EAAE,GAAG;SACR,KAAK,EAAE;SACP,EAAE,CACD,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACf,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAChB,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CACjB,CACF;IACH,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACpC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAQ,CAAC,CAAC;IACnD,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,4BAA4B,CAAC;IACzD,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACnC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE;IACtB,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE;IAC3B,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACrC,aAAa,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IAC3C,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACpC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE;IAC5B,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE;IACrB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE;IAClB,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE;CAC9B,CAAC,CAAA;AAEF,SAAgB,WAAW,CAAC,aAAkB;IAC5C,OAAO,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE;QACxC,UAAU,EAAE,KAAK;QACjB,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;KACnB,CAA4B,CAAA;AAC/B,CAAC;AAND,kCAMC","sourcesContent":["import * as yup from 'yup'\nimport { dialects } from '@cucumber/gherkin'\nimport { IConfiguration } from './types'\n\nconst schema = yup.object().shape({\n  backtrace: yup.boolean(),\n  dryRun: yup.boolean(),\n  exit: yup.boolean(),\n  failFast: yup.boolean(),\n  format: yup\n    .array()\n    .of(\n      yup.lazy((val) =>\n        Array.isArray(val)\n          ? yup.array().of(yup.string()).min(1).max(2)\n          : yup.string()\n      )\n    ),\n  formatOptions: yup.object(),\n  import: yup.array().of(yup.string()),\n  language: yup.string().oneOf(Object.keys(dialects)),\n  name: yup.array().of(yup.string()),\n  order: yup.string().matches(/^random:.*|random|defined$/),\n  paths: yup.array().of(yup.string()),\n  parallel: yup.number().integer().min(0),\n  publish: yup.boolean(),\n  publishQuiet: yup.boolean(),\n  require: yup.array().of(yup.string()),\n  requireModule: yup.array().of(yup.string()),\n  retry: yup.number().integer().min(0),\n  retryTagFilter: yup.string(),\n  strict: yup.boolean(),\n  tags: yup.string(),\n  worldParameters: yup.object(),\n})\n\nexport function checkSchema(configuration: any): Partial<IConfiguration> {\n  return schema.validateSync(configuration, {\n    abortEarly: false,\n    strict: true,\n    stripUnknown: true,\n  }) as Partial<IConfiguration>\n}\n"]}

package/lib/configuration/types.d.ts

@@ -1,31 +1,147 @@
 import { JsonObject } from 'type-fest';
-import { FormatOptions } from '../formatter';
-import { PickleOrder } from '../models/pickle_order';
-type FormatsConfiguration = Array<string | [string, string?]>;
+import { IPickleOrder } from '../filter';
+/**
+ * User-defined configuration
+ *
+ * @public
+ */
 export interface IConfiguration {
+    /**
+     * Paths to where your feature files are
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#finding-your-features}
+     */
+    paths: string[];
+    /**
+     * Show the full backtrace for errors
+     * @default false
+     */
     backtrace: boolean;
+    /**
+     * Perform a dry run, where a test run is prepared but nothing is executed
+     * @default false
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/dry_run.md}
+     */
     dryRun: boolean;
+    /**
+     * Explicitly call `process.exit()` after the test run
+     * @default false
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/cli.md#exiting}
+     * @remarks
+     * This option is only used by the CLI.
+     */
     forceExit: boolean;
+    /**
+     * Stop running tests when a test fails
+     * @default false
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/fail_fast.md}
+     */
     failFast: boolean;
-    format: FormatsConfiguration;
-    formatOptions: FormatOptions;
+    /**
+     * Name/path and (optionally) output file path of each formatter to use
+     *
+     * @example
+     * [
+     *   "\@cucumber/pretty-formatter",
+     *   ["html", "./reports/cucumber.html"],
+     *   ["./custom-formatter.js", "./reports/custom.txt"]
+     * ]
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md}
+     * @remarks
+     * Each item has one or two values. The first (required) identifies the
+     * formatter to be used. The second (optional) specifies where the output
+     * should be written.
+     */
+    format: Array<string | [string, string?]>;
+    /**
+     * Options to be provided to formatters
+     * @default \{\}
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md#options}
+     * @remarks
+     * The value must be a JSON-serializable object.
+     */
+    formatOptions: JsonObject;
+    /**
+     * Paths to where your support code is
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#finding-your-code}
+     */
     import: string[];
+    /**
+     * Default language for your feature files
+     * @default "en"
+     */
     language: string;
+    /**
+     * Regular expressions of which scenario names should match one of to be run
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/filtering.md#names}
+     */
     name: string[];
-    order: PickleOrder;
-    paths: string[];
+    /**
+     * Run in the order defined, or in a random order
+     * @default "defined"
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/filtering.md#order}
+     */
+    order: IPickleOrder;
+    /**
+     * Run tests in parallel with the given number of worker processes
+     * @default 0
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/parallel.md}
+     */
     parallel: number;
+    /**
+     * Publish a report of your test run to https://reports.cucumber.io/
+     * @default false
+     */
     publish: boolean;
     /**
-     * @deprecated no longer needed; see <https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md>
+     * @deprecated no longer needed
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md}
      */
     publishQuiet: boolean;
+    /**
+     * Paths to where your support code is, for CommonJS
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#finding-your-code}
+     */
     require: string[];
+    /**
+     * Names of transpilation modules to load, via `require()`
+     * @default []
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/transpiling.md}
+     */
     requireModule: string[];
+    /**
+     * Retry failing tests up to the given number of times
+     * @default 0
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/retry.md}
+     */
     retry: number;
+    /**
+     * Tag expression to filter which scenarios can be retried
+     * @default ""
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/retry.md}
+     */
     retryTagFilter: string;
+    /**
+     * Fail the test run if there are pending steps
+     * @default true
+     */
     strict: boolean;
+    /**
+     * Tag expression to filter which scenarios should be run
+     * @default ""
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/filtering.md#tags}
+     */
     tags: string;
+    /**
+     * Parameters to be passed to your World
+     * @default \{\}
+     * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/world.md}
+     * @remarks
+     * The value must be a JSON-serializable object.
+     */
     worldParameters: JsonObject;
 }
-export {};