@cucumber/cucumber 12.2.0 → 12.4.0

package/README.md

@@ -9,7 +9,7 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@cucumber/cucumber" style="text-decoration: none"><img src="https://img.shields.io/npm/v/@cucumber/cucumber?style=flat&color=dark-green" alt="Latest version on npm"></a>
-  <a href="https://github.com/cucumber/cucumber-js/actions" style="text-decoration: none"><img src="https://github.com/cucumber/cucumber-js/actions/workflows/build.yaml/badge.svg" alt="Build status"></a>
+  <a href="https://github.com/cucumber/cucumber-js/actions" style="text-decoration: none"><img src="https://github.com/cucumber/cucumber-js/actions/workflows/build.yml/badge.svg" alt="Build status"></a>
   <a href="https://coveralls.io/github/cucumber/cucumber-js?branch=master" style="text-decoration: none"><img src="https://coveralls.io/repos/github/cucumber/cucumber-js/badge.svg?branch=main" alt="Coverage"></a>
   <a href="https://opencollective.com/cucumber"><img src="https://opencollective.com/cucumber/backers/badge.svg" alt="Backers"></a>
   <a href="https://opencollective.com/cucumber"><img src="https://opencollective.com/cucumber/sponsors/badge.svg" alt="Sponsors"></a>

package/lib/api/run_cucumber.js

@@ -114,6 +114,7 @@ Running from: ${__dirname}
         newId,
         supportCodeLibrary,
         options: options.runtime,
+        snippetOptions: options.formats.options,
     });
     const success = await runtime.run();
     await pluginManager.cleanup();

package/lib/api/run_cucumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"run_cucumber.js","sourceRoot":"","sources":["../../src/api/run_cucumber.ts"],"names":[],"mappings":";;AAwBA,kCA4IC;AApKD,6CAA0C;AAC1C,iDAAsE;AACtE,kDAAyD;AACzD,4CAAyE;AACzE,oCAAuC;AAEvC,wCAAoC;AAEpC,wCAAwC;AACxC,gDAAiE;AAEjE,6CAAmD;AACnD,uCAAiD;AACjD,uCAA+C;AAC/C,uCAAoD;AAEpD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAoB,EACpB,cAA+B,EAAE,EACjC,SAAuC;IAEvC,MAAM,iBAAiB,GAAG,IAAA,6BAAe,EAAC,WAAW,CAAC,CAAA;IACtD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAA;IAE9D,MAAM,CAAC,KAAK,CAAC,uBAAuB,iBAAO;qBACxB,GAAG;gBACR,SAAS;CACxB,CAAC,CAAA;IAEA,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;IAEhC,MAAM,kBAAkB,GACtB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACtC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB;QACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CACX;YACE,cAAc,EAAE,EAAE;YAClB,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;SAChB,EACD,OAAO,CAAC,OAAO,CAChB,CAAA;IAEP,MAAM,aAAa,GAAG,MAAM,IAAA,kCAAwB,EAClD;QACE,GAAG,OAAO;QACV,OAAO,EAAE,kBAAkB;KAC5B,EACD,iBAAiB,CAClB,CAAA;IAED,MAAM,aAAa,GAAG,MAAM,IAAA,oBAAY,EACtC,MAAM,EACN,GAAG,EACH,OAAO,CAAC,OAAO,EACf,kBAAkB,CACnB,CAAA;IACD,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;IAClD,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,aAAa,CAAA;IAEhE,MAAM,kBAAkB,GACtB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACtC,CAAC,CAAE,OAAO,CAAC,OAA8B;QACzC,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC;YAC1B,MAAM;YACN,GAAG;YACH,KAAK;YACL,YAAY;YACZ,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,WAAW;YACX,OAAO,EAAE,kBAAkB,CAAC,OAAO;SACpC,CAAC,CAAA;IAER,MAAM,gBAAgB,GAAG,IAAI,0BAAY,EAAE,CAAA;IAC3C,IAAI,SAAS,EAAE,CAAC;QACd,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;IAC5C,CAAC;IACD,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CACxC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CACrC,CAAA;IACD,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,gBAAgB,CAAC,CAAA;IAEnE,IAAI,oBAAoB,GAAG,KAAK,CAAA;IAChC,MAAM,iBAAiB,GAAG,MAAM,IAAA,iCAAoB,EAAC;QACnD,GAAG;QACH,GAAG;QACH,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAClD,gBAAgB;QAChB,kBAAkB;QAClB,aAAa,EAAE,OAAO,CAAC,OAAO;QAC9B,kBAAkB;QAClB,aAAa;KACd,CAAC,CAAA;IACF,MAAM,IAAA,yBAAe,EAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;IAE5C,IAAI,eAAe,GAAqC,EAAE,CAAA;IAC1D,IAAI,WAAW,GAAiB,EAAE,CAAA;IAClC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAmB,EAAC;YAC9C,KAAK;YACL,GAAG;YACH,WAAW;YACX,WAAW,EAAE,OAAO,CAAC,OAAO;YAC5B,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;SACtE,CAAC,CAAA;QACF,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAC7C,gBAAgB,EAChB,aAAa,CAAC,iBAAiB,CAChC,CAAA;QACD,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAC7C,eAAe,EACf,eAAe,CAChB,CAAA;QACD,WAAW,GAAG,aAAa,CAAC,WAAW,CAAA;IACzC,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACjC,MAAM,CAAC,KAAK,CACV,mBAAmB,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAClE,CAAA;QACH,CAAC,CAAC,CAAA;QACF,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,aAAa,CAAC,OAAO,EAAE,CAAA;QAC7B,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kBAAkB;SAC5B,CAAA;IACH,CAAC;IAED,IAAA,iCAAuB,EAAC;QACtB,gBAAgB;QAChB,kBAAkB;QAClB,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,MAAM,IAAA,qBAAW,EAAC;QAChC,WAAW;QACX,MAAM;QACN,gBAAgB;QAChB,cAAc,EAAE,eAAe;QAC/B,KAAK;QACL,kBAAkB;QAClB,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAA;IACnC,MAAM,aAAa,CAAC,OAAO,EAAE,CAAA;IAC7B,MAAM,iBAAiB,EAAE,CAAA;IAEzB,OAAO;QACL,OAAO,EAAE,OAAO,IAAI,CAAC,oBAAoB;QACzC,OAAO,EAAE,kBAAkB;KAC5B,CAAA;AACH,CAAC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport { Envelope, IdGenerator, ParseError } from '@cucumber/messages'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { emitMetaMessage, emitSupportCodeMessages } from '../cli/helpers'\nimport { resolvePaths } from '../paths'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { version } from '../version'\nimport { IFilterablePickle } from '../filter'\nimport { makeRuntime } from '../runtime'\nimport { IRunEnvironment, makeEnvironment } from '../environment'\nimport { IRunOptions, IRunResult } from './types'\nimport { initializeFormatters } from './formatters'\nimport { getSupportCodeLibrary } from './support'\nimport { getPicklesAndErrors } from './gherkin'\nimport { initializeForRunCucumber } from './plugins'\n\n/**\n * Execute a Cucumber test run and return the overall result\n *\n * @public\n * @param options - Options for the run, obtainable via {@link loadConfiguration}\n * @param environment - Project environment\n * @param onMessage - Callback fired each time Cucumber emits a message\n */\nexport async function runCucumber(\n  options: IRunOptions,\n  environment: IRunEnvironment = {},\n  onMessage?: (message: Envelope) => void\n): Promise<IRunResult> {\n  const mergedEnvironment = makeEnvironment(environment)\n  const { cwd, stdout, stderr, env, logger } = mergedEnvironment\n\n  logger.debug(`Running cucumber-js ${version} \nWorking directory: ${cwd}\nRunning from: ${__dirname}  \n`)\n\n  const newId = IdGenerator.uuid()\n\n  const supportCoordinates =\n    'originalCoordinates' in options.support\n      ? options.support.originalCoordinates\n      : Object.assign(\n          {\n            requireModules: [],\n            requirePaths: [],\n            loaders: [],\n            importPaths: [],\n          },\n          options.support\n        )\n\n  const pluginManager = await initializeForRunCucumber(\n    {\n      ...options,\n      support: supportCoordinates,\n    },\n    mergedEnvironment\n  )\n\n  const resolvedPaths = await resolvePaths(\n    logger,\n    cwd,\n    options.sources,\n    supportCoordinates\n  )\n  pluginManager.emit('paths:resolve', resolvedPaths)\n  const { sourcePaths, requirePaths, importPaths } = resolvedPaths\n\n  const supportCodeLibrary =\n    'originalCoordinates' in options.support\n      ? (options.support as SupportCodeLibrary)\n      : await getSupportCodeLibrary({\n          logger,\n          cwd,\n          newId,\n          requirePaths,\n          requireModules: supportCoordinates.requireModules,\n          importPaths,\n          loaders: supportCoordinates.loaders,\n        })\n\n  const eventBroadcaster = new EventEmitter()\n  if (onMessage) {\n    eventBroadcaster.on('envelope', onMessage)\n  }\n  eventBroadcaster.on('envelope', (value) =>\n    pluginManager.emit('message', value)\n  )\n  const eventDataCollector = new EventDataCollector(eventBroadcaster)\n\n  let formatterStreamError = false\n  const cleanupFormatters = await initializeFormatters({\n    env,\n    cwd,\n    stdout,\n    stderr,\n    logger,\n    onStreamError: () => (formatterStreamError = true),\n    eventBroadcaster,\n    eventDataCollector,\n    configuration: options.formats,\n    supportCodeLibrary,\n    pluginManager,\n  })\n  await emitMetaMessage(eventBroadcaster, env)\n\n  let filteredPickles: ReadonlyArray<IFilterablePickle> = []\n  let parseErrors: ParseError[] = []\n  if (sourcePaths.length > 0) {\n    const gherkinResult = await getPicklesAndErrors({\n      newId,\n      cwd,\n      sourcePaths,\n      coordinates: options.sources,\n      onEnvelope: (envelope) => eventBroadcaster.emit('envelope', envelope),\n    })\n    filteredPickles = await pluginManager.transform(\n      'pickles:filter',\n      gherkinResult.filterablePickles\n    )\n    filteredPickles = await pluginManager.transform(\n      'pickles:order',\n      filteredPickles\n    )\n    parseErrors = gherkinResult.parseErrors\n  }\n  if (parseErrors.length) {\n    parseErrors.forEach((parseError) => {\n      logger.error(\n        `Parse error in \"${parseError.source.uri}\" ${parseError.message}`\n      )\n    })\n    await cleanupFormatters()\n    await pluginManager.cleanup()\n    return {\n      success: false,\n      support: supportCodeLibrary,\n    }\n  }\n\n  emitSupportCodeMessages({\n    eventBroadcaster,\n    supportCodeLibrary,\n    newId,\n  })\n\n  const runtime = await makeRuntime({\n    environment,\n    logger,\n    eventBroadcaster,\n    sourcedPickles: filteredPickles,\n    newId,\n    supportCodeLibrary,\n    options: options.runtime,\n  })\n  const success = await runtime.run()\n  await pluginManager.cleanup()\n  await cleanupFormatters()\n\n  return {\n    success: success && !formatterStreamError,\n    support: supportCodeLibrary,\n  }\n}\n"]}
+{"version":3,"file":"run_cucumber.js","sourceRoot":"","sources":["../../src/api/run_cucumber.ts"],"names":[],"mappings":";;AAwBA,kCA6IC;AArKD,6CAA0C;AAC1C,iDAAsE;AACtE,kDAAyD;AACzD,4CAAyE;AACzE,oCAAuC;AAEvC,wCAAoC;AAEpC,wCAAwC;AACxC,gDAAiE;AAEjE,6CAAmD;AACnD,uCAAiD;AACjD,uCAA+C;AAC/C,uCAAoD;AAEpD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAoB,EACpB,cAA+B,EAAE,EACjC,SAAuC;IAEvC,MAAM,iBAAiB,GAAG,IAAA,6BAAe,EAAC,WAAW,CAAC,CAAA;IACtD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAA;IAE9D,MAAM,CAAC,KAAK,CAAC,uBAAuB,iBAAO;qBACxB,GAAG;gBACR,SAAS;CACxB,CAAC,CAAA;IAEA,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;IAEhC,MAAM,kBAAkB,GACtB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACtC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB;QACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CACX;YACE,cAAc,EAAE,EAAE;YAClB,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;SAChB,EACD,OAAO,CAAC,OAAO,CAChB,CAAA;IAEP,MAAM,aAAa,GAAG,MAAM,IAAA,kCAAwB,EAClD;QACE,GAAG,OAAO;QACV,OAAO,EAAE,kBAAkB;KAC5B,EACD,iBAAiB,CAClB,CAAA;IAED,MAAM,aAAa,GAAG,MAAM,IAAA,oBAAY,EACtC,MAAM,EACN,GAAG,EACH,OAAO,CAAC,OAAO,EACf,kBAAkB,CACnB,CAAA;IACD,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;IAClD,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,aAAa,CAAA;IAEhE,MAAM,kBAAkB,GACtB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACtC,CAAC,CAAE,OAAO,CAAC,OAA8B;QACzC,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC;YAC1B,MAAM;YACN,GAAG;YACH,KAAK;YACL,YAAY;YACZ,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,WAAW;YACX,OAAO,EAAE,kBAAkB,CAAC,OAAO;SACpC,CAAC,CAAA;IAER,MAAM,gBAAgB,GAAG,IAAI,0BAAY,EAAE,CAAA;IAC3C,IAAI,SAAS,EAAE,CAAC;QACd,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;IAC5C,CAAC;IACD,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CACxC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CACrC,CAAA;IACD,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,gBAAgB,CAAC,CAAA;IAEnE,IAAI,oBAAoB,GAAG,KAAK,CAAA;IAChC,MAAM,iBAAiB,GAAG,MAAM,IAAA,iCAAoB,EAAC;QACnD,GAAG;QACH,GAAG;QACH,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAClD,gBAAgB;QAChB,kBAAkB;QAClB,aAAa,EAAE,OAAO,CAAC,OAAO;QAC9B,kBAAkB;QAClB,aAAa;KACd,CAAC,CAAA;IACF,MAAM,IAAA,yBAAe,EAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;IAE5C,IAAI,eAAe,GAAqC,EAAE,CAAA;IAC1D,IAAI,WAAW,GAAiB,EAAE,CAAA;IAClC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAmB,EAAC;YAC9C,KAAK;YACL,GAAG;YACH,WAAW;YACX,WAAW,EAAE,OAAO,CAAC,OAAO;YAC5B,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;SACtE,CAAC,CAAA;QACF,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAC7C,gBAAgB,EAChB,aAAa,CAAC,iBAAiB,CAChC,CAAA;QACD,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAC7C,eAAe,EACf,eAAe,CAChB,CAAA;QACD,WAAW,GAAG,aAAa,CAAC,WAAW,CAAA;IACzC,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACjC,MAAM,CAAC,KAAK,CACV,mBAAmB,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAClE,CAAA;QACH,CAAC,CAAC,CAAA;QACF,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,aAAa,CAAC,OAAO,EAAE,CAAA;QAC7B,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kBAAkB;SAC5B,CAAA;IACH,CAAC;IAED,IAAA,iCAAuB,EAAC;QACtB,gBAAgB;QAChB,kBAAkB;QAClB,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,MAAM,IAAA,qBAAW,EAAC;QAChC,WAAW;QACX,MAAM;QACN,gBAAgB;QAChB,cAAc,EAAE,eAAe;QAC/B,KAAK;QACL,kBAAkB;QAClB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;KACxC,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAA;IACnC,MAAM,aAAa,CAAC,OAAO,EAAE,CAAA;IAC7B,MAAM,iBAAiB,EAAE,CAAA;IAEzB,OAAO;QACL,OAAO,EAAE,OAAO,IAAI,CAAC,oBAAoB;QACzC,OAAO,EAAE,kBAAkB;KAC5B,CAAA;AACH,CAAC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport { Envelope, IdGenerator, ParseError } from '@cucumber/messages'\nimport { EventDataCollector } from '../formatter/helpers'\nimport { emitMetaMessage, emitSupportCodeMessages } from '../cli/helpers'\nimport { resolvePaths } from '../paths'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { version } from '../version'\nimport { IFilterablePickle } from '../filter'\nimport { makeRuntime } from '../runtime'\nimport { IRunEnvironment, makeEnvironment } from '../environment'\nimport { IRunOptions, IRunResult } from './types'\nimport { initializeFormatters } from './formatters'\nimport { getSupportCodeLibrary } from './support'\nimport { getPicklesAndErrors } from './gherkin'\nimport { initializeForRunCucumber } from './plugins'\n\n/**\n * Execute a Cucumber test run and return the overall result\n *\n * @public\n * @param options - Options for the run, obtainable via {@link loadConfiguration}\n * @param environment - Project environment\n * @param onMessage - Callback fired each time Cucumber emits a message\n */\nexport async function runCucumber(\n  options: IRunOptions,\n  environment: IRunEnvironment = {},\n  onMessage?: (message: Envelope) => void\n): Promise<IRunResult> {\n  const mergedEnvironment = makeEnvironment(environment)\n  const { cwd, stdout, stderr, env, logger } = mergedEnvironment\n\n  logger.debug(`Running cucumber-js ${version} \nWorking directory: ${cwd}\nRunning from: ${__dirname}  \n`)\n\n  const newId = IdGenerator.uuid()\n\n  const supportCoordinates =\n    'originalCoordinates' in options.support\n      ? options.support.originalCoordinates\n      : Object.assign(\n          {\n            requireModules: [],\n            requirePaths: [],\n            loaders: [],\n            importPaths: [],\n          },\n          options.support\n        )\n\n  const pluginManager = await initializeForRunCucumber(\n    {\n      ...options,\n      support: supportCoordinates,\n    },\n    mergedEnvironment\n  )\n\n  const resolvedPaths = await resolvePaths(\n    logger,\n    cwd,\n    options.sources,\n    supportCoordinates\n  )\n  pluginManager.emit('paths:resolve', resolvedPaths)\n  const { sourcePaths, requirePaths, importPaths } = resolvedPaths\n\n  const supportCodeLibrary =\n    'originalCoordinates' in options.support\n      ? (options.support as SupportCodeLibrary)\n      : await getSupportCodeLibrary({\n          logger,\n          cwd,\n          newId,\n          requirePaths,\n          requireModules: supportCoordinates.requireModules,\n          importPaths,\n          loaders: supportCoordinates.loaders,\n        })\n\n  const eventBroadcaster = new EventEmitter()\n  if (onMessage) {\n    eventBroadcaster.on('envelope', onMessage)\n  }\n  eventBroadcaster.on('envelope', (value) =>\n    pluginManager.emit('message', value)\n  )\n  const eventDataCollector = new EventDataCollector(eventBroadcaster)\n\n  let formatterStreamError = false\n  const cleanupFormatters = await initializeFormatters({\n    env,\n    cwd,\n    stdout,\n    stderr,\n    logger,\n    onStreamError: () => (formatterStreamError = true),\n    eventBroadcaster,\n    eventDataCollector,\n    configuration: options.formats,\n    supportCodeLibrary,\n    pluginManager,\n  })\n  await emitMetaMessage(eventBroadcaster, env)\n\n  let filteredPickles: ReadonlyArray<IFilterablePickle> = []\n  let parseErrors: ParseError[] = []\n  if (sourcePaths.length > 0) {\n    const gherkinResult = await getPicklesAndErrors({\n      newId,\n      cwd,\n      sourcePaths,\n      coordinates: options.sources,\n      onEnvelope: (envelope) => eventBroadcaster.emit('envelope', envelope),\n    })\n    filteredPickles = await pluginManager.transform(\n      'pickles:filter',\n      gherkinResult.filterablePickles\n    )\n    filteredPickles = await pluginManager.transform(\n      'pickles:order',\n      filteredPickles\n    )\n    parseErrors = gherkinResult.parseErrors\n  }\n  if (parseErrors.length) {\n    parseErrors.forEach((parseError) => {\n      logger.error(\n        `Parse error in \"${parseError.source.uri}\" ${parseError.message}`\n      )\n    })\n    await cleanupFormatters()\n    await pluginManager.cleanup()\n    return {\n      success: false,\n      support: supportCodeLibrary,\n    }\n  }\n\n  emitSupportCodeMessages({\n    eventBroadcaster,\n    supportCodeLibrary,\n    newId,\n  })\n\n  const runtime = await makeRuntime({\n    environment,\n    logger,\n    eventBroadcaster,\n    sourcedPickles: filteredPickles,\n    newId,\n    supportCodeLibrary,\n    options: options.runtime,\n    snippetOptions: options.formats.options,\n  })\n  const success = await runtime.run()\n  await pluginManager.cleanup()\n  await cleanupFormatters()\n\n  return {\n    success: success && !formatterStreamError,\n    support: supportCodeLibrary,\n  }\n}\n"]}

package/lib/cli/helpers.js

@@ -51,6 +51,9 @@ function orderPickles(pickleIds, order, logger) {
     switch (type) {
         case 'defined':
             break;
+        case 'reverse':
+            pickleIds.reverse();
+            break;
         case 'random':
             if (seed === '') {
                 const newSeed = Math.floor(Math.random() * 1000 * 1000).toString();
@@ -135,7 +138,7 @@ function emitStepDefinitions(supportCodeLibrary, eventBroadcaster) {
             stepDefinition: {
                 id: stepDefinition.id,
                 pattern: {
-                    source: stepDefinition.pattern.toString(),
+                    source: extractPatternSource(stepDefinition.pattern),
                     type: typeof stepDefinition.pattern === 'string'
                         ? messages.StepDefinitionPatternType.CUCUMBER_EXPRESSION
                         : messages.StepDefinitionPatternType.REGULAR_EXPRESSION,
@@ -146,6 +149,12 @@ function emitStepDefinitions(supportCodeLibrary, eventBroadcaster) {
         eventBroadcaster.emit('envelope', envelope);
     });
 }
+function extractPatternSource(pattern) {
+    if (pattern instanceof RegExp) {
+        return pattern.flags ? pattern.toString() : pattern.source;
+    }
+    return pattern;
+}
 function emitTestCaseHooks(supportCodeLibrary, eventBroadcaster) {
     ;
     [
@@ -188,6 +197,7 @@ function emitTestRunHooks(supportCodeLibrary, eventBroadcaster) {
                 hook: {
                     id: hook.id,
                     type,
+                    name: hook.name,
                     sourceReference: makeSourceReference(hook),
                 },
             });

package/lib/cli/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/cli/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaA,oCAuBC;AASD,0CA0BC;AA2HD,0DAcC;AA/MD,sDAAwB;AACxB,gFAA0C;AAC1C,6DAA8C;AAC9C,iDAAoE;AACpE,8EAA0D;AAE1D,wCAAoC;AAKpC,+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,CAAC;QACb,KAAK,SAAS;YACZ,MAAK;QACP,KAAK,QAAQ;YACX,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAChB,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;YAC7B,CAAC;iBAAM,CAAC;gBACN,IAAA,8BAAO,EAAC,SAAS,EAAE,IAAI,CAAC,CAAA;YAC1B,CAAC;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;IACL,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACpB,CAAC;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;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,CAAC;QAClB,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YAC1B,SAAQ;QACV,CAAC;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;IAC7C,CAAC;AACH,CAAC;AAED,SAAS,2BAA2B,CAClC,kBAAsC,EACtC,gBAA8B;IAE9B,KAAK,MAAM,sBAAsB,IAAI,kBAAkB,CAAC,uBAAuB,EAAE,CAAC;QAChF,MAAM,QAAQ,GAAsB;YAClC,sBAAsB;SACvB,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;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;QACC;YACE,kBAAkB,CAAC,6BAA6B;YAChD,mBAAQ,CAAC,gBAAgB;SACjB;QACV;YACE,kBAAkB,CAAC,4BAA4B;YAC/C,mBAAQ,CAAC,eAAe;SAChB;KACX,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;gBAChC,IAAI,EAAE;oBACJ,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,IAAI;oBACJ,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,aAAa,EAAE,IAAI,CAAC,aAAa;oBACjC,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC;iBAC3C;aACiB,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,kBAAsC,EACtC,gBAA8B;IAE9B,CAAC;IAAA;QACC;YACE,kBAAkB,CAAC,4BAA4B;YAC/C,mBAAQ,CAAC,eAAe;SAChB;QACV;YACE,kBAAkB,CAAC,2BAA2B;YAC9C,mBAAQ,CAAC,cAAc;SACf;KACX,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;gBAChC,IAAI,EAAE;oBACJ,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,IAAI;oBACJ,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC;iBAC3C;aACiB,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,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","sourcesContent":["import { EventEmitter } from 'node:events'\nimport os from 'node:os'\nimport shuffle from 'knuth-shuffle-seeded'\nimport * as messages from '@cucumber/messages'\nimport { Envelope, HookType, IdGenerator } from '@cucumber/messages'\nimport detectCiEnvironment from '@cucumber/ci-environment'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { version } from '../version'\nimport { ILogger } from '../environment'\nimport { ILineAndUri } from '../types'\nimport { IPickleOrder } from '../filter'\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        'Unrecognized 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    [\n      supportCodeLibrary.beforeTestCaseHookDefinitions,\n      HookType.BEFORE_TEST_CASE,\n    ] as const,\n    [\n      supportCodeLibrary.afterTestCaseHookDefinitions,\n      HookType.AFTER_TEST_CASE,\n    ] as const,\n  ].forEach(([hooks, type]) => {\n    hooks.forEach((hook) => {\n      eventBroadcaster.emit('envelope', {\n        hook: {\n          id: hook.id,\n          type,\n          name: hook.name,\n          tagExpression: hook.tagExpression,\n          sourceReference: makeSourceReference(hook),\n        },\n      } satisfies Envelope)\n    })\n  })\n}\n\nfunction emitTestRunHooks(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[\n    [\n      supportCodeLibrary.beforeTestRunHookDefinitions,\n      HookType.BEFORE_TEST_RUN,\n    ] as const,\n    [\n      supportCodeLibrary.afterTestRunHookDefinitions,\n      HookType.AFTER_TEST_RUN,\n    ] as const,\n  ].forEach(([hooks, type]) => {\n    hooks.forEach((hook) => {\n      eventBroadcaster.emit('envelope', {\n        hook: {\n          id: hook.id,\n          type,\n          sourceReference: makeSourceReference(hook),\n        },\n      } satisfies Envelope)\n    })\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"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/cli/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaA,oCA0BC;AASD,0CA0BC;AAmID,0DAcC;AA1ND,sDAAwB;AACxB,gFAA0C;AAC1C,6DAA8C;AAC9C,iDAAoE;AACpE,8EAA0D;AAE1D,wCAAoC;AAKpC,+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,CAAC;QACb,KAAK,SAAS;YACZ,MAAK;QACP,KAAK,SAAS;YACZ,SAAS,CAAC,OAAO,EAAE,CAAA;YACnB,MAAK;QACP,KAAK,QAAQ;YACX,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAChB,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;YAC7B,CAAC;iBAAM,CAAC;gBACN,IAAA,8BAAO,EAAC,SAAS,EAAE,IAAI,CAAC,CAAA;YAC1B,CAAC;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;IACL,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACpB,CAAC;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;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,CAAC;QAClB,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YAC1B,SAAQ;QACV,CAAC;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;IAC7C,CAAC;AACH,CAAC;AAED,SAAS,2BAA2B,CAClC,kBAAsC,EACtC,gBAA8B;IAE9B,KAAK,MAAM,sBAAsB,IAAI,kBAAkB,CAAC,uBAAuB,EAAE,CAAC;QAChF,MAAM,QAAQ,GAAsB;YAClC,sBAAsB;SACvB,CAAA;QACD,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;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,oBAAoB,CAAC,cAAc,CAAC,OAAO,CAAC;oBACpD,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,oBAAoB,CAAC,OAAwB;IACpD,IAAI,OAAO,YAAY,MAAM,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5D,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,iBAAiB,CACxB,kBAAsC,EACtC,gBAA8B;IAE9B,CAAC;IAAA;QACC;YACE,kBAAkB,CAAC,6BAA6B;YAChD,mBAAQ,CAAC,gBAAgB;SACjB;QACV;YACE,kBAAkB,CAAC,4BAA4B;YAC/C,mBAAQ,CAAC,eAAe;SAChB;KACX,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;gBAChC,IAAI,EAAE;oBACJ,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,IAAI;oBACJ,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,aAAa,EAAE,IAAI,CAAC,aAAa;oBACjC,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC;iBAC3C;aACiB,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,kBAAsC,EACtC,gBAA8B;IAE9B,CAAC;IAAA;QACC;YACE,kBAAkB,CAAC,4BAA4B;YAC/C,mBAAQ,CAAC,eAAe;SAChB;QACV;YACE,kBAAkB,CAAC,2BAA2B;YAC9C,mBAAQ,CAAC,cAAc;SACf;KACX,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;gBAChC,IAAI,EAAE;oBACJ,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,IAAI;oBACJ,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC;iBAC3C;aACiB,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,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","sourcesContent":["import { EventEmitter } from 'node:events'\nimport os from 'node:os'\nimport shuffle from 'knuth-shuffle-seeded'\nimport * as messages from '@cucumber/messages'\nimport { Envelope, HookType, IdGenerator } from '@cucumber/messages'\nimport detectCiEnvironment from '@cucumber/ci-environment'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { version } from '../version'\nimport { ILogger } from '../environment'\nimport { ILineAndUri } from '../types'\nimport { IPickleOrder } from '../filter'\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 'reverse':\n      pickleIds.reverse()\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        'Unrecognized 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: extractPatternSource(stepDefinition.pattern),\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 extractPatternSource(pattern: string | RegExp) {\n  if (pattern instanceof RegExp) {\n    return pattern.flags ? pattern.toString() : pattern.source\n  }\n  return pattern\n}\n\nfunction emitTestCaseHooks(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[\n    [\n      supportCodeLibrary.beforeTestCaseHookDefinitions,\n      HookType.BEFORE_TEST_CASE,\n    ] as const,\n    [\n      supportCodeLibrary.afterTestCaseHookDefinitions,\n      HookType.AFTER_TEST_CASE,\n    ] as const,\n  ].forEach(([hooks, type]) => {\n    hooks.forEach((hook) => {\n      eventBroadcaster.emit('envelope', {\n        hook: {\n          id: hook.id,\n          type,\n          name: hook.name,\n          tagExpression: hook.tagExpression,\n          sourceReference: makeSourceReference(hook),\n        },\n      } satisfies Envelope)\n    })\n  })\n}\n\nfunction emitTestRunHooks(\n  supportCodeLibrary: SupportCodeLibrary,\n  eventBroadcaster: EventEmitter\n): void {\n  ;[\n    [\n      supportCodeLibrary.beforeTestRunHookDefinitions,\n      HookType.BEFORE_TEST_RUN,\n    ] as const,\n    [\n      supportCodeLibrary.afterTestRunHookDefinitions,\n      HookType.AFTER_TEST_RUN,\n    ] as const,\n  ].forEach(([hooks, type]) => {\n    hooks.forEach((hook) => {\n      eventBroadcaster.emit('envelope', {\n        hook: {\n          id: hook.id,\n          type,\n          name: hook.name,\n          sourceReference: makeSourceReference(hook),\n        },\n      } satisfies Envelope)\n    })\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/argv_parser.js

@@ -68,7 +68,7 @@ const ArgvParser = {
             .option('-l, --loader <NODE_MODULE>', 'module specifier(s) for loaders to be registered ahead of loading support code', ArgvParser.collect)
             .option('--language <ISO 639-1>', 'provide the default language for feature files')
             .option('--name <REGEXP>', 'only execute the scenarios with name matching the expression (repeatable)', ArgvParser.collect)
-            .option('--order <TYPE[:SEED]>', 'run scenarios in the specified order. Type should be `defined` or `random`')
+            .option('--order <TYPE[:SEED]>', 'run scenarios in the specified order. Type should be `defined`, `reverse` or `random`')
             .option('-p, --profile <NAME>', 'specify the profile to use (repeatable)', ArgvParser.collect, [])
             .option('--parallel <NUMBER_OF_WORKERS>', 'run in parallel with the given number of workers', (val) => ArgvParser.validateCountOption(val, '--parallel'))
             .option('--publish', 'Publish a report to https://reports.cucumber.io')

package/lib/configuration/argv_parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"argv_parser.js","sourceRoot":"","sources":["../../src/configuration/argv_parser.ts"],"names":[],"mappings":";;;;;AAAA,yCAAmC;AACnC,gEAAgC;AAChC,+CAA4C;AAC5C,wCAAoC;AACpC,kDAAoD;AAkBpD,MAAM,UAAU,GAAG;IACjB,OAAO,CAAI,GAAM,EAAE,OAAY,EAAE;QAC/B,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAA;QACvB,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,OAAO,UAAU,GAAW,EAAE,OAAe,EAAE;YAC7C,IAAI,GAAW,CAAA;YACf,IAAI,CAAC;gBACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,GAAU,KAAK,CAAA;gBACtB,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,yBAAyB,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC,CAAA;YACxE,CAAC;YACD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,sCAAsC,GAAG,EAAE,CAAC,CAAA;YACvE,CAAC;YACD,OAAO,IAAA,sBAAK,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACzB,CAAC,CAAA;IACH,CAAC;IAED,SAAS,CAAC,KAAa,EAAE,IAAa;QACpC,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAA;IACvD,CAAC;IAED,mBAAmB,CAAC,KAAa,EAAE,UAAkB;QACnD,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,KAAK,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,iCAAiC,CAAC,CAAA;QACjE,CAAC;QACD,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,gBAAgB,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,EAAE,CAAC,CAAA;QACpD,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,CAAC,IAAc;QAClB,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,aAAa,CAAC,CAAA;QAE1C,OAAO;aACJ,oBAAoB,CAAC,IAAI,CAAC;aAC1B,wBAAwB,CAAC,KAAK,CAAC;aAC/B,KAAK,CAAC,uCAAuC,CAAC;aAC9C,OAAO,CAAC,iBAAO,EAAE,eAAe,CAAC;aACjC,MAAM,CAAC,iBAAiB,EAAE,gCAAgC,CAAC;aAC3D,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;aAC3D,MAAM,CAAC,eAAe,EAAE,2CAA2C,CAAC;aACpE,MAAM,CACL,sBAAsB,EACtB,kGAAkG,CACnG;aACA,MAAM,CAAC,aAAa,EAAE,gCAAgC,CAAC;aACvD,MAAM,CACL,4BAA4B,EAC5B,oHAAoH;YAClH,MAAM,CAAC,OAAO,CAAC,uBAAa,CAAC,CAAC,MAAM,CAClC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,CAC/B,QAAQ,GAAG,OAAO,GAAG,KAAK,WAAW,IAAI,EAC3C,EAAE,CACH,EACH,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,yBAAyB,EACzB,6CAA6C,EAC7C,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,CACzC;aACA,MAAM,CACL,6BAA6B,EAC7B,wBAAwB,EACxB,UAAU,CAAC,gBAAgB,CAC5B;aACA,MAAM,CAAC,kBAAkB,EAAE,gBAAgB,CAAC;aAC5C,MAAM,CACL,8BAA8B,EAC9B,qDAAqD,EACrD,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,4BAA4B,EAC5B,gFAAgF,EAChF,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,wBAAwB,EACxB,gDAAgD,CACjD;aACA,MAAM,CACL,iBAAiB,EACjB,2EAA2E,EAC3E,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,uBAAuB,EACvB,4EAA4E,CAC7E;aACA,MAAM,CACL,sBAAsB,EACtB,yCAAyC,EACzC,UAAU,CAAC,OAAO,EAClB,EAAE,CACH;aACA,MAAM,CACL,gCAAgC,EAChC,kDAAkD,EAClD,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,YAAY,CAAC,CAC3D;aACA,MAAM,CAAC,WAAW,EAAE,iDAAiD,CAAC;aACtE,MAAM,CACL,+BAA+B,EAC/B,sDAAsD,EACtD,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,gCAAgC,EAChC,0DAA0D,EAC1D,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,6BAA6B,EAC7B,sEAAsE,EACtE,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,SAAS,CAAC,CACxD;aACA,MAAM,CACL,iCAAiC,EACjC;wDACgD,EAChD,UAAU,CAAC,SAAS,CACrB;aACA,MAAM,CACL,uBAAuB,EACvB,wDAAwD,CACzD;aACA,MAAM,CAAC,UAAU,EAAE,iCAAiC,CAAC;aACrD,MAAM,CAAC,aAAa,EAAE,yCAAyC,CAAC;aAChE,MAAM,CACL,yBAAyB,EACzB,uFAAuF,EACvF,UAAU,CAAC,SAAS,CACrB;aACA,MAAM,CACL,2BAA2B,EAC3B,8EAA8E,EAC9E,UAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAC3C,CAAA;QAEH,OAAO,CAAC,WAAW,CACjB,UAAU,EACV,6FAA6F,CAC9F,CAAA;QAED,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnB,MAAM,EACJ,MAAM,EACN,YAAY,EACZ,aAAa,EACb,OAAO,EACP,GAAG,YAAY,EAChB,GAAoB,OAAO,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,aAAa,GAA4B,YAAY,CAAA;QAC3D,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;QACpC,CAAC;QAED,OAAO;YACL,OAAO,EAAE;gBACP,MAAM;gBACN,YAAY;gBACZ,aAAa;gBACb,OAAO;aACR;YACD,aAAa;SACd,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,UAAU,CAAA","sourcesContent":["import { Command } from 'commander'\nimport merge from 'lodash.merge'\nimport { dialects } from '@cucumber/gherkin'\nimport { version } from '../version'\nimport { documentation } from '../formatter/builtin'\nimport { IConfiguration } from './types'\n\nexport interface IParsedArgvOptions {\n  config?: string\n  i18nKeywords?: string\n  i18nLanguages?: boolean\n  profile: string[]\n}\n\nexport interface IParsedArgv {\n  options: IParsedArgvOptions\n  configuration: Partial<IConfiguration>\n}\n\ntype IRawArgvOptions = Partial<Omit<IConfiguration, 'paths'>> &\n  IParsedArgvOptions\n\nconst ArgvParser = {\n  collect<T>(val: T, memo: T[] = []): T[] {\n    if (val) {\n      return [...memo, val]\n    }\n    return undefined\n  },\n\n  mergeJson(option: string): (str: string, memo?: object) => object {\n    return function (str: string, memo: object = {}) {\n      let val: object\n      try {\n        val = JSON.parse(str)\n      } catch (error) {\n        const e: Error = error\n        throw new Error(`${option} passed invalid JSON: ${e.message}: ${str}`)\n      }\n      if (typeof val !== 'object' || Array.isArray(val)) {\n        throw new Error(`${option} must be passed JSON of an object: ${str}`)\n      }\n      return merge(memo, val)\n    }\n  },\n\n  mergeTags(value: string, memo?: string): string {\n    return memo ? `${memo} and (${value})` : `(${value})`\n  },\n\n  validateCountOption(value: string, optionName: string): number {\n    const numericValue = parseInt(value)\n    if (isNaN(numericValue) || numericValue < 0) {\n      throw new Error(`${optionName} must be a non negative integer`)\n    }\n    return numericValue\n  },\n\n  validateLanguage(value: string): string {\n    if (!Object.keys(dialects).includes(value)) {\n      throw new Error(`Unsupported ISO 639-1: ${value}`)\n    }\n    return value\n  },\n\n  parse(argv: string[]): IParsedArgv {\n    const program = new Command('cucumber-js')\n\n    program\n      .allowExcessArguments(true)\n      .storeOptionsAsProperties(false)\n      .usage('[options] [<GLOB|DIR|FILE[:LINE]>...]')\n      .version(version, '-v, --version')\n      .option('-b, --backtrace', 'show full backtrace for errors')\n      .option('-c, --config <PATH>', 'specify configuration file')\n      .option('-d, --dry-run', 'invoke formatters without executing steps')\n      .option(\n        '--exit, --force-exit',\n        'force shutdown of the event loop when the test run has finished: cucumber will call process.exit'\n      )\n      .option('--fail-fast', 'abort the run on first failure')\n      .option(\n        '-f, --format <TYPE[:PATH]>',\n        'specify the output format, optionally supply PATH to redirect formatter output (repeatable).  Available formats:\\n' +\n          Object.entries(documentation).reduce(\n            (previous, [key, description]) =>\n              previous + `    ${key}: ${description}\\n`,\n            ''\n          ),\n        ArgvParser.collect\n      )\n      .option(\n        '--format-options <JSON>',\n        'provide options for formatters (repeatable)',\n        ArgvParser.mergeJson('--format-options')\n      )\n      .option(\n        '--i18n-keywords <ISO 639-1>',\n        'list language keywords',\n        ArgvParser.validateLanguage\n      )\n      .option('--i18n-languages', 'list languages')\n      .option(\n        '-i, --import <GLOB|DIR|FILE>',\n        'import files before executing features (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '-l, --loader <NODE_MODULE>',\n        'module specifier(s) for loaders to be registered ahead of loading support code',\n        ArgvParser.collect\n      )\n      .option(\n        '--language <ISO 639-1>',\n        'provide the default language for feature files'\n      )\n      .option(\n        '--name <REGEXP>',\n        'only execute the scenarios with name matching the expression (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--order <TYPE[:SEED]>',\n        'run scenarios in the specified order. Type should be `defined` or `random`'\n      )\n      .option(\n        '-p, --profile <NAME>',\n        'specify the profile to use (repeatable)',\n        ArgvParser.collect,\n        []\n      )\n      .option(\n        '--parallel <NUMBER_OF_WORKERS>',\n        'run in parallel with the given number of workers',\n        (val) => ArgvParser.validateCountOption(val, '--parallel')\n      )\n      .option('--publish', 'Publish a report to https://reports.cucumber.io')\n      .option(\n        '-r, --require <GLOB|DIR|FILE>',\n        'require files before executing features (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--require-module <NODE_MODULE>',\n        'require node modules before requiring files (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--retry <NUMBER_OF_RETRIES>',\n        'specify the number of times to retry failing test cases (default: 0)',\n        (val) => ArgvParser.validateCountOption(val, '--retry')\n      )\n      .option(\n        '--retry-tag-filter <EXPRESSION>',\n        `only retries the features or scenarios with tags matching the expression (repeatable).\n        This option requires '--retry' to be specified.`,\n        ArgvParser.mergeTags\n      )\n      .option(\n        '--shard <INDEX/TOTAL>',\n        'run shard INDEX of TOTAL shards. The index starts at 1'\n      )\n      .option('--strict', 'fail if there are pending steps')\n      .option('--no-strict', 'succeed even if there are pending steps')\n      .option(\n        '-t, --tags <EXPRESSION>',\n        'only execute the features or scenarios with tags matching the expression (repeatable)',\n        ArgvParser.mergeTags\n      )\n      .option(\n        '--world-parameters <JSON>',\n        'provide parameters that will be passed to the world constructor (repeatable)',\n        ArgvParser.mergeJson('--world-parameters')\n      )\n\n    program.addHelpText(\n      'afterAll',\n      'For more details please visit https://github.com/cucumber/cucumber-js/blob/main/docs/cli.md'\n    )\n\n    program.parse(argv)\n    const {\n      config,\n      i18nKeywords,\n      i18nLanguages,\n      profile,\n      ...regularStuff\n    }: IRawArgvOptions = program.opts()\n    const configuration: Partial<IConfiguration> = regularStuff\n    if (program.args.length > 0) {\n      configuration.paths = program.args\n    }\n\n    return {\n      options: {\n        config,\n        i18nKeywords,\n        i18nLanguages,\n        profile,\n      },\n      configuration,\n    }\n  },\n}\n\nexport default ArgvParser\n"]}
+{"version":3,"file":"argv_parser.js","sourceRoot":"","sources":["../../src/configuration/argv_parser.ts"],"names":[],"mappings":";;;;;AAAA,yCAAmC;AACnC,gEAAgC;AAChC,+CAA4C;AAC5C,wCAAoC;AACpC,kDAAoD;AAkBpD,MAAM,UAAU,GAAG;IACjB,OAAO,CAAI,GAAM,EAAE,OAAY,EAAE;QAC/B,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAA;QACvB,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,OAAO,UAAU,GAAW,EAAE,OAAe,EAAE;YAC7C,IAAI,GAAW,CAAA;YACf,IAAI,CAAC;gBACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,GAAU,KAAK,CAAA;gBACtB,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,yBAAyB,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC,CAAA;YACxE,CAAC;YACD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,sCAAsC,GAAG,EAAE,CAAC,CAAA;YACvE,CAAC;YACD,OAAO,IAAA,sBAAK,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACzB,CAAC,CAAA;IACH,CAAC;IAED,SAAS,CAAC,KAAa,EAAE,IAAa;QACpC,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAA;IACvD,CAAC;IAED,mBAAmB,CAAC,KAAa,EAAE,UAAkB;QACnD,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,KAAK,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,iCAAiC,CAAC,CAAA;QACjE,CAAC;QACD,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,gBAAgB,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,EAAE,CAAC,CAAA;QACpD,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,CAAC,IAAc;QAClB,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,aAAa,CAAC,CAAA;QAE1C,OAAO;aACJ,oBAAoB,CAAC,IAAI,CAAC;aAC1B,wBAAwB,CAAC,KAAK,CAAC;aAC/B,KAAK,CAAC,uCAAuC,CAAC;aAC9C,OAAO,CAAC,iBAAO,EAAE,eAAe,CAAC;aACjC,MAAM,CAAC,iBAAiB,EAAE,gCAAgC,CAAC;aAC3D,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;aAC3D,MAAM,CAAC,eAAe,EAAE,2CAA2C,CAAC;aACpE,MAAM,CACL,sBAAsB,EACtB,kGAAkG,CACnG;aACA,MAAM,CAAC,aAAa,EAAE,gCAAgC,CAAC;aACvD,MAAM,CACL,4BAA4B,EAC5B,oHAAoH;YAClH,MAAM,CAAC,OAAO,CAAC,uBAAa,CAAC,CAAC,MAAM,CAClC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,CAC/B,QAAQ,GAAG,OAAO,GAAG,KAAK,WAAW,IAAI,EAC3C,EAAE,CACH,EACH,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,yBAAyB,EACzB,6CAA6C,EAC7C,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,CACzC;aACA,MAAM,CACL,6BAA6B,EAC7B,wBAAwB,EACxB,UAAU,CAAC,gBAAgB,CAC5B;aACA,MAAM,CAAC,kBAAkB,EAAE,gBAAgB,CAAC;aAC5C,MAAM,CACL,8BAA8B,EAC9B,qDAAqD,EACrD,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,4BAA4B,EAC5B,gFAAgF,EAChF,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,wBAAwB,EACxB,gDAAgD,CACjD;aACA,MAAM,CACL,iBAAiB,EACjB,2EAA2E,EAC3E,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,uBAAuB,EACvB,uFAAuF,CACxF;aACA,MAAM,CACL,sBAAsB,EACtB,yCAAyC,EACzC,UAAU,CAAC,OAAO,EAClB,EAAE,CACH;aACA,MAAM,CACL,gCAAgC,EAChC,kDAAkD,EAClD,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,YAAY,CAAC,CAC3D;aACA,MAAM,CAAC,WAAW,EAAE,iDAAiD,CAAC;aACtE,MAAM,CACL,+BAA+B,EAC/B,sDAAsD,EACtD,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,gCAAgC,EAChC,0DAA0D,EAC1D,UAAU,CAAC,OAAO,CACnB;aACA,MAAM,CACL,6BAA6B,EAC7B,sEAAsE,EACtE,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,GAAG,EAAE,SAAS,CAAC,CACxD;aACA,MAAM,CACL,iCAAiC,EACjC;wDACgD,EAChD,UAAU,CAAC,SAAS,CACrB;aACA,MAAM,CACL,uBAAuB,EACvB,wDAAwD,CACzD;aACA,MAAM,CAAC,UAAU,EAAE,iCAAiC,CAAC;aACrD,MAAM,CAAC,aAAa,EAAE,yCAAyC,CAAC;aAChE,MAAM,CACL,yBAAyB,EACzB,uFAAuF,EACvF,UAAU,CAAC,SAAS,CACrB;aACA,MAAM,CACL,2BAA2B,EAC3B,8EAA8E,EAC9E,UAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAC3C,CAAA;QAEH,OAAO,CAAC,WAAW,CACjB,UAAU,EACV,6FAA6F,CAC9F,CAAA;QAED,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnB,MAAM,EACJ,MAAM,EACN,YAAY,EACZ,aAAa,EACb,OAAO,EACP,GAAG,YAAY,EAChB,GAAoB,OAAO,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,aAAa,GAA4B,YAAY,CAAA;QAC3D,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;QACpC,CAAC;QAED,OAAO;YACL,OAAO,EAAE;gBACP,MAAM;gBACN,YAAY;gBACZ,aAAa;gBACb,OAAO;aACR;YACD,aAAa;SACd,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,UAAU,CAAA","sourcesContent":["import { Command } from 'commander'\nimport merge from 'lodash.merge'\nimport { dialects } from '@cucumber/gherkin'\nimport { version } from '../version'\nimport { documentation } from '../formatter/builtin'\nimport { IConfiguration } from './types'\n\nexport interface IParsedArgvOptions {\n  config?: string\n  i18nKeywords?: string\n  i18nLanguages?: boolean\n  profile: string[]\n}\n\nexport interface IParsedArgv {\n  options: IParsedArgvOptions\n  configuration: Partial<IConfiguration>\n}\n\ntype IRawArgvOptions = Partial<Omit<IConfiguration, 'paths'>> &\n  IParsedArgvOptions\n\nconst ArgvParser = {\n  collect<T>(val: T, memo: T[] = []): T[] {\n    if (val) {\n      return [...memo, val]\n    }\n    return undefined\n  },\n\n  mergeJson(option: string): (str: string, memo?: object) => object {\n    return function (str: string, memo: object = {}) {\n      let val: object\n      try {\n        val = JSON.parse(str)\n      } catch (error) {\n        const e: Error = error\n        throw new Error(`${option} passed invalid JSON: ${e.message}: ${str}`)\n      }\n      if (typeof val !== 'object' || Array.isArray(val)) {\n        throw new Error(`${option} must be passed JSON of an object: ${str}`)\n      }\n      return merge(memo, val)\n    }\n  },\n\n  mergeTags(value: string, memo?: string): string {\n    return memo ? `${memo} and (${value})` : `(${value})`\n  },\n\n  validateCountOption(value: string, optionName: string): number {\n    const numericValue = parseInt(value)\n    if (isNaN(numericValue) || numericValue < 0) {\n      throw new Error(`${optionName} must be a non negative integer`)\n    }\n    return numericValue\n  },\n\n  validateLanguage(value: string): string {\n    if (!Object.keys(dialects).includes(value)) {\n      throw new Error(`Unsupported ISO 639-1: ${value}`)\n    }\n    return value\n  },\n\n  parse(argv: string[]): IParsedArgv {\n    const program = new Command('cucumber-js')\n\n    program\n      .allowExcessArguments(true)\n      .storeOptionsAsProperties(false)\n      .usage('[options] [<GLOB|DIR|FILE[:LINE]>...]')\n      .version(version, '-v, --version')\n      .option('-b, --backtrace', 'show full backtrace for errors')\n      .option('-c, --config <PATH>', 'specify configuration file')\n      .option('-d, --dry-run', 'invoke formatters without executing steps')\n      .option(\n        '--exit, --force-exit',\n        'force shutdown of the event loop when the test run has finished: cucumber will call process.exit'\n      )\n      .option('--fail-fast', 'abort the run on first failure')\n      .option(\n        '-f, --format <TYPE[:PATH]>',\n        'specify the output format, optionally supply PATH to redirect formatter output (repeatable).  Available formats:\\n' +\n          Object.entries(documentation).reduce(\n            (previous, [key, description]) =>\n              previous + `    ${key}: ${description}\\n`,\n            ''\n          ),\n        ArgvParser.collect\n      )\n      .option(\n        '--format-options <JSON>',\n        'provide options for formatters (repeatable)',\n        ArgvParser.mergeJson('--format-options')\n      )\n      .option(\n        '--i18n-keywords <ISO 639-1>',\n        'list language keywords',\n        ArgvParser.validateLanguage\n      )\n      .option('--i18n-languages', 'list languages')\n      .option(\n        '-i, --import <GLOB|DIR|FILE>',\n        'import files before executing features (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '-l, --loader <NODE_MODULE>',\n        'module specifier(s) for loaders to be registered ahead of loading support code',\n        ArgvParser.collect\n      )\n      .option(\n        '--language <ISO 639-1>',\n        'provide the default language for feature files'\n      )\n      .option(\n        '--name <REGEXP>',\n        'only execute the scenarios with name matching the expression (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--order <TYPE[:SEED]>',\n        'run scenarios in the specified order. Type should be `defined`, `reverse` or `random`'\n      )\n      .option(\n        '-p, --profile <NAME>',\n        'specify the profile to use (repeatable)',\n        ArgvParser.collect,\n        []\n      )\n      .option(\n        '--parallel <NUMBER_OF_WORKERS>',\n        'run in parallel with the given number of workers',\n        (val) => ArgvParser.validateCountOption(val, '--parallel')\n      )\n      .option('--publish', 'Publish a report to https://reports.cucumber.io')\n      .option(\n        '-r, --require <GLOB|DIR|FILE>',\n        'require files before executing features (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--require-module <NODE_MODULE>',\n        'require node modules before requiring files (repeatable)',\n        ArgvParser.collect\n      )\n      .option(\n        '--retry <NUMBER_OF_RETRIES>',\n        'specify the number of times to retry failing test cases (default: 0)',\n        (val) => ArgvParser.validateCountOption(val, '--retry')\n      )\n      .option(\n        '--retry-tag-filter <EXPRESSION>',\n        `only retries the features or scenarios with tags matching the expression (repeatable).\n        This option requires '--retry' to be specified.`,\n        ArgvParser.mergeTags\n      )\n      .option(\n        '--shard <INDEX/TOTAL>',\n        'run shard INDEX of TOTAL shards. The index starts at 1'\n      )\n      .option('--strict', 'fail if there are pending steps')\n      .option('--no-strict', 'succeed even if there are pending steps')\n      .option(\n        '-t, --tags <EXPRESSION>',\n        'only execute the features or scenarios with tags matching the expression (repeatable)',\n        ArgvParser.mergeTags\n      )\n      .option(\n        '--world-parameters <JSON>',\n        'provide parameters that will be passed to the world constructor (repeatable)',\n        ArgvParser.mergeJson('--world-parameters')\n      )\n\n    program.addHelpText(\n      'afterAll',\n      'For more details please visit https://github.com/cucumber/cucumber-js/blob/main/docs/cli.md'\n    )\n\n    program.parse(argv)\n    const {\n      config,\n      i18nKeywords,\n      i18nLanguages,\n      profile,\n      ...regularStuff\n    }: IRawArgvOptions = program.opts()\n    const configuration: Partial<IConfiguration> = regularStuff\n    if (program.args.length > 0) {\n      configuration.paths = program.args\n    }\n\n    return {\n      options: {\n        config,\n        i18nKeywords,\n        i18nLanguages,\n        profile,\n      },\n      configuration,\n    }\n  },\n}\n\nexport default ArgvParser\n"]}

package/lib/configuration/from_file.js

@@ -11,6 +11,17 @@ const node_url_1 = require("node:url");
 const yaml_1 = __importDefault(require("yaml"));
 const merge_configurations_1 = require("./merge_configurations");
 const parse_configuration_1 = require("./parse_configuration");
+const SUPPORTED_EXTENSIONS = [
+    '.json',
+    '.yaml',
+    '.yml',
+    '.js',
+    '.cjs',
+    '.mjs',
+    '.ts',
+    '.cts',
+    '.mts',
+];
 async function fromFile(logger, cwd, file, profiles = []) {
     let definitions = await loadFile(logger, cwd, file);
     const defaultDefinition = definitions.default;
@@ -49,45 +60,63 @@ async function handleDefaultFunctionDefinition(definitions, defaultDefinition) {
 async function loadFile(logger, cwd, file) {
     const filePath = node_path_1.default.join(cwd, file);
     const extension = node_path_1.default.extname(filePath);
+    if (!SUPPORTED_EXTENSIONS.includes(extension)) {
+        throw new Error(`Unsupported configuration file extension "${extension}"`);
+    }
     let definitions;
-    switch (extension) {
-        case '.json':
-            definitions = JSON.parse(await (0, node_util_1.promisify)(node_fs_1.default.readFile)(filePath, { encoding: 'utf-8' }));
-            break;
-        case '.yaml':
-        case '.yml':
-            definitions = yaml_1.default.parse(await (0, node_util_1.promisify)(node_fs_1.default.readFile)(filePath, { encoding: 'utf-8' }));
-            break;
-        case '.cjs':
-            logger.debug(`Loading configuration file "${file}" as CommonJS based on extension`);
-            // eslint-disable-next-line @typescript-eslint/no-require-imports
-            definitions = require(filePath);
-            break;
-        case '.mjs':
-            logger.debug(`Loading configuration file "${file}" as ESM based on extension`);
-            definitions = await import((0, node_url_1.pathToFileURL)(filePath).toString());
-            break;
-        case '.js':
-            {
-                const parentPackage = await readPackageJson(filePath);
-                if (!parentPackage) {
-                    logger.debug(`Loading configuration file "${file}" as CommonJS based on absence of a parent package`);
-                    // eslint-disable-next-line @typescript-eslint/no-require-imports
-                    definitions = require(filePath);
-                }
-                else if (parentPackage.type === 'module') {
-                    logger.debug(`Loading configuration file "${file}" as ESM based on "${parentPackage.name}" package type`);
-                    definitions = await import((0, node_url_1.pathToFileURL)(filePath).toString());
-                }
-                else {
-                    logger.debug(`Loading configuration file "${file}" as CommonJS based on "${parentPackage.name}" package type`);
-                    // eslint-disable-next-line @typescript-eslint/no-require-imports
-                    definitions = require(filePath);
+    try {
+        switch (extension) {
+            case '.json':
+                definitions = JSON.parse(await (0, node_util_1.promisify)(node_fs_1.default.readFile)(filePath, { encoding: 'utf-8' }));
+                break;
+            case '.yaml':
+            case '.yml':
+                definitions = yaml_1.default.parse(await (0, node_util_1.promisify)(node_fs_1.default.readFile)(filePath, { encoding: 'utf-8' }));
+                break;
+            case '.cjs':
+                logger.debug(`Loading configuration file "${file}" as CommonJS based on extension`);
+                // eslint-disable-next-line @typescript-eslint/no-require-imports
+                definitions = require(filePath);
+                break;
+            case '.cts':
+                logger.debug(`Loading configuration file "${file}" as TypeScript based on extension`);
+                // eslint-disable-next-line @typescript-eslint/no-require-imports
+                definitions = require(filePath);
+                break;
+            case '.mjs':
+                logger.debug(`Loading configuration file "${file}" as ESM based on extension`);
+                definitions = await import((0, node_url_1.pathToFileURL)(filePath).toString());
+                break;
+            case '.mts':
+            case '.ts':
+                logger.debug(`Loading configuration file "${file}" as TypeScript based on extension`);
+                definitions = await import((0, node_url_1.pathToFileURL)(filePath).toString());
+                break;
+            case '.js':
+                {
+                    const parentPackage = await readPackageJson(filePath);
+                    if (!parentPackage) {
+                        logger.debug(`Loading configuration file "${file}" as CommonJS based on absence of a parent package`);
+                        // eslint-disable-next-line @typescript-eslint/no-require-imports
+                        definitions = require(filePath);
+                    }
+                    else if (parentPackage.type === 'module') {
+                        logger.debug(`Loading configuration file "${file}" as ESM based on "${parentPackage.name}" package type`);
+                        definitions = await import((0, node_url_1.pathToFileURL)(filePath).toString());
+                    }
+                    else {
+                        logger.debug(`Loading configuration file "${file}" as CommonJS based on "${parentPackage.name}" package type`);
+                        // eslint-disable-next-line @typescript-eslint/no-require-imports
+                        definitions = require(filePath);
+                    }
                 }
-            }
-            break;
-        default:
-            throw new Error(`Unsupported configuration file extension "${extension}"`);
+                break;
+        }
+    }
+    catch (error) {
+        throw new Error(`Configuration file "${file}" failed to load/parse`, {
+            cause: error,
+        });
     }
     if (typeof definitions !== 'object') {
         throw new Error(`Configuration file ${filePath} does not export an object`);

package/lib/configuration/from_file.js.map

@@ -1 +1 @@
-{"version":3,"file":"from_file.js","sourceRoot":"","sources":["../../src/configuration/from_file.ts"],"names":[],"mappings":";;;;;AAUA,4BA4CC;AAtDD,sDAAwB;AACxB,0DAA4B;AAC5B,yCAAqC;AACrC,uCAAwC;AACxC,gDAAuB;AAGvB,iEAA4D;AAC5D,+DAA0D;AAEnD,KAAK,UAAU,QAAQ,CAC5B,MAAe,EACf,GAAW,EACX,IAAY,EACZ,WAAqB,EAAE;IAEvB,IAAI,WAAW,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;IAEnD,MAAM,iBAAiB,GAAY,WAAW,CAAC,OAAO,CAAA;IAEtD,IAAI,iBAAiB,EAAE,CAAC;QACtB,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAA;YACxD,WAAW,GAAG,MAAM,+BAA+B,CACjD,WAAW,EACX,iBAAiB,CAClB,CAAA;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,WAAW,CAAC,OAAO,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;IACxB,CAAC;IAED,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,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,sBAAsB,UAAU,iBAAiB,CAAC,CAAA;QACpE,CAAC;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;AAED,KAAK,UAAU,+BAA+B,CAC5C,WAAgC,EAChC,iBAA2B;IAE3B,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAA;IACH,CAAC;IAED,MAAM,sBAAsB,GAAG,MAAM,iBAAiB,EAAE,CAAA;IAExD,OAAO;QACL,OAAO,EAAE,EAAE;QACX,GAAG,sBAAsB;KAC1B,CAAA;AACH,CAAC;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,CAAC;QAClB,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,iEAAiE;YACjE,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,CAAC;gBACC,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAA;gBACrD,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oDAAoD,CACxF,CAAA;oBACD,iEAAiE;oBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;gBACjC,CAAC;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC3C,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;gBAChE,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,2BAA2B,aAAa,CAAC,IAAI,gBAAgB,CACjG,CAAA;oBACD,iEAAiE;oBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;gBACjC,CAAC;YACH,CAAC;YACD,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,GAAG,CAAC,CAAA;IAC9E,CAAC;IACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,4BAA4B,CAAC,CAAA;IAC7E,CAAC;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,QAAgB;IAC7C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAA;IACzD,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC1E,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 { ILogger } from '../environment'\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  let definitions = await loadFile(logger, cwd, file)\n\n  const defaultDefinition: unknown = definitions.default\n\n  if (defaultDefinition) {\n    if (typeof defaultDefinition === 'function') {\n      logger.debug('Default function found; loading profiles')\n      definitions = await handleDefaultFunctionDefinition(\n        definitions,\n        defaultDefinition\n      )\n    }\n  } else {\n    logger.debug('No default profile defined in configuration file')\n    definitions.default = {}\n  }\n\n  if (profiles.length < 1) {\n    logger.debug('No profiles specified; using default profile')\n    profiles = ['default']\n  }\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 handleDefaultFunctionDefinition(\n  definitions: Record<string, any>,\n  defaultDefinition: Function\n): Promise<Record<string, any>> {\n  if (Object.keys(definitions).length > 1) {\n    throw new Error(\n      'Invalid profiles specified: if a default function definition is provided, no other static profiles should be specified'\n    )\n  }\n\n  const definitionsFromDefault = await defaultDefinition()\n\n  return {\n    default: {},\n    ...definitionsFromDefault,\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-require-imports\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-require-imports\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-require-imports\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 { readPackageUp } = await import('read-package-up')\n  const parentPackage = await readPackageUp({ cwd: path.dirname(filePath) })\n  return parentPackage?.packageJson\n}\n"]}
+{"version":3,"file":"from_file.js","sourceRoot":"","sources":["../../src/configuration/from_file.ts"],"names":[],"mappings":";;;;;AAsBA,4BA4CC;AAlED,sDAAwB;AACxB,0DAA4B;AAC5B,yCAAqC;AACrC,uCAAwC;AACxC,gDAAuB;AAGvB,iEAA4D;AAC5D,+DAA0D;AAE1D,MAAM,oBAAoB,GAAG;IAC3B,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;CACP,CAAA;AAEM,KAAK,UAAU,QAAQ,CAC5B,MAAe,EACf,GAAW,EACX,IAAY,EACZ,WAAqB,EAAE;IAEvB,IAAI,WAAW,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;IAEnD,MAAM,iBAAiB,GAAY,WAAW,CAAC,OAAO,CAAA;IAEtD,IAAI,iBAAiB,EAAE,CAAC;QACtB,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAA;YACxD,WAAW,GAAG,MAAM,+BAA+B,CACjD,WAAW,EACX,iBAAiB,CAClB,CAAA;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,WAAW,CAAC,OAAO,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;IACxB,CAAC;IAED,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,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,sBAAsB,UAAU,iBAAiB,CAAC,CAAA;QACpE,CAAC;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;AAED,KAAK,UAAU,+BAA+B,CAC5C,WAAgC,EAChC,iBAA2B;IAE3B,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAA;IACH,CAAC;IAED,MAAM,sBAAsB,GAAG,MAAM,iBAAiB,EAAE,CAAA;IAExD,OAAO;QACL,OAAO,EAAE,EAAE;QACX,GAAG,sBAAsB;KAC1B,CAAA;AACH,CAAC;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,CAAC,oBAAoB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,GAAG,CAAC,CAAA;IAC5E,CAAC;IACD,IAAI,WAAW,CAAA;IACf,IAAI,CAAC;QACH,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,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;gBACD,MAAK;YACP,KAAK,OAAO,CAAC;YACb,KAAK,MAAM;gBACT,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;gBACD,MAAK;YACP,KAAK,MAAM;gBACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,kCAAkC,CACtE,CAAA;gBACD,iEAAiE;gBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC/B,MAAK;YACP,KAAK,MAAM;gBACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oCAAoC,CACxE,CAAA;gBACD,iEAAiE;gBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC/B,MAAK;YACP,KAAK,MAAM;gBACT,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,6BAA6B,CACjE,CAAA;gBACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC9D,MAAK;YACP,KAAK,MAAM,CAAC;YACZ,KAAK,KAAK;gBACR,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oCAAoC,CACxE,CAAA;gBACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC9D,MAAK;YACP,KAAK,KAAK;gBACR,CAAC;oBACC,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAA;oBACrD,IAAI,CAAC,aAAa,EAAE,CAAC;wBACnB,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,oDAAoD,CACxF,CAAA;wBACD,iEAAiE;wBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;oBACjC,CAAC;yBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC3C,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,sBAAsB,aAAa,CAAC,IAAI,gBAAgB,CAC5F,CAAA;wBACD,WAAW,GAAG,MAAM,MAAM,CAAC,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;oBAChE,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,2BAA2B,aAAa,CAAC,IAAI,gBAAgB,CACjG,CAAA;wBACD,iEAAiE;wBACjE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;oBACjC,CAAC;gBACH,CAAC;gBACD,MAAK;QACT,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,wBAAwB,EAAE;YACnE,KAAK,EAAE,KAAK;SACb,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,4BAA4B,CAAC,CAAA;IAC7E,CAAC;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,QAAgB;IAC7C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAA;IACzD,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,EAAE,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC1E,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 { ILogger } from '../environment'\nimport { IConfiguration } from './types'\nimport { mergeConfigurations } from './merge_configurations'\nimport { parseConfiguration } from './parse_configuration'\n\nconst SUPPORTED_EXTENSIONS = [\n  '.json',\n  '.yaml',\n  '.yml',\n  '.js',\n  '.cjs',\n  '.mjs',\n  '.ts',\n  '.cts',\n  '.mts',\n]\n\nexport async function fromFile(\n  logger: ILogger,\n  cwd: string,\n  file: string,\n  profiles: string[] = []\n): Promise<Partial<IConfiguration>> {\n  let definitions = await loadFile(logger, cwd, file)\n\n  const defaultDefinition: unknown = definitions.default\n\n  if (defaultDefinition) {\n    if (typeof defaultDefinition === 'function') {\n      logger.debug('Default function found; loading profiles')\n      definitions = await handleDefaultFunctionDefinition(\n        definitions,\n        defaultDefinition\n      )\n    }\n  } else {\n    logger.debug('No default profile defined in configuration file')\n    definitions.default = {}\n  }\n\n  if (profiles.length < 1) {\n    logger.debug('No profiles specified; using default profile')\n    profiles = ['default']\n  }\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 handleDefaultFunctionDefinition(\n  definitions: Record<string, any>,\n  defaultDefinition: Function\n): Promise<Record<string, any>> {\n  if (Object.keys(definitions).length > 1) {\n    throw new Error(\n      'Invalid profiles specified: if a default function definition is provided, no other static profiles should be specified'\n    )\n  }\n\n  const definitionsFromDefault = await defaultDefinition()\n\n  return {\n    default: {},\n    ...definitionsFromDefault,\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  if (!SUPPORTED_EXTENSIONS.includes(extension)) {\n    throw new Error(`Unsupported configuration file extension \"${extension}\"`)\n  }\n  let definitions\n  try {\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-require-imports\n        definitions = require(filePath)\n        break\n      case '.cts':\n        logger.debug(\n          `Loading configuration file \"${file}\" as TypeScript based on extension`\n        )\n        // eslint-disable-next-line @typescript-eslint/no-require-imports\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 '.mts':\n      case '.ts':\n        logger.debug(\n          `Loading configuration file \"${file}\" as TypeScript 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-require-imports\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-require-imports\n            definitions = require(filePath)\n          }\n        }\n        break\n    }\n  } catch (error) {\n    throw new Error(`Configuration file \"${file}\" failed to load/parse`, {\n      cause: error,\n    })\n  }\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 { readPackageUp } = await import('read-package-up')\n  const parentPackage = await readPackageUp({ cwd: path.dirname(filePath) })\n  return parentPackage?.packageJson\n}\n"]}

package/lib/filter/types.d.ts

@@ -3,10 +3,11 @@ import { GherkinDocument, Location, Pickle } from '@cucumber/messages';
  * The ordering strategy for pickles
  * @public
  * @example "defined"
+ * @example "reverse"
  * @example "random"
  * @example "random:234119"
  */
-export type IPickleOrder = 'defined' | 'random' | `random:${string}`;
+export type IPickleOrder = 'defined' | 'reverse' | 'random' | `random:${string}`;
 export interface IFilterablePickle {
     pickle: Pickle;
     gherkinDocument: GherkinDocument;

package/lib/filter/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/filter/types.ts"],"names":[],"mappings":"","sourcesContent":["import { GherkinDocument, Location, Pickle } from '@cucumber/messages'\n\n/**\n * The ordering strategy for pickles\n * @public\n * @example \"defined\"\n * @example \"random\"\n * @example \"random:234119\"\n */\nexport type IPickleOrder = 'defined' | 'random' | `random:${string}`\n\nexport interface IFilterablePickle {\n  pickle: Pickle\n  gherkinDocument: GherkinDocument\n  location: Location\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/filter/types.ts"],"names":[],"mappings":"","sourcesContent":["import { GherkinDocument, Location, Pickle } from '@cucumber/messages'\n\n/**\n * The ordering strategy for pickles\n * @public\n * @example \"defined\"\n * @example \"reverse\"\n * @example \"random\"\n * @example \"random:234119\"\n */\nexport type IPickleOrder = 'defined' | 'reverse' | 'random' | `random:${string}`\n\nexport interface IFilterablePickle {\n  pickle: Pickle\n  gherkinDocument: GherkinDocument\n  location: Location\n}\n"]}

package/lib/formatter/step_definition_snippet_builder/index.d.ts

@@ -15,6 +15,7 @@ export default class StepDefinitionSnippetBuilder {
     private readonly cucumberExpressionGenerator;
     constructor({ snippetSyntax, parameterTypeRegistry, }: INewStepDefinitionSnippetBuilderOptions);
     build({ keywordType, pickleStep }: IBuildRequest): string;
+    buildMultiple({ keywordType, pickleStep }: IBuildRequest): string[];
     getFunctionName(keywordType: KeywordType): string;
     getStepParameterNames(step: messages.PickleStep): string[];
 }

package/lib/formatter/step_definition_snippet_builder/index.js

@@ -23,6 +23,20 @@ class StepDefinitionSnippetBuilder {
             stepParameterNames,
         });
     }
+    buildMultiple({ keywordType, pickleStep }) {
+        const comment = 'Write code here that turns the phrase above into concrete actions';
+        const functionName = this.getFunctionName(keywordType);
+        const generatedExpressions = this.cucumberExpressionGenerator.generateExpressions(pickleStep.text);
+        const stepParameterNames = this.getStepParameterNames(pickleStep);
+        return generatedExpressions.map((generatedExpression) => {
+            return this.snippetSyntax.build({
+                comment,
+                functionName,
+                generatedExpressions: [generatedExpression],
+                stepParameterNames,
+            });
+        });
+    }
     getFunctionName(keywordType) {
         switch (keywordType) {
             case helpers_1.KeywordType.Event:

package/lib/formatter/step_definition_snippet_builder/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/formatter/step_definition_snippet_builder/index.ts"],"names":[],"mappings":";;AAAA,yEAGuC;AAEvC,wCAAwC;AACxC,yDAAwD;AACxD,uDAAmD;AAanD,MAAqB,4BAA4B;IAC9B,aAAa,CAAgB;IAC7B,2BAA2B,CAA6B;IAEzE,YAAY,EACV,aAAa,EACb,qBAAqB,GACmB;QACxC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,2BAA2B,GAAG,IAAI,kDAA2B,CAChE,GAAG,EAAE,CAAC,qBAAqB,CAAC,cAAc,CAC3C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,EAAE,WAAW,EAAE,UAAU,EAAiB;QAC9C,MAAM,OAAO,GACX,mEAAmE,CAAA;QACrE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACtD,MAAM,oBAAoB,GACxB,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACvE,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;QACjE,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YAC9B,OAAO;YACP,YAAY;YACZ,oBAAoB;YACpB,kBAAkB;SACnB,CAAC,CAAA;IACJ,CAAC;IAED,eAAe,CAAC,WAAwB;QACtC,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,qBAAW,CAAC,KAAK;gBACpB,OAAO,MAAM,CAAA;YACf,KAAK,qBAAW,CAAC,OAAO;gBACtB,OAAO,MAAM,CAAA;YACf,KAAK,qBAAW,CAAC,YAAY;gBAC3B,OAAO,OAAO,CAAA;QAClB,CAAC;IACH,CAAC;IAED,qBAAqB,CAAC,IAAyB;QAC7C,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAA,kCAAiB,EAAC,IAAI,CAAC,QAAQ,EAAE;gBACpD,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW;aAC7B,CAAC,CAAA;YACF,OAAO,CAAC,YAAY,CAAC,CAAA;QACvB,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;CACF;AAlDD,+CAkDC","sourcesContent":["import {\n  CucumberExpressionGenerator,\n  ParameterTypeRegistry,\n} from '@cucumber/cucumber-expressions'\nimport * as messages from '@cucumber/messages'\nimport { KeywordType } from '../helpers'\nimport { parseStepArgument } from '../../step_arguments'\nimport { doesHaveValue } from '../../value_checker'\nimport { ISnippetSnytax } from './snippet_syntax'\n\nexport interface INewStepDefinitionSnippetBuilderOptions {\n  snippetSyntax: ISnippetSnytax\n  parameterTypeRegistry: ParameterTypeRegistry\n}\n\nexport interface IBuildRequest {\n  keywordType: KeywordType\n  pickleStep: messages.PickleStep\n}\n\nexport default class StepDefinitionSnippetBuilder {\n  private readonly snippetSyntax: ISnippetSnytax\n  private readonly cucumberExpressionGenerator: CucumberExpressionGenerator\n\n  constructor({\n    snippetSyntax,\n    parameterTypeRegistry,\n  }: INewStepDefinitionSnippetBuilderOptions) {\n    this.snippetSyntax = snippetSyntax\n    this.cucumberExpressionGenerator = new CucumberExpressionGenerator(\n      () => parameterTypeRegistry.parameterTypes\n    )\n  }\n\n  build({ keywordType, pickleStep }: IBuildRequest): string {\n    const comment =\n      'Write code here that turns the phrase above into concrete actions'\n    const functionName = this.getFunctionName(keywordType)\n    const generatedExpressions =\n      this.cucumberExpressionGenerator.generateExpressions(pickleStep.text)\n    const stepParameterNames = this.getStepParameterNames(pickleStep)\n    return this.snippetSyntax.build({\n      comment,\n      functionName,\n      generatedExpressions,\n      stepParameterNames,\n    })\n  }\n\n  getFunctionName(keywordType: KeywordType): string {\n    switch (keywordType) {\n      case KeywordType.Event:\n        return 'When'\n      case KeywordType.Outcome:\n        return 'Then'\n      case KeywordType.Precondition:\n        return 'Given'\n    }\n  }\n\n  getStepParameterNames(step: messages.PickleStep): string[] {\n    if (doesHaveValue(step.argument)) {\n      const argumentName = parseStepArgument(step.argument, {\n        dataTable: () => 'dataTable',\n        docString: () => 'docString',\n      })\n      return [argumentName]\n    }\n    return []\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/formatter/step_definition_snippet_builder/index.ts"],"names":[],"mappings":";;AAAA,yEAGuC;AAEvC,wCAAwC;AACxC,yDAAwD;AACxD,uDAAmD;AAanD,MAAqB,4BAA4B;IAC9B,aAAa,CAAgB;IAC7B,2BAA2B,CAA6B;IAEzE,YAAY,EACV,aAAa,EACb,qBAAqB,GACmB;QACxC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,2BAA2B,GAAG,IAAI,kDAA2B,CAChE,GAAG,EAAE,CAAC,qBAAqB,CAAC,cAAc,CAC3C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,EAAE,WAAW,EAAE,UAAU,EAAiB;QAC9C,MAAM,OAAO,GACX,mEAAmE,CAAA;QACrE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACtD,MAAM,oBAAoB,GACxB,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACvE,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;QACjE,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YAC9B,OAAO;YACP,YAAY;YACZ,oBAAoB;YACpB,kBAAkB;SACnB,CAAC,CAAA;IACJ,CAAC;IAED,aAAa,CAAC,EAAE,WAAW,EAAE,UAAU,EAAiB;QACtD,MAAM,OAAO,GACX,mEAAmE,CAAA;QACrE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACtD,MAAM,oBAAoB,GACxB,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACvE,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;QACjE,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;gBAC9B,OAAO;gBACP,YAAY;gBACZ,oBAAoB,EAAE,CAAC,mBAAmB,CAAC;gBAC3C,kBAAkB;aACnB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,eAAe,CAAC,WAAwB;QACtC,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,qBAAW,CAAC,KAAK;gBACpB,OAAO,MAAM,CAAA;YACf,KAAK,qBAAW,CAAC,OAAO;gBACtB,OAAO,MAAM,CAAA;YACf,KAAK,qBAAW,CAAC,YAAY;gBAC3B,OAAO,OAAO,CAAA;QAClB,CAAC;IACH,CAAC;IAED,qBAAqB,CAAC,IAAyB;QAC7C,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,YAAY,GAAG,IAAA,kCAAiB,EAAC,IAAI,CAAC,QAAQ,EAAE;gBACpD,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW;aAC7B,CAAC,CAAA;YACF,OAAO,CAAC,YAAY,CAAC,CAAA;QACvB,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;CACF;AAnED,+CAmEC","sourcesContent":["import {\n  CucumberExpressionGenerator,\n  ParameterTypeRegistry,\n} from '@cucumber/cucumber-expressions'\nimport * as messages from '@cucumber/messages'\nimport { KeywordType } from '../helpers'\nimport { parseStepArgument } from '../../step_arguments'\nimport { doesHaveValue } from '../../value_checker'\nimport { ISnippetSnytax } from './snippet_syntax'\n\nexport interface INewStepDefinitionSnippetBuilderOptions {\n  snippetSyntax: ISnippetSnytax\n  parameterTypeRegistry: ParameterTypeRegistry\n}\n\nexport interface IBuildRequest {\n  keywordType: KeywordType\n  pickleStep: messages.PickleStep\n}\n\nexport default class StepDefinitionSnippetBuilder {\n  private readonly snippetSyntax: ISnippetSnytax\n  private readonly cucumberExpressionGenerator: CucumberExpressionGenerator\n\n  constructor({\n    snippetSyntax,\n    parameterTypeRegistry,\n  }: INewStepDefinitionSnippetBuilderOptions) {\n    this.snippetSyntax = snippetSyntax\n    this.cucumberExpressionGenerator = new CucumberExpressionGenerator(\n      () => parameterTypeRegistry.parameterTypes\n    )\n  }\n\n  build({ keywordType, pickleStep }: IBuildRequest): string {\n    const comment =\n      'Write code here that turns the phrase above into concrete actions'\n    const functionName = this.getFunctionName(keywordType)\n    const generatedExpressions =\n      this.cucumberExpressionGenerator.generateExpressions(pickleStep.text)\n    const stepParameterNames = this.getStepParameterNames(pickleStep)\n    return this.snippetSyntax.build({\n      comment,\n      functionName,\n      generatedExpressions,\n      stepParameterNames,\n    })\n  }\n\n  buildMultiple({ keywordType, pickleStep }: IBuildRequest): string[] {\n    const comment =\n      'Write code here that turns the phrase above into concrete actions'\n    const functionName = this.getFunctionName(keywordType)\n    const generatedExpressions =\n      this.cucumberExpressionGenerator.generateExpressions(pickleStep.text)\n    const stepParameterNames = this.getStepParameterNames(pickleStep)\n    return generatedExpressions.map((generatedExpression) => {\n      return this.snippetSyntax.build({\n        comment,\n        functionName,\n        generatedExpressions: [generatedExpression],\n        stepParameterNames,\n      })\n    })\n  }\n\n  getFunctionName(keywordType: KeywordType): string {\n    switch (keywordType) {\n      case KeywordType.Event:\n        return 'When'\n      case KeywordType.Outcome:\n        return 'Then'\n      case KeywordType.Precondition:\n        return 'Given'\n    }\n  }\n\n  getStepParameterNames(step: messages.PickleStep): string[] {\n    if (doesHaveValue(step.argument)) {\n      const argumentName = parseStepArgument(step.argument, {\n        dataTable: () => 'dataTable',\n        docString: () => 'docString',\n      })\n      return [argumentName]\n    }\n    return []\n  }\n}\n"]}

package/lib/models/test_run_hook_definition.d.ts

@@ -1,3 +1,8 @@
-import Definition from './definition';
+import Definition, { IDefinitionParameters, IDefinitionOptions } from './definition';
+export interface ITestRunHookDefinitionOptions extends IDefinitionOptions {
+    name?: string;
+}
 export default class TestRunHookDefinition extends Definition {
+    readonly name: string;
+    constructor(data: IDefinitionParameters<ITestRunHookDefinitionOptions>);
 }

package/lib/models/test_run_hook_definition.js

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const definition_1 = __importDefault(require("./definition"));
 class TestRunHookDefinition extends definition_1.default {
+    name;
+    constructor(data) {
+        super(data);
+        this.name = data.options.name;
+    }
 }
 exports.default = TestRunHookDefinition;
 //# sourceMappingURL=test_run_hook_definition.js.map

package/lib/models/test_run_hook_definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"test_run_hook_definition.js","sourceRoot":"","sources":["../../src/models/test_run_hook_definition.ts"],"names":[],"mappings":";;;;;AAAA,8DAAqC;AAErC,MAAqB,qBAAsB,SAAQ,oBAAU;CAAG;AAAhE,wCAAgE","sourcesContent":["import Definition from './definition'\n\nexport default class TestRunHookDefinition extends Definition {}\n"]}
+{"version":3,"file":"test_run_hook_definition.js","sourceRoot":"","sources":["../../src/models/test_run_hook_definition.ts"],"names":[],"mappings":";;;;;AAAA,8DAGqB;AAMrB,MAAqB,qBAAsB,SAAQ,oBAAU;IAC3C,IAAI,CAAQ;IAE5B,YAAY,IAA0D;QACpE,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC/B,CAAC;CACF;AAPD,wCAOC","sourcesContent":["import Definition, {\n  IDefinitionParameters,\n  IDefinitionOptions,\n} from './definition'\n\nexport interface ITestRunHookDefinitionOptions extends IDefinitionOptions {\n  name?: string\n}\n\nexport default class TestRunHookDefinition extends Definition {\n  public readonly name: string\n\n  constructor(data: IDefinitionParameters<ITestRunHookDefinitionOptions>) {\n    super(data)\n    this.name = data.options.name\n  }\n}\n"]}

package/lib/publish/publish_plugin.js

@@ -4,11 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.publishPlugin = void 0;
+const promises_1 = require("node:stream/promises");
 const node_util_1 = require("node:util");
-const promises_1 = require("node:fs/promises");
+const promises_2 = require("node:fs/promises");
 const node_path_1 = __importDefault(require("node:path"));
 const node_os_1 = require("node:os");
 const node_fs_1 = require("node:fs");
+const node_zlib_1 = require("node:zlib");
 const supports_color_1 = require("supports-color");
 const has_ansi_1 = __importDefault(require("has-ansi"));
 const DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports';
@@ -37,22 +39,26 @@ exports.publishPlugin = {
             };
         }
         const uploadUrl = touchResponse.headers.get('Location');
-        const tempDir = await (0, promises_1.mkdtemp)(node_path_1.default.join((0, node_os_1.tmpdir)(), `cucumber-js-publish-`));
-        const tempFilePath = node_path_1.default.join(tempDir, 'envelopes.ndjson');
-        const tempFileStream = (0, node_fs_1.createWriteStream)(tempFilePath, {
-            encoding: 'utf-8',
-        });
-        on('message', (value) => tempFileStream.write(JSON.stringify(value) + '\n'));
+        const tempDir = await (0, promises_2.mkdtemp)(node_path_1.default.join((0, node_os_1.tmpdir)(), `cucumber-js-publish-`));
+        const tempFilePath = node_path_1.default.join(tempDir, 'envelopes.jsonl.gz');
+        const writeStream = (0, node_zlib_1.createGzip)();
+        const finishedWriting = (0, promises_1.pipeline)(writeStream, (0, node_fs_1.createWriteStream)(tempFilePath));
+        on('message', (value) => writeStream.write(JSON.stringify(value) + '\n'));
         return () => {
             return new Promise((resolve) => {
-                tempFileStream.end(async () => {
-                    const stats = await (0, promises_1.stat)(tempFilePath);
+                writeStream.end(async () => {
+                    await finishedWriting;
+                    const stats = await (0, promises_2.stat)(tempFilePath);
+                    const contentLength = stats.size.toString();
+                    logger.debug('Uploading envelopes to Cucumber Reports with content length:', contentLength);
                     const uploadResponse = await fetch(uploadUrl, {
                         method: 'PUT',
                         headers: {
-                            'Content-Length': stats.size.toString(),
+                            'Content-Type': 'application/jsonl',
+                            'Content-Encoding': 'gzip',
+                            'Content-Length': contentLength,
                         },
-                        body: (0, node_fs_1.createReadStream)(tempFilePath, { encoding: 'utf-8' }),
+                        body: (0, node_fs_1.createReadStream)(tempFilePath),
                         duplex: 'half',
                     });
                     if (uploadResponse.ok) {
@@ -60,7 +66,7 @@ exports.publishPlugin = {
                     }
                     else {
                         logger.error(`Failed to upload report to ${new URL(uploadUrl).origin} with status ${uploadResponse.status}`);
-                        logger.debug(uploadResponse);
+                        logger.debug(await uploadResponse.text());
                     }
                     resolve();
                 });

package/lib/publish/publish_plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish_plugin.js","sourceRoot":"","sources":["../../src/publish/publish_plugin.ts"],"names":[],"mappings":";;;;;;AACA,yCAAoD;AACpD,+CAAgD;AAChD,0DAA4B;AAC5B,qCAAgC;AAChC,qCAA6D;AAC7D,mDAA8C;AAC9C,wDAA8B;AAI9B,MAAM,4BAA4B,GAAG,0CAA0C,CAAA;AAElE,QAAA,aAAa,GAA2C;IACnE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,4BAA4B,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAC7D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QAC3C,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,EAAE;gBACV,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/B,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,gBAChD,aAAa,CAAC,MAChB,EAAE,CACH,CAAA;oBACD,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,mBAAI,CAAC,IAAI,CAAC,IAAA,gBAAM,GAAE,EAAE,sBAAsB,CAAC,CAAC,CAAA;QAC1E,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;QAC3D,MAAM,cAAc,GAAG,IAAA,2BAAiB,EAAC,YAAY,EAAE;YACrD,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAA;QACF,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAE5E,OAAO,GAAG,EAAE;YACV,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnC,cAAc,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;oBAC5B,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,YAAY,CAAC,CAAA;oBACtC,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;wBAC5C,MAAM,EAAE,KAAK;wBACb,OAAO,EAAE;4BACP,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;yBACxC;wBACD,IAAI,EAAE,IAAA,0BAAgB,EAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;wBAC3D,MAAM,EAAE,MAAM;qBACf,CAAC,CAAA;oBACF,IAAI,cAAc,CAAC,EAAE,EAAE,CAAC;wBACtB,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CACV,8BACE,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MACrB,gBAAgB,cAAc,CAAC,MAAM,EAAE,CACxC,CAAA;wBACD,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;oBAC9B,CAAC;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,MAAgB;IAC1D,IAAI,CAAC,IAAA,8BAAa,EAAC,MAAM,CAAC,IAAI,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAA,oCAAwB,EAAC,GAAG,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { Writable } from 'node:stream'\nimport { stripVTControlCharacters } from 'node:util'\nimport { mkdtemp, stat } from 'node:fs/promises'\nimport path from 'node:path'\nimport { tmpdir } from 'node:os'\nimport { createReadStream, createWriteStream } from 'node:fs'\nimport { supportsColor } from 'supports-color'\nimport hasAnsi from 'has-ansi'\nimport { InternalPlugin } from '../plugin'\nimport { IPublishConfig } from './types'\n\nconst DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'\n\nexport const publishPlugin: InternalPlugin<IPublishConfig | false> = {\n  type: 'plugin',\n  coordinator: async ({ on, logger, options, environment }) => {\n    if (!options) {\n      return undefined\n    }\n    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = options\n    const headers: { [key: string]: string } = {}\n    if (token !== undefined) {\n      headers.Authorization = `Bearer ${token}`\n    }\n    const touchResponse = await fetch(url, { headers })\n    const banner = await touchResponse.text()\n\n    if (!touchResponse.ok) {\n      return () => {\n        if (touchResponse.status < 500) {\n          environment.stderr.write(\n            sanitisePublishOutput(banner, environment.stderr) + '\\n'\n          )\n        } else {\n          logger.error(\n            `Failed to publish report to ${new URL(url).origin} with status ${\n              touchResponse.status\n            }`\n          )\n          logger.debug(touchResponse)\n        }\n      }\n    }\n\n    const uploadUrl = touchResponse.headers.get('Location')\n    const tempDir = await mkdtemp(path.join(tmpdir(), `cucumber-js-publish-`))\n    const tempFilePath = path.join(tempDir, 'envelopes.ndjson')\n    const tempFileStream = createWriteStream(tempFilePath, {\n      encoding: 'utf-8',\n    })\n    on('message', (value) => tempFileStream.write(JSON.stringify(value) + '\\n'))\n\n    return () => {\n      return new Promise<void>((resolve) => {\n        tempFileStream.end(async () => {\n          const stats = await stat(tempFilePath)\n          const uploadResponse = await fetch(uploadUrl, {\n            method: 'PUT',\n            headers: {\n              'Content-Length': stats.size.toString(),\n            },\n            body: createReadStream(tempFilePath, { encoding: 'utf-8' }),\n            duplex: 'half',\n          })\n          if (uploadResponse.ok) {\n            environment.stderr.write(\n              sanitisePublishOutput(banner, environment.stderr) + '\\n'\n            )\n          } else {\n            logger.error(\n              `Failed to upload report to ${\n                new URL(uploadUrl).origin\n              } with status ${uploadResponse.status}`\n            )\n            logger.debug(uploadResponse)\n          }\n          resolve()\n        })\n      })\n    }\n  },\n}\n\n/*\nThis is because the Cucumber Reports service returns a pre-formatted console message\nincluding ANSI escapes, so if our stderr stream doesn't support those we need to\nstrip them back out. Ideally we should get structured data from the service and\ncompose the console message on this end.\n */\nfunction sanitisePublishOutput(raw: string, stderr: Writable) {\n  if (!supportsColor(stderr) && hasAnsi(raw)) {\n    return stripVTControlCharacters(raw)\n  }\n  return raw\n}\n"]}
+{"version":3,"file":"publish_plugin.js","sourceRoot":"","sources":["../../src/publish/publish_plugin.ts"],"names":[],"mappings":";;;;;;AACA,mDAA+C;AAC/C,yCAAoD;AACpD,+CAAgD;AAChD,0DAA4B;AAC5B,qCAAgC;AAChC,qCAA6D;AAC7D,yCAAsC;AACtC,mDAA8C;AAC9C,wDAA8B;AAI9B,MAAM,4BAA4B,GAAG,0CAA0C,CAAA;AAElE,QAAA,aAAa,GAA2C;IACnE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,4BAA4B,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAC7D,MAAM,OAAO,GAA8B,EAAE,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QAC3C,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,OAAO,GAAG,EAAE;gBACV,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/B,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CACV,+BAA+B,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,gBAChD,aAAa,CAAC,MAChB,EAAE,CACH,CAAA;oBACD,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,mBAAI,CAAC,IAAI,CAAC,IAAA,gBAAM,GAAE,EAAE,sBAAsB,CAAC,CAAC,CAAA;QAC1E,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAA;QAC7D,MAAM,WAAW,GAAG,IAAA,sBAAU,GAAE,CAAA;QAChC,MAAM,eAAe,GAAG,IAAA,mBAAQ,EAC9B,WAAW,EACX,IAAA,2BAAiB,EAAC,YAAY,CAAC,CAChC,CAAA;QACD,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAEzE,OAAO,GAAG,EAAE;YACV,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACnC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;oBACzB,MAAM,eAAe,CAAA;oBACrB,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,YAAY,CAAC,CAAA;oBACtC,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;oBAC3C,MAAM,CAAC,KAAK,CACV,8DAA8D,EAC9D,aAAa,CACd,CAAA;oBACD,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;wBAC5C,MAAM,EAAE,KAAK;wBACb,OAAO,EAAE;4BACP,cAAc,EAAE,mBAAmB;4BACnC,kBAAkB,EAAE,MAAM;4BAC1B,gBAAgB,EAAE,aAAa;yBAChC;wBACD,IAAI,EAAE,IAAA,0BAAgB,EAAC,YAAY,CAAC;wBACpC,MAAM,EAAE,MAAM;qBACf,CAAC,CAAA;oBACF,IAAI,cAAc,CAAC,EAAE,EAAE,CAAC;wBACtB,WAAW,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CACzD,CAAA;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CACV,8BACE,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MACrB,gBAAgB,cAAc,CAAC,MAAM,EAAE,CACxC,CAAA;wBACD,MAAM,CAAC,KAAK,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC,CAAA;oBAC3C,CAAC;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAW,EAAE,MAAgB;IAC1D,IAAI,CAAC,IAAA,8BAAa,EAAC,MAAM,CAAC,IAAI,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAA,oCAAwB,EAAC,GAAG,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { Writable } from 'node:stream'\nimport { pipeline } from 'node:stream/promises'\nimport { stripVTControlCharacters } from 'node:util'\nimport { mkdtemp, stat } from 'node:fs/promises'\nimport path from 'node:path'\nimport { tmpdir } from 'node:os'\nimport { createReadStream, createWriteStream } from 'node:fs'\nimport { createGzip } from 'node:zlib'\nimport { supportsColor } from 'supports-color'\nimport hasAnsi from 'has-ansi'\nimport { InternalPlugin } from '../plugin'\nimport { IPublishConfig } from './types'\n\nconst DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'\n\nexport const publishPlugin: InternalPlugin<IPublishConfig | false> = {\n  type: 'plugin',\n  coordinator: async ({ on, logger, options, environment }) => {\n    if (!options) {\n      return undefined\n    }\n    const { url = DEFAULT_CUCUMBER_PUBLISH_URL, token } = options\n    const headers: { [key: string]: string } = {}\n    if (token !== undefined) {\n      headers.Authorization = `Bearer ${token}`\n    }\n    const touchResponse = await fetch(url, { headers })\n    const banner = await touchResponse.text()\n\n    if (!touchResponse.ok) {\n      return () => {\n        if (touchResponse.status < 500) {\n          environment.stderr.write(\n            sanitisePublishOutput(banner, environment.stderr) + '\\n'\n          )\n        } else {\n          logger.error(\n            `Failed to publish report to ${new URL(url).origin} with status ${\n              touchResponse.status\n            }`\n          )\n          logger.debug(touchResponse)\n        }\n      }\n    }\n\n    const uploadUrl = touchResponse.headers.get('Location')\n    const tempDir = await mkdtemp(path.join(tmpdir(), `cucumber-js-publish-`))\n    const tempFilePath = path.join(tempDir, 'envelopes.jsonl.gz')\n    const writeStream = createGzip()\n    const finishedWriting = pipeline(\n      writeStream,\n      createWriteStream(tempFilePath)\n    )\n    on('message', (value) => writeStream.write(JSON.stringify(value) + '\\n'))\n\n    return () => {\n      return new Promise<void>((resolve) => {\n        writeStream.end(async () => {\n          await finishedWriting\n          const stats = await stat(tempFilePath)\n          const contentLength = stats.size.toString()\n          logger.debug(\n            'Uploading envelopes to Cucumber Reports with content length:',\n            contentLength\n          )\n          const uploadResponse = await fetch(uploadUrl, {\n            method: 'PUT',\n            headers: {\n              'Content-Type': 'application/jsonl',\n              'Content-Encoding': 'gzip',\n              'Content-Length': contentLength,\n            },\n            body: createReadStream(tempFilePath),\n            duplex: 'half',\n          })\n          if (uploadResponse.ok) {\n            environment.stderr.write(\n              sanitisePublishOutput(banner, environment.stderr) + '\\n'\n            )\n          } else {\n            logger.error(\n              `Failed to upload report to ${\n                new URL(uploadUrl).origin\n              } with status ${uploadResponse.status}`\n            )\n            logger.debug(await uploadResponse.text())\n          }\n          resolve()\n        })\n      })\n    }\n  },\n}\n\n/*\nThis is because the Cucumber Reports service returns a pre-formatted console message\nincluding ANSI escapes, so if our stderr stream doesn't support those we need to\nstrip them back out. Ideally we should get structured data from the service and\ncompose the console message on this end.\n */\nfunction sanitisePublishOutput(raw: string, stderr: Writable) {\n  if (!supportsColor(stderr) && hasAnsi(raw)) {\n    return stripVTControlCharacters(raw)\n  }\n  return raw\n}\n"]}