@cucumber/cucumber 10.2.1 → 10.3.0

package/README.md

@@ -28,7 +28,7 @@ Looking to contribute? Read our [code of conduct](https://github.com/cucumber/.g
 Cucumber is [available on npm](https://www.npmjs.com/package/@cucumber/cucumber):
 
 ```shell
-$ npm install @cucumber/cucumber
+npm install @cucumber/cucumber
 ```
 
 ## Get Started
@@ -79,7 +79,7 @@ Then('I should have heard {string}', function (expectedResponse) {
 Finally, run Cucumber:
 
 ```shell
-$ npx cucumber-js
+npx cucumber-js
 ```
 
 And see the output:

package/lib/api/load_configuration.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfiguration = void 0;
 const locate_file_1 = require("../configuration/locate_file");
 const configuration_1 = require("../configuration");
-const validate_configuration_1 = require("../configuration/validate_configuration");
 const convert_configuration_1 = require("./convert_configuration");
 const environment_1 = require("./environment");
 /**
@@ -28,9 +27,9 @@ async function loadConfiguration(options = {}, environment = {}) {
     const profileConfiguration = configFile
         ? await (0, configuration_1.fromFile)(logger, cwd, configFile, options.profiles)
         : {};
-    const original = (0, configuration_1.mergeConfigurations)(configuration_1.DEFAULT_CONFIGURATION, profileConfiguration, options.provided);
+    const original = (0, configuration_1.mergeConfigurations)(configuration_1.DEFAULT_CONFIGURATION, profileConfiguration, (0, configuration_1.parseConfiguration)(logger, 'Provided', options.provided));
     logger.debug('Resolved configuration:', original);
-    (0, validate_configuration_1.validateConfiguration)(original, logger);
+    (0, configuration_1.validateConfiguration)(original, logger);
     const runnable = await (0, convert_configuration_1.convertConfiguration)(logger, original, env);
     return {
         useConfiguration: original,

package/lib/api/load_configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"load_configuration.js","sourceRoot":"","sources":["../../src/api/load_configuration.ts"],"names":[],"mappings":";;;AAAA,8DAAyD;AACzD,oDAIyB;AACzB,oFAA+E;AAC/E,mEAA8D;AAC9D,+CAAgD;AAOhD;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAqC,EAAE,EACvC,cAA+B,EAAE;IAEjC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IAC1D,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,IAAA,wBAAU,EAAC,GAAG,CAAC,CAAA;IAClD,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,KAAK,CAAC,sCAAsC,UAAU,GAAG,CAAC,CAAA;KAClE;SAAM,IAAI,UAAU,KAAK,KAAK,EAAE;QAC/B,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAA;KACvD;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;KAC5C;IACD,MAAM,oBAAoB,GAAG,UAAU;QACrC,CAAC,CAAC,MAAM,IAAA,wBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,EAAE,CAAA;IACN,MAAM,QAAQ,GAAG,IAAA,mCAAmB,EAClC,qCAAqB,EACrB,oBAAoB,EACpB,OAAO,CAAC,QAAQ,CACjB,CAAA;IACD,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAA;IACjD,IAAA,8CAAqB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACvC,MAAM,QAAQ,GAAG,MAAM,IAAA,4CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAA;IAClE,OAAO;QACL,gBAAgB,EAAE,QAAQ;QAC1B,gBAAgB,EAAE,QAAQ;KAC3B,CAAA;AACH,CAAC;AA5BD,8CA4BC","sourcesContent":["import { locateFile } from '../configuration/locate_file'\nimport {\n  DEFAULT_CONFIGURATION,\n  fromFile,\n  mergeConfigurations,\n} from '../configuration'\nimport { validateConfiguration } from '../configuration/validate_configuration'\nimport { convertConfiguration } from './convert_configuration'\nimport { mergeEnvironment } from './environment'\nimport {\n  IRunEnvironment,\n  IResolvedConfiguration,\n  ILoadConfigurationOptions,\n} from './types'\n\n/**\n * Load user-authored configuration to be used in a test run\n *\n * @public\n * @param options - Coordinates required to find configuration\n * @param environment - Project environment\n */\nexport async function loadConfiguration(\n  options: ILoadConfigurationOptions = {},\n  environment: IRunEnvironment = {}\n): Promise<IResolvedConfiguration> {\n  const { cwd, env, logger } = mergeEnvironment(environment)\n  const configFile = options.file ?? locateFile(cwd)\n  if (configFile) {\n    logger.debug(`Configuration will be loaded from \"${configFile}\"`)\n  } else if (configFile === false) {\n    logger.debug('Skipping configuration file resolution')\n  } else {\n    logger.debug('No configuration file found')\n  }\n  const profileConfiguration = configFile\n    ? await fromFile(logger, cwd, configFile, options.profiles)\n    : {}\n  const original = mergeConfigurations(\n    DEFAULT_CONFIGURATION,\n    profileConfiguration,\n    options.provided\n  )\n  logger.debug('Resolved configuration:', original)\n  validateConfiguration(original, logger)\n  const runnable = await convertConfiguration(logger, original, env)\n  return {\n    useConfiguration: original,\n    runConfiguration: runnable,\n  }\n}\n"]}
+{"version":3,"file":"load_configuration.js","sourceRoot":"","sources":["../../src/api/load_configuration.ts"],"names":[],"mappings":";;;AAAA,8DAAyD;AACzD,oDAMyB;AACzB,mEAA8D;AAC9D,+CAAgD;AAOhD;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAqC,EAAE,EACvC,cAA+B,EAAE;IAEjC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAA,8BAAgB,EAAC,WAAW,CAAC,CAAA;IAC1D,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,IAAA,wBAAU,EAAC,GAAG,CAAC,CAAA;IAClD,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,KAAK,CAAC,sCAAsC,UAAU,GAAG,CAAC,CAAA;KAClE;SAAM,IAAI,UAAU,KAAK,KAAK,EAAE;QAC/B,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAA;KACvD;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;KAC5C;IACD,MAAM,oBAAoB,GAAG,UAAU;QACrC,CAAC,CAAC,MAAM,IAAA,wBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,EAAE,CAAA;IACN,MAAM,QAAQ,GAAG,IAAA,mCAAmB,EAClC,qCAAqB,EACrB,oBAAoB,EACpB,IAAA,kCAAkB,EAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CACzD,CAAA;IACD,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAA;IACjD,IAAA,qCAAqB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACvC,MAAM,QAAQ,GAAG,MAAM,IAAA,4CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAA;IAClE,OAAO;QACL,gBAAgB,EAAE,QAAQ;QAC1B,gBAAgB,EAAE,QAAQ;KAC3B,CAAA;AACH,CAAC;AA5BD,8CA4BC","sourcesContent":["import { locateFile } from '../configuration/locate_file'\nimport {\n  DEFAULT_CONFIGURATION,\n  fromFile,\n  mergeConfigurations,\n  parseConfiguration,\n  validateConfiguration,\n} from '../configuration'\nimport { convertConfiguration } from './convert_configuration'\nimport { mergeEnvironment } from './environment'\nimport {\n  IRunEnvironment,\n  IResolvedConfiguration,\n  ILoadConfigurationOptions,\n} from './types'\n\n/**\n * Load user-authored configuration to be used in a test run\n *\n * @public\n * @param options - Coordinates required to find configuration\n * @param environment - Project environment\n */\nexport async function loadConfiguration(\n  options: ILoadConfigurationOptions = {},\n  environment: IRunEnvironment = {}\n): Promise<IResolvedConfiguration> {\n  const { cwd, env, logger } = mergeEnvironment(environment)\n  const configFile = options.file ?? locateFile(cwd)\n  if (configFile) {\n    logger.debug(`Configuration will be loaded from \"${configFile}\"`)\n  } else if (configFile === false) {\n    logger.debug('Skipping configuration file resolution')\n  } else {\n    logger.debug('No configuration file found')\n  }\n  const profileConfiguration = configFile\n    ? await fromFile(logger, cwd, configFile, options.profiles)\n    : {}\n  const original = mergeConfigurations(\n    DEFAULT_CONFIGURATION,\n    profileConfiguration,\n    parseConfiguration(logger, 'Provided', options.provided)\n  )\n  logger.debug('Resolved configuration:', original)\n  validateConfiguration(original, logger)\n  const runnable = await convertConfiguration(logger, original, env)\n  return {\n    useConfiguration: original,\n    runConfiguration: runnable,\n  }\n}\n"]}

package/lib/api/types.d.ts

@@ -24,8 +24,16 @@ export interface ILoadConfigurationOptions {
     /**
      * Ad-hoc configuration options to be merged over the top of whatever is
      * loaded from the configuration file/profiles
+     * @example
+     * \{
+     *   failFast: true,
+     *   parallel: 2
+     * \}
+     * @example "--fail-fast --parallel 2"
+     * @remarks
+     * This can also be provided as a string of argv-style arguments.
      */
-    provided?: Partial<IConfiguration>;
+    provided?: Partial<IConfiguration> | string;
 }
 /**
  * Response from {@link loadConfiguration}

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 { 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"]}
+{"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   * @example\n   * \\{\n   *   failFast: true,\n   *   parallel: 2\n   * \\}\n   * @example \"--fail-fast --parallel 2\"\n   * @remarks\n   * This can also be provided as a string of argv-style arguments.\n   */\n  provided?: Partial<IConfiguration> | string\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/configuration/from_file.js

@@ -8,12 +8,10 @@ const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const node_util_1 = require("node:util");
 const node_url_1 = require("node:url");
-const string_argv_1 = __importDefault(require("string-argv"));
 const yaml_1 = __importDefault(require("yaml"));
 const read_pkg_up_1 = __importDefault(require("read-pkg-up"));
 const merge_configurations_1 = require("./merge_configurations");
-const argv_parser_1 = __importDefault(require("./argv_parser"));
-const check_schema_1 = require("./check_schema");
+const parse_configuration_1 = require("./parse_configuration");
 async function fromFile(logger, cwd, file, profiles = []) {
     const definitions = await loadFile(logger, cwd, file);
     if (!definitions.default) {
@@ -30,7 +28,7 @@ async function fromFile(logger, cwd, file, profiles = []) {
             throw new Error(`Requested profile "${profileKey}" doesn't exist`);
         }
     });
-    return (0, merge_configurations_1.mergeConfigurations)({}, ...profiles.map((profileKey) => extractConfiguration(logger, profileKey, definitions[profileKey])));
+    return (0, merge_configurations_1.mergeConfigurations)({}, ...profiles.map((profileKey) => (0, parse_configuration_1.parseConfiguration)(logger, `Profile "${profileKey}"`, definitions[profileKey])));
 }
 exports.fromFile = fromFile;
 async function loadFile(logger, cwd, file) {
@@ -85,21 +83,4 @@ async function readPackageJson(filePath) {
     const parentPackage = await (0, read_pkg_up_1.default)({ cwd: node_path_1.default.dirname(filePath) });
     return parentPackage?.packageJson;
 }
-function extractConfiguration(logger, name, definition) {
-    if (typeof definition === 'string') {
-        logger.debug(`Profile "${name}" value is a string; parsing as argv`);
-        const { configuration } = argv_parser_1.default.parse([
-            'node',
-            'cucumber-js',
-            ...(0, string_argv_1.default)(definition),
-        ]);
-        return configuration;
-    }
-    try {
-        return (0, check_schema_1.checkSchema)(definition);
-    }
-    catch (error) {
-        throw new Error(`Requested profile "${name}" failed schema validation: ${error.errors.join(' ')}`);
-    }
-}
 //# sourceMappingURL=from_file.js.map

package/lib/configuration/from_file.js.map

@@ -1 +1 @@
-{"version":3,"file":"from_file.js","sourceRoot":"","sources":["../../src/configuration/from_file.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAwB;AACxB,0DAA4B;AAC5B,yCAAqC;AACrC,uCAAwC;AACxC,8DAAoC;AACpC,gDAAuB;AACvB,8DAAmC;AAGnC,iEAA4D;AAC5D,gEAAsC;AACtC,iDAA4C;AAErC,KAAK,UAAU,QAAQ,CAC5B,MAAe,EACf,GAAW,EACX,IAAY,EACZ,WAAqB,EAAE;IAEvB,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;IACrD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;QACxB,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,WAAW,CAAC,OAAO,GAAG,EAAE,CAAA;KACzB;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;KACvB;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC5C,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,sBAAsB,UAAU,iBAAiB,CAAC,CAAA;SACnE;IACH,CAAC,CAAC,CAAA;IACF,OAAO,IAAA,0CAAmB,EACxB,EAAE,EACF,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC7B,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAClE,CACF,CAAA;AACH,CAAC;AA3BD,4BA2BC;AAED,KAAK,UAAU,QAAQ,CACrB,MAAe,EACf,GAAW,EACX,IAAY;IAEZ,MAAM,QAAQ,GAAW,mBAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC7C,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACxC,IAAI,WAAW,CAAA;IACf,QAAQ,SAAS,EAAE;QACjB,KAAK,OAAO;YACV,WAAW,GAAG,IAAI,CAAC,KAAK,CACtB,MAAM,IAAA,qBAAS,EAAC,iBAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC9D,CAAA;YACD,MAAK;QACP,KAAK,OAAO,CAAC;QACb,KAAK,MAAM;YACT,WAAW,GAAG,cAAI,CAAC,KAAK,CACtB,MAAM,IAAA,qBAAS,EAAC,iBAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC9D,CAAA;YACD,MAAK;QACP,KAAK,MAAM;YACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,kCAAkC,CACtE,CAAA;YACD,8DAA8D;YAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC/B,MAAK;QACP,KAAK,MAAM;YACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,6BAA6B,CACjE,CAAA;YACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC9D,MAAK;QACP,KAAK,KAAK;YACR;gBACE,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAA;gBACrD,IAAI,CAAC,aAAa,EAAE;oBAClB,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oDAAoD,CACxF,CAAA;oBACD,8DAA8D;oBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;iBAChC;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;oBAC1C,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,sBAAsB,aAAa,CAAC,IAAI,gBAAgB,CAC5F,CAAA;oBACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;iBAC/D;qBAAM;oBACL,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,2BAA2B,aAAa,CAAC,IAAI,gBAAgB,CACjG,CAAA;oBACD,8DAA8D;oBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;iBAChC;aACF;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,GAAG,CAAC,CAAA;KAC7E;IACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,4BAA4B,CAAC,CAAA;KAC5E;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,QAAgB;IAC7C,MAAM,aAAa,GAAG,MAAM,IAAA,qBAAS,EAAC,EAAE,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IACtE,OAAO,aAAa,EAAE,WAAW,CAAA;AACnC,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAe,EACf,IAAY,EACZ,UAAe;IAEf,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,sCAAsC,CAAC,CAAA;QACpE,MAAM,EAAE,aAAa,EAAE,GAAG,qBAAU,CAAC,KAAK,CAAC;YACzC,MAAM;YACN,aAAa;YACb,GAAG,IAAA,qBAAU,EAAC,UAAU,CAAC;SAC1B,CAAC,CAAA;QACF,OAAO,aAAa,CAAA;KACrB;IACD,IAAI;QACF,OAAO,IAAA,0BAAW,EAAC,UAAU,CAAC,CAAA;KAC/B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CACb,sBAAsB,IAAI,+BAA+B,KAAK,CAAC,MAAM,CAAC,IAAI,CACxE,GAAG,CACJ,EAAE,CACJ,CAAA;KACF;AACH,CAAC","sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\nimport { promisify } from 'node:util'\nimport { pathToFileURL } from 'node:url'\nimport stringArgv from 'string-argv'\nimport YAML from 'yaml'\nimport readPkgUp from 'read-pkg-up'\nimport { ILogger } from '../logger'\nimport { IConfiguration } from './types'\nimport { mergeConfigurations } from './merge_configurations'\nimport ArgvParser from './argv_parser'\nimport { checkSchema } from './check_schema'\n\nexport async function fromFile(\n  logger: ILogger,\n  cwd: string,\n  file: string,\n  profiles: string[] = []\n): Promise<Partial<IConfiguration>> {\n  const definitions = await loadFile(logger, cwd, file)\n  if (!definitions.default) {\n    logger.debug('No default profile defined in configuration file')\n    definitions.default = {}\n  }\n  if (profiles.length < 1) {\n    logger.debug('No profiles specified; using default profile')\n    profiles = ['default']\n  }\n  const definedKeys = Object.keys(definitions)\n  profiles.forEach((profileKey) => {\n    if (!definedKeys.includes(profileKey)) {\n      throw new Error(`Requested profile \"${profileKey}\" doesn't exist`)\n    }\n  })\n  return mergeConfigurations(\n    {},\n    ...profiles.map((profileKey) =>\n      extractConfiguration(logger, profileKey, definitions[profileKey])\n    )\n  )\n}\n\nasync function loadFile(\n  logger: ILogger,\n  cwd: string,\n  file: string\n): Promise<Record<string, any>> {\n  const filePath: string = path.join(cwd, file)\n  const extension = path.extname(filePath)\n  let definitions\n  switch (extension) {\n    case '.json':\n      definitions = JSON.parse(\n        await promisify(fs.readFile)(filePath, { encoding: 'utf-8' })\n      )\n      break\n    case '.yaml':\n    case '.yml':\n      definitions = YAML.parse(\n        await promisify(fs.readFile)(filePath, { encoding: 'utf-8' })\n      )\n      break\n    case '.cjs':\n      logger.debug(\n        `Loading configuration file \"${file}\" as CommonJS based on extension`\n      )\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\n      definitions = require(filePath)\n      break\n    case '.mjs':\n      logger.debug(\n        `Loading configuration file \"${file}\" as ESM based on extension`\n      )\n      definitions = await import(pathToFileURL(filePath).toString())\n      break\n    case '.js':\n      {\n        const parentPackage = await readPackageJson(filePath)\n        if (!parentPackage) {\n          logger.debug(\n            `Loading configuration file \"${file}\" as CommonJS based on absence of a parent package`\n          )\n          // eslint-disable-next-line @typescript-eslint/no-var-requires\n          definitions = require(filePath)\n        } else if (parentPackage.type === 'module') {\n          logger.debug(\n            `Loading configuration file \"${file}\" as ESM based on \"${parentPackage.name}\" package type`\n          )\n          definitions = await import(pathToFileURL(filePath).toString())\n        } else {\n          logger.debug(\n            `Loading configuration file \"${file}\" as CommonJS based on \"${parentPackage.name}\" package type`\n          )\n          // eslint-disable-next-line @typescript-eslint/no-var-requires\n          definitions = require(filePath)\n        }\n      }\n      break\n    default:\n      throw new Error(`Unsupported configuration file extension \"${extension}\"`)\n  }\n  if (typeof definitions !== 'object') {\n    throw new Error(`Configuration file ${filePath} does not export an object`)\n  }\n  return definitions\n}\n\nasync function readPackageJson(filePath: string) {\n  const parentPackage = await readPkgUp({ cwd: path.dirname(filePath) })\n  return parentPackage?.packageJson\n}\n\nfunction extractConfiguration(\n  logger: ILogger,\n  name: string,\n  definition: any\n): Partial<IConfiguration> {\n  if (typeof definition === 'string') {\n    logger.debug(`Profile \"${name}\" value is a string; parsing as argv`)\n    const { configuration } = ArgvParser.parse([\n      'node',\n      'cucumber-js',\n      ...stringArgv(definition),\n    ])\n    return configuration\n  }\n  try {\n    return checkSchema(definition)\n  } catch (error) {\n    throw new Error(\n      `Requested profile \"${name}\" failed schema validation: ${error.errors.join(\n        ' '\n      )}`\n    )\n  }\n}\n"]}
+{"version":3,"file":"from_file.js","sourceRoot":"","sources":["../../src/configuration/from_file.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAwB;AACxB,0DAA4B;AAC5B,yCAAqC;AACrC,uCAAwC;AACxC,gDAAuB;AACvB,8DAAmC;AAGnC,iEAA4D;AAC5D,+DAA0D;AAEnD,KAAK,UAAU,QAAQ,CAC5B,MAAe,EACf,GAAW,EACX,IAAY,EACZ,WAAqB,EAAE;IAEvB,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;IACrD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;QACxB,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,WAAW,CAAC,OAAO,GAAG,EAAE,CAAA;KACzB;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;KACvB;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC5C,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,sBAAsB,UAAU,iBAAiB,CAAC,CAAA;SACnE;IACH,CAAC,CAAC,CAAA;IACF,OAAO,IAAA,0CAAmB,EACxB,EAAE,EACF,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC7B,IAAA,wCAAkB,EAChB,MAAM,EACN,YAAY,UAAU,GAAG,EACzB,WAAW,CAAC,UAAU,CAAC,CACxB,CACF,CACF,CAAA;AACH,CAAC;AA/BD,4BA+BC;AAED,KAAK,UAAU,QAAQ,CACrB,MAAe,EACf,GAAW,EACX,IAAY;IAEZ,MAAM,QAAQ,GAAW,mBAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC7C,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACxC,IAAI,WAAW,CAAA;IACf,QAAQ,SAAS,EAAE;QACjB,KAAK,OAAO;YACV,WAAW,GAAG,IAAI,CAAC,KAAK,CACtB,MAAM,IAAA,qBAAS,EAAC,iBAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC9D,CAAA;YACD,MAAK;QACP,KAAK,OAAO,CAAC;QACb,KAAK,MAAM;YACT,WAAW,GAAG,cAAI,CAAC,KAAK,CACtB,MAAM,IAAA,qBAAS,EAAC,iBAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC9D,CAAA;YACD,MAAK;QACP,KAAK,MAAM;YACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,kCAAkC,CACtE,CAAA;YACD,8DAA8D;YAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC/B,MAAK;QACP,KAAK,MAAM;YACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,6BAA6B,CACjE,CAAA;YACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC9D,MAAK;QACP,KAAK,KAAK;YACR;gBACE,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAA;gBACrD,IAAI,CAAC,aAAa,EAAE;oBAClB,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oDAAoD,CACxF,CAAA;oBACD,8DAA8D;oBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;iBAChC;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;oBAC1C,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,sBAAsB,aAAa,CAAC,IAAI,gBAAgB,CAC5F,CAAA;oBACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;iBAC/D;qBAAM;oBACL,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,2BAA2B,aAAa,CAAC,IAAI,gBAAgB,CACjG,CAAA;oBACD,8DAA8D;oBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;iBAChC;aACF;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,GAAG,CAAC,CAAA;KAC7E;IACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,4BAA4B,CAAC,CAAA;KAC5E;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,QAAgB;IAC7C,MAAM,aAAa,GAAG,MAAM,IAAA,qBAAS,EAAC,EAAE,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IACtE,OAAO,aAAa,EAAE,WAAW,CAAA;AACnC,CAAC","sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\nimport { promisify } from 'node:util'\nimport { pathToFileURL } from 'node:url'\nimport YAML from 'yaml'\nimport readPkgUp from 'read-pkg-up'\nimport { ILogger } from '../logger'\nimport { IConfiguration } from './types'\nimport { mergeConfigurations } from './merge_configurations'\nimport { parseConfiguration } from './parse_configuration'\n\nexport async function fromFile(\n  logger: ILogger,\n  cwd: string,\n  file: string,\n  profiles: string[] = []\n): Promise<Partial<IConfiguration>> {\n  const definitions = await loadFile(logger, cwd, file)\n  if (!definitions.default) {\n    logger.debug('No default profile defined in configuration file')\n    definitions.default = {}\n  }\n  if (profiles.length < 1) {\n    logger.debug('No profiles specified; using default profile')\n    profiles = ['default']\n  }\n  const definedKeys = Object.keys(definitions)\n  profiles.forEach((profileKey) => {\n    if (!definedKeys.includes(profileKey)) {\n      throw new Error(`Requested profile \"${profileKey}\" doesn't exist`)\n    }\n  })\n  return mergeConfigurations(\n    {},\n    ...profiles.map((profileKey) =>\n      parseConfiguration(\n        logger,\n        `Profile \"${profileKey}\"`,\n        definitions[profileKey]\n      )\n    )\n  )\n}\n\nasync function loadFile(\n  logger: ILogger,\n  cwd: string,\n  file: string\n): Promise<Record<string, any>> {\n  const filePath: string = path.join(cwd, file)\n  const extension = path.extname(filePath)\n  let definitions\n  switch (extension) {\n    case '.json':\n      definitions = JSON.parse(\n        await promisify(fs.readFile)(filePath, { encoding: 'utf-8' })\n      )\n      break\n    case '.yaml':\n    case '.yml':\n      definitions = YAML.parse(\n        await promisify(fs.readFile)(filePath, { encoding: 'utf-8' })\n      )\n      break\n    case '.cjs':\n      logger.debug(\n        `Loading configuration file \"${file}\" as CommonJS based on extension`\n      )\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\n      definitions = require(filePath)\n      break\n    case '.mjs':\n      logger.debug(\n        `Loading configuration file \"${file}\" as ESM based on extension`\n      )\n      definitions = await import(pathToFileURL(filePath).toString())\n      break\n    case '.js':\n      {\n        const parentPackage = await readPackageJson(filePath)\n        if (!parentPackage) {\n          logger.debug(\n            `Loading configuration file \"${file}\" as CommonJS based on absence of a parent package`\n          )\n          // eslint-disable-next-line @typescript-eslint/no-var-requires\n          definitions = require(filePath)\n        } else if (parentPackage.type === 'module') {\n          logger.debug(\n            `Loading configuration file \"${file}\" as ESM based on \"${parentPackage.name}\" package type`\n          )\n          definitions = await import(pathToFileURL(filePath).toString())\n        } else {\n          logger.debug(\n            `Loading configuration file \"${file}\" as CommonJS based on \"${parentPackage.name}\" package type`\n          )\n          // eslint-disable-next-line @typescript-eslint/no-var-requires\n          definitions = require(filePath)\n        }\n      }\n      break\n    default:\n      throw new Error(`Unsupported configuration file extension \"${extension}\"`)\n  }\n  if (typeof definitions !== 'object') {\n    throw new Error(`Configuration file ${filePath} does not export an object`)\n  }\n  return definitions\n}\n\nasync function readPackageJson(filePath: string) {\n  const parentPackage = await readPkgUp({ cwd: path.dirname(filePath) })\n  return parentPackage?.packageJson\n}\n"]}

package/lib/configuration/index.d.ts

@@ -3,5 +3,7 @@ export * from './default_configuration';
 export * from './from_file';
 export * from './helpers';
 export * from './merge_configurations';
+export * from './parse_configuration';
 export * from './split_format_descriptor';
 export * from './types';
+export * from './validate_configuration';

package/lib/configuration/index.js

@@ -24,6 +24,8 @@ __exportStar(require("./default_configuration"), exports);
 __exportStar(require("./from_file"), exports);
 __exportStar(require("./helpers"), exports);
 __exportStar(require("./merge_configurations"), exports);
+__exportStar(require("./parse_configuration"), exports);
 __exportStar(require("./split_format_descriptor"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./validate_configuration"), exports);
 //# sourceMappingURL=index.js.map

package/lib/configuration/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,6CAAqD;AAA5C,0HAAA,OAAO,OAAc;AAC9B,0DAAuC;AACvC,8CAA2B;AAC3B,4CAAyB;AACzB,yDAAsC;AACtC,4DAAyC;AACzC,0CAAuB","sourcesContent":["export { default as ArgvParser } from './argv_parser'\nexport * from './default_configuration'\nexport * from './from_file'\nexport * from './helpers'\nexport * from './merge_configurations'\nexport * from './split_format_descriptor'\nexport * from './types'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,6CAAqD;AAA5C,0HAAA,OAAO,OAAc;AAC9B,0DAAuC;AACvC,8CAA2B;AAC3B,4CAAyB;AACzB,yDAAsC;AACtC,wDAAqC;AACrC,4DAAyC;AACzC,0CAAuB;AACvB,2DAAwC","sourcesContent":["export { default as ArgvParser } from './argv_parser'\nexport * from './default_configuration'\nexport * from './from_file'\nexport * from './helpers'\nexport * from './merge_configurations'\nexport * from './parse_configuration'\nexport * from './split_format_descriptor'\nexport * from './types'\nexport * from './validate_configuration'\n"]}

package/lib/configuration/parse_configuration.d.ts

@@ -0,0 +1,3 @@
+import { ILogger } from '../logger';
+import { IConfiguration } from './types';
+export declare function parseConfiguration(logger: ILogger, source: string, definition: Partial<IConfiguration> | string | undefined): Partial<IConfiguration>;

package/lib/configuration/parse_configuration.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseConfiguration = void 0;
+const string_argv_1 = __importDefault(require("string-argv"));
+const argv_parser_1 = __importDefault(require("./argv_parser"));
+const check_schema_1 = require("./check_schema");
+function parseConfiguration(logger, source, definition) {
+    if (!definition) {
+        return {};
+    }
+    if (typeof definition === 'string') {
+        logger.debug(`${source} configuration value is a string; parsing as argv`);
+        const { configuration } = argv_parser_1.default.parse([
+            'node',
+            'cucumber-js',
+            ...(0, string_argv_1.default)(definition),
+        ]);
+        return configuration;
+    }
+    try {
+        return (0, check_schema_1.checkSchema)(definition);
+    }
+    catch (error) {
+        throw new Error(`${source} configuration value failed schema validation: ${error.errors.join(' ')}`);
+    }
+}
+exports.parseConfiguration = parseConfiguration;
+//# sourceMappingURL=parse_configuration.js.map

package/lib/configuration/parse_configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse_configuration.js","sourceRoot":"","sources":["../../src/configuration/parse_configuration.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAoC;AAGpC,gEAAsC;AACtC,iDAA4C;AAE5C,SAAgB,kBAAkB,CAChC,MAAe,EACf,MAAc,EACd,UAAwD;IAExD,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,EAAE,CAAA;KACV;IACD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,mDAAmD,CAAC,CAAA;QAC1E,MAAM,EAAE,aAAa,EAAE,GAAG,qBAAU,CAAC,KAAK,CAAC;YACzC,MAAM;YACN,aAAa;YACb,GAAG,IAAA,qBAAU,EAAC,UAAU,CAAC;SAC1B,CAAC,CAAA;QACF,OAAO,aAAa,CAAA;KACrB;IACD,IAAI;QACF,OAAO,IAAA,0BAAW,EAAC,UAAU,CAAC,CAAA;KAC/B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,kDAAkD,KAAK,CAAC,MAAM,CAAC,IAAI,CAC1E,GAAG,CACJ,EAAE,CACJ,CAAA;KACF;AACH,CAAC;AA1BD,gDA0BC","sourcesContent":["import stringArgv from 'string-argv'\nimport { ILogger } from '../logger'\nimport { IConfiguration } from './types'\nimport ArgvParser from './argv_parser'\nimport { checkSchema } from './check_schema'\n\nexport function parseConfiguration(\n  logger: ILogger,\n  source: string,\n  definition: Partial<IConfiguration> | string | undefined\n): Partial<IConfiguration> {\n  if (!definition) {\n    return {}\n  }\n  if (typeof definition === 'string') {\n    logger.debug(`${source} configuration value is a string; parsing as argv`)\n    const { configuration } = ArgvParser.parse([\n      'node',\n      'cucumber-js',\n      ...stringArgv(definition),\n    ])\n    return configuration\n  }\n  try {\n    return checkSchema(definition)\n  } catch (error) {\n    throw new Error(\n      `${source} configuration value failed schema validation: ${error.errors.join(\n        ' '\n      )}`\n    )\n  }\n}\n"]}

package/lib/runtime/format_error.js

@@ -8,20 +8,22 @@ const assertion_error_formatter_1 = require("assertion-error-formatter");
 const error_stack_parser_1 = __importDefault(require("error-stack-parser"));
 const filter_stack_trace_1 = require("../filter_stack_trace");
 function formatError(error, filterStackTraces) {
-    let filteredStack;
-    if (filterStackTraces) {
-        try {
-            filteredStack = (0, filter_stack_trace_1.filterStackTrace)(error_stack_parser_1.default.parse(error))
-                .map((f) => f.source)
-                .join('\n');
-        }
-        catch {
-            // if we weren't able to parse and filter, we'll settle for the original
-        }
+    let processedStackTrace;
+    try {
+        const parsedStack = error_stack_parser_1.default.parse(error);
+        const filteredStack = filterStackTraces
+            ? (0, filter_stack_trace_1.filterStackTrace)(parsedStack)
+            : parsedStack;
+        processedStackTrace = filteredStack.map((f) => f.source).join('\n');
+    }
+    catch {
+        // if we weren't able to parse and process, we'll settle for the original
     }
     const message = (0, assertion_error_formatter_1.format)(error, {
         colorFns: {
-            errorStack: (stack) => filteredStack ? `\n${filteredStack}` : stack,
+            errorStack: (stack) => {
+                return processedStackTrace ? `\n${processedStackTrace}` : stack;
+            },
         },
     });
     return {
@@ -29,6 +31,7 @@ function formatError(error, filterStackTraces) {
         exception: {
             type: error.name || 'Error',
             message: typeof error === 'string' ? error : error.message,
+            stackTrace: processedStackTrace ?? error.stack,
         },
     };
 }

package/lib/runtime/format_error.js.map

@@ -1 +1 @@
-{"version":3,"file":"format_error.js","sourceRoot":"","sources":["../../src/runtime/format_error.ts"],"names":[],"mappings":";;;;;;AACA,yEAAkD;AAClD,4EAAiD;AACjD,8DAAwD;AAExD,SAAgB,WAAW,CACzB,KAAY,EACZ,iBAA0B;IAE1B,IAAI,aAAqB,CAAA;IACzB,IAAI,iBAAiB,EAAE;QACrB,IAAI;YACF,aAAa,GAAG,IAAA,qCAAgB,EAAC,4BAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAC5D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;iBACpB,IAAI,CAAC,IAAI,CAAC,CAAA;SACd;QAAC,MAAM;YACN,wEAAwE;SACzE;KACF;IACD,MAAM,OAAO,GAAG,IAAA,kCAAM,EAAC,KAAK,EAAE;QAC5B,QAAQ,EAAE;YACR,UAAU,EAAE,CAAC,KAAa,EAAE,EAAE,CAC5B,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,EAAE,CAAC,CAAC,CAAC,KAAK;SAC/C;KACF,CAAC,CAAA;IACF,OAAO;QACL,OAAO;QACP,SAAS,EAAE;YACT,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,OAAO;YAC3B,OAAO,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;SAC3D;KACF,CAAA;AACH,CAAC;AA3BD,kCA2BC","sourcesContent":["import { TestStepResult } from '@cucumber/messages'\nimport { format } from 'assertion-error-formatter'\nimport errorStackParser from 'error-stack-parser'\nimport { filterStackTrace } from '../filter_stack_trace'\n\nexport function formatError(\n  error: Error,\n  filterStackTraces: boolean\n): Pick<TestStepResult, 'message' | 'exception'> {\n  let filteredStack: string\n  if (filterStackTraces) {\n    try {\n      filteredStack = filterStackTrace(errorStackParser.parse(error))\n        .map((f) => f.source)\n        .join('\\n')\n    } catch {\n      // if we weren't able to parse and filter, we'll settle for the original\n    }\n  }\n  const message = format(error, {\n    colorFns: {\n      errorStack: (stack: string) =>\n        filteredStack ? `\\n${filteredStack}` : stack,\n    },\n  })\n  return {\n    message,\n    exception: {\n      type: error.name || 'Error',\n      message: typeof error === 'string' ? error : error.message,\n    },\n  }\n}\n"]}
+{"version":3,"file":"format_error.js","sourceRoot":"","sources":["../../src/runtime/format_error.ts"],"names":[],"mappings":";;;;;;AACA,yEAAkD;AAClD,4EAAiD;AACjD,8DAAwD;AAExD,SAAgB,WAAW,CACzB,KAAY,EACZ,iBAA0B;IAE1B,IAAI,mBAA2B,CAAA;IAC/B,IAAI;QACF,MAAM,WAAW,GAAG,4BAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACjD,MAAM,aAAa,GAAG,iBAAiB;YACrC,CAAC,CAAC,IAAA,qCAAgB,EAAC,WAAW,CAAC;YAC/B,CAAC,CAAC,WAAW,CAAA;QACf,mBAAmB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;KACpE;IAAC,MAAM;QACN,yEAAyE;KAC1E;IACD,MAAM,OAAO,GAAG,IAAA,kCAAM,EAAC,KAAK,EAAE;QAC5B,QAAQ,EAAE;YACR,UAAU,EAAE,CAAC,KAAa,EAAE,EAAE;gBAC5B,OAAO,mBAAmB,CAAC,CAAC,CAAC,KAAK,mBAAmB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACjE,CAAC;SACF;KACF,CAAC,CAAA;IACF,OAAO;QACL,OAAO;QACP,SAAS,EAAE;YACT,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,OAAO;YAC3B,OAAO,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;YAC1D,UAAU,EAAE,mBAAmB,IAAI,KAAK,CAAC,KAAK;SAC/C;KACF,CAAA;AACH,CAAC;AA7BD,kCA6BC","sourcesContent":["import { TestStepResult } from '@cucumber/messages'\nimport { format } from 'assertion-error-formatter'\nimport errorStackParser from 'error-stack-parser'\nimport { filterStackTrace } from '../filter_stack_trace'\n\nexport function formatError(\n  error: Error,\n  filterStackTraces: boolean\n): Pick<TestStepResult, 'message' | 'exception'> {\n  let processedStackTrace: string\n  try {\n    const parsedStack = errorStackParser.parse(error)\n    const filteredStack = filterStackTraces\n      ? filterStackTrace(parsedStack)\n      : parsedStack\n    processedStackTrace = filteredStack.map((f) => f.source).join('\\n')\n  } catch {\n    // if we weren't able to parse and process, we'll settle for the original\n  }\n  const message = format(error, {\n    colorFns: {\n      errorStack: (stack: string) => {\n        return processedStackTrace ? `\\n${processedStackTrace}` : stack\n      },\n    },\n  })\n  return {\n    message,\n    exception: {\n      type: error.name || 'Error',\n      message: typeof error === 'string' ? error : error.message,\n      stackTrace: processedStackTrace ?? error.stack,\n    },\n  }\n}\n"]}

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const version = "10.2.1";
+export declare const version = "10.3.0";

package/lib/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // Generated by genversion.
-exports.version = '10.2.1';
+exports.version = '10.3.0';
 //# sourceMappingURL=version.js.map

package/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AACd,QAAA,OAAO,GAAG,QAAQ,CAAA","sourcesContent":["// Generated by genversion.\nexport const version = '10.2.1'\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AACd,QAAA,OAAO,GAAG,QAAQ,CAAA","sourcesContent":["// Generated by genversion.\nexport const version = '10.3.0'\n"]}

package/package.json

@@ -8,7 +8,7 @@
     "gherkin",
     "tests"
   ],
-  "version": "10.2.1",
+  "version": "10.3.0",
   "homepage": "https://github.com/cucumber/cucumber-js",
   "author": "Julien Biezemans <jb@jbpros.com>",
   "contributors": [
@@ -216,7 +216,7 @@
     "@cucumber/html-formatter": "21.2.0",
     "@cucumber/message-streams": "4.0.1",
     "@cucumber/messages": "24.0.1",
-    "@cucumber/tag-expressions": "6.0.0",
+    "@cucumber/tag-expressions": "6.1.0",
     "assertion-error-formatter": "^3.0.0",
     "capital-case": "^1.0.4",
     "chalk": "^4.1.2",
@@ -251,7 +251,7 @@
     "yup": "1.2.0"
   },
   "devDependencies": {
-    "@cucumber/compatibility-kit": "14.1.0",
+    "@cucumber/compatibility-kit": "15.0.0",
     "@cucumber/query": "12.0.1",
     "@microsoft/api-extractor": "7.39.0",
     "@sinonjs/fake-timers": "10.0.2",