@cucumber/cucumber 12.3.0 → 12.5.0

package/lib/environment/console_logger.js

@@ -22,6 +22,9 @@ class ConsoleLogger {
     warn(message, ...optionalParams) {
         this.console.warn(message, ...optionalParams);
     }
+    info(message, ...optionalParams) {
+        this.console.info(message, ...optionalParams);
+    }
 }
 exports.ConsoleLogger = ConsoleLogger;
 //# sourceMappingURL=console_logger.js.map

package/lib/environment/console_logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"console_logger.js","sourceRoot":"","sources":["../../src/environment/console_logger.ts"],"names":[],"mappings":";;;AAAA,+CAAsC;AAItC,MAAa,aAAa;IAId;IACA;IAJO,OAAO,CAAS;IAEjC,YACU,MAAgB,EAChB,YAAqB;QADrB,WAAM,GAAN,MAAM,CAAU;QAChB,iBAAY,GAAZ,YAAY,CAAS;QAE7B,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC3C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IAChD,CAAC;IAED,IAAI,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IAC/C,CAAC;CACF;AAvBD,sCAuBC","sourcesContent":["import { Console } from 'node:console'\nimport { Writable } from 'node:stream'\nimport { ILogger } from './types'\n\nexport class ConsoleLogger implements ILogger {\n  private readonly console: Console\n\n  constructor(\n    private stream: Writable,\n    private debugEnabled: boolean\n  ) {\n    this.console = new Console(this.stream)\n  }\n\n  debug(message?: any, ...optionalParams: any[]): void {\n    if (this.debugEnabled) {\n      this.console.debug(message, ...optionalParams)\n    }\n  }\n\n  error(message?: any, ...optionalParams: any[]): void {\n    this.console.error(message, ...optionalParams)\n  }\n\n  warn(message?: any, ...optionalParams: any[]): void {\n    this.console.warn(message, ...optionalParams)\n  }\n}\n"]}
+{"version":3,"file":"console_logger.js","sourceRoot":"","sources":["../../src/environment/console_logger.ts"],"names":[],"mappings":";;;AAAA,+CAAsC;AAItC,MAAa,aAAa;IAId;IACA;IAJO,OAAO,CAAS;IAEjC,YACU,MAAgB,EAChB,YAAqB;QADrB,WAAM,GAAN,MAAM,CAAU;QAChB,iBAAY,GAAZ,YAAY,CAAS;QAE7B,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC3C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IAChD,CAAC;IAED,IAAI,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IAC/C,CAAC;IAED,IAAI,CAAC,OAAa,EAAE,GAAG,cAAqB;QAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IAC/C,CAAC;CACF;AA3BD,sCA2BC","sourcesContent":["import { Console } from 'node:console'\nimport { Writable } from 'node:stream'\nimport { ILogger } from './types'\n\nexport class ConsoleLogger implements ILogger {\n  private readonly console: Console\n\n  constructor(\n    private stream: Writable,\n    private debugEnabled: boolean\n  ) {\n    this.console = new Console(this.stream)\n  }\n\n  debug(message?: any, ...optionalParams: any[]): void {\n    if (this.debugEnabled) {\n      this.console.debug(message, ...optionalParams)\n    }\n  }\n\n  error(message?: any, ...optionalParams: any[]): void {\n    this.console.error(message, ...optionalParams)\n  }\n\n  warn(message?: any, ...optionalParams: any[]): void {\n    this.console.warn(message, ...optionalParams)\n  }\n\n  info(message?: any, ...optionalParams: any[]): void {\n    this.console.info(message, ...optionalParams)\n  }\n}\n"]}

package/lib/environment/types.d.ts

@@ -1,8 +1,15 @@
 import { Writable } from 'node:stream';
+/**
+ * A logger that can be used to direct messages to stderr or similar
+ * @public
+ * @remarks
+ * Matches the interface of Node.js Console, for the methods it has.
+ */
 export interface ILogger {
     debug: (message?: any, ...optionalParams: any[]) => void;
     error: (message?: any, ...optionalParams: any[]) => void;
     warn: (message?: any, ...optionalParams: any[]) => void;
+    info: (message?: any, ...optionalParams: any[]) => void;
 }
 /**
  * Contextual data about the project environment

package/lib/environment/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/environment/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\n\nexport interface ILogger {\n  debug: (message?: any, ...optionalParams: any[]) => void\n  error: (message?: any, ...optionalParams: any[]) => void\n  warn: (message?: any, ...optionalParams: any[]) => void\n}\n\n/**\n * Contextual data about the project environment\n * @public\n */\nexport interface IRunEnvironment {\n  /**\n   * Working directory for the project\n   * @default process.cwd()\n   */\n  cwd?: string\n  /**\n   * Writable stream where the test run's main formatter output is written\n   * @default process.stdout\n   */\n  stdout?: Writable\n  /**\n   * Writable stream where the test run's warning/error output is written\n   * @default process.stderr\n   */\n  stderr?: Writable\n  /**\n   * Environment variables\n   * @default process.env\n   */\n  env?: Record<string, string | undefined>\n  /**\n   * Whether debug logging should be emitted to {@link IRunEnvironment.stderr}\n   * @default false\n   * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/debugging.md}\n   */\n  debug?: boolean\n}\n\nexport type UsableEnvironment = Required<IRunEnvironment> & {\n  logger: ILogger\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/environment/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\n\n/**\n * A logger that can be used to direct messages to stderr or similar\n * @public\n * @remarks\n * Matches the interface of Node.js Console, for the methods it has.\n */\nexport interface ILogger {\n  debug: (message?: any, ...optionalParams: any[]) => void\n  error: (message?: any, ...optionalParams: any[]) => void\n  warn: (message?: any, ...optionalParams: any[]) => void\n  info: (message?: any, ...optionalParams: any[]) => void\n}\n\n/**\n * Contextual data about the project environment\n * @public\n */\nexport interface IRunEnvironment {\n  /**\n   * Working directory for the project\n   * @default process.cwd()\n   */\n  cwd?: string\n  /**\n   * Writable stream where the test run's main formatter output is written\n   * @default process.stdout\n   */\n  stdout?: Writable\n  /**\n   * Writable stream where the test run's warning/error output is written\n   * @default process.stderr\n   */\n  stderr?: Writable\n  /**\n   * Environment variables\n   * @default process.env\n   */\n  env?: Record<string, string | undefined>\n  /**\n   * Whether debug logging should be emitted to {@link IRunEnvironment.stderr}\n   * @default false\n   * @see {@link https://github.com/cucumber/cucumber-js/blob/main/docs/debugging.md}\n   */\n  debug?: boolean\n}\n\nexport type UsableEnvironment = Required<IRunEnvironment> & {\n  logger: ILogger\n}\n"]}

package/lib/filter/filter_plugin.d.ts

@@ -1,3 +1,2 @@
-import { InternalPlugin } from '../plugin';
-import { ISourcesCoordinates } from '../api';
-export declare const filterPlugin: InternalPlugin<ISourcesCoordinates>;
+import { Plugin } from '../plugin';
+export declare const filterPlugin: Plugin;

package/lib/filter/filter_plugin.js

@@ -8,12 +8,12 @@ const pickle_filter_1 = __importDefault(require("../pickle_filter"));
 const helpers_1 = require("../cli/helpers");
 exports.filterPlugin = {
     type: 'plugin',
-    coordinator: async ({ on, options, logger, environment }) => {
+    coordinator: async ({ on, transform, options, logger, environment }) => {
         let unexpandedSourcePaths = [];
         on('paths:resolve', (paths) => {
             unexpandedSourcePaths = paths.unexpandedSourcePaths;
         });
-        on('pickles:filter', async (allPickles) => {
+        transform('pickles:filter', async (allPickles) => {
             const pickleFilter = new pickle_filter_1.default({
                 cwd: environment.cwd,
                 featurePaths: unexpandedSourcePaths,
@@ -22,7 +22,7 @@ exports.filterPlugin = {
             });
             return allPickles.filter((pickle) => pickleFilter.matches(pickle));
         });
-        on('pickles:order', async (unorderedPickles) => {
+        transform('pickles:order', async (unorderedPickles) => {
             const orderedPickles = [...unorderedPickles];
             (0, helpers_1.orderPickles)(orderedPickles, options.order, logger);
             return orderedPickles;

package/lib/filter/filter_plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter_plugin.js","sourceRoot":"","sources":["../../src/filter/filter_plugin.ts"],"names":[],"mappings":";;;;;;AAEA,qEAA2C;AAC3C,4CAA6C;AAEhC,QAAA,YAAY,GAAwC;IAC/D,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1D,IAAI,qBAAqB,GAAa,EAAE,CAAA;QACxC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YACxC,MAAM,YAAY,GAAG,IAAI,uBAAY,CAAC;gBACpC,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,YAAY,EAAE,qBAAqB;gBACnC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,aAAa,EAAE,OAAO,CAAC,aAAa;aACrC,CAAC,CAAA;YAEF,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE;YAC7C,MAAM,cAAc,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAA;YAC5C,IAAA,sBAAY,EAAC,cAAc,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YACnD,OAAO,cAAc,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA","sourcesContent":["import { InternalPlugin } from '../plugin'\nimport { ISourcesCoordinates } from '../api'\nimport PickleFilter from '../pickle_filter'\nimport { orderPickles } from '../cli/helpers'\n\nexport const filterPlugin: InternalPlugin<ISourcesCoordinates> = {\n  type: 'plugin',\n  coordinator: async ({ on, options, logger, environment }) => {\n    let unexpandedSourcePaths: string[] = []\n    on('paths:resolve', (paths) => {\n      unexpandedSourcePaths = paths.unexpandedSourcePaths\n    })\n\n    on('pickles:filter', async (allPickles) => {\n      const pickleFilter = new PickleFilter({\n        cwd: environment.cwd,\n        featurePaths: unexpandedSourcePaths,\n        names: options.names,\n        tagExpression: options.tagExpression,\n      })\n\n      return allPickles.filter((pickle) => pickleFilter.matches(pickle))\n    })\n\n    on('pickles:order', async (unorderedPickles) => {\n      const orderedPickles = [...unorderedPickles]\n      orderPickles(orderedPickles, options.order, logger)\n      return orderedPickles\n    })\n  },\n}\n"]}
+{"version":3,"file":"filter_plugin.js","sourceRoot":"","sources":["../../src/filter/filter_plugin.ts"],"names":[],"mappings":";;;;;;AACA,qEAA2C;AAC3C,4CAA6C;AAEhC,QAAA,YAAY,GAAW;IAClC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE;QACrE,IAAI,qBAAqB,GAAa,EAAE,CAAA;QACxC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,SAAS,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YAC/C,MAAM,YAAY,GAAG,IAAI,uBAAY,CAAC;gBACpC,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,YAAY,EAAE,qBAAqB;gBACnC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,aAAa,EAAE,OAAO,CAAC,aAAa;aACrC,CAAC,CAAA;YAEF,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;QAEF,SAAS,CAAC,eAAe,EAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE;YACpD,MAAM,cAAc,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAA;YAC5C,IAAA,sBAAY,EAAC,cAAc,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YACnD,OAAO,cAAc,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA","sourcesContent":["import { Plugin } from '../plugin'\nimport PickleFilter from '../pickle_filter'\nimport { orderPickles } from '../cli/helpers'\n\nexport const filterPlugin: Plugin = {\n  type: 'plugin',\n  coordinator: async ({ on, transform, options, logger, environment }) => {\n    let unexpandedSourcePaths: string[] = []\n    on('paths:resolve', (paths) => {\n      unexpandedSourcePaths = paths.unexpandedSourcePaths\n    })\n\n    transform('pickles:filter', async (allPickles) => {\n      const pickleFilter = new PickleFilter({\n        cwd: environment.cwd,\n        featurePaths: unexpandedSourcePaths,\n        names: options.names,\n        tagExpression: options.tagExpression,\n      })\n\n      return allPickles.filter((pickle) => pickleFilter.matches(pickle))\n    })\n\n    transform('pickles:order', async (unorderedPickles) => {\n      const orderedPickles = [...unorderedPickles]\n      orderPickles(orderedPickles, options.order, logger)\n      return orderedPickles\n    })\n  },\n}\n"]}

package/lib/filter/types.d.ts

@@ -8,6 +8,10 @@ import { GherkinDocument, Location, Pickle } from '@cucumber/messages';
  * @example "random:234119"
  */
 export type IPickleOrder = 'defined' | 'reverse' | 'random' | `random:${string}`;
+/**
+ * A Pickle decorated with relevant context that can be filtered or sorted
+ * @public
+ */
 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 \"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"]}
+{"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\n/**\n * A Pickle decorated with relevant context that can be filtered or sorted\n * @public\n */\nexport interface IFilterablePickle {\n  pickle: Pickle\n  gherkinDocument: GherkinDocument\n  location: Location\n}\n"]}

package/lib/formatter/helpers/event_data_collector.js

@@ -112,7 +112,6 @@ class EventDataCollector {
     }
     storeAttachment(attachment) {
         const { testCaseStartedId, testStepId } = attachment;
-        // TODO: we shouldn't have to check if these properties have values - they are non-nullable
         if ((0, value_checker_1.doesHaveValue)(testCaseStartedId) && (0, value_checker_1.doesHaveValue)(testStepId)) {
             const { stepAttachments } = this.testCaseAttemptDataMap[testCaseStartedId];
             if ((0, value_checker_1.doesNotHaveValue)(stepAttachments[testStepId])) {

package/lib/formatter/helpers/event_data_collector.js.map

@@ -1 +1 @@
-{"version":3,"file":"event_data_collector.js","sourceRoot":"","sources":["../../../src/formatter/helpers/event_data_collector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6DAA8C;AAC9C,uDAAqE;AAsBrE,MAAqB,kBAAkB;IAC7B,kBAAkB,GAA6C,EAAE,CAAA;IACjE,SAAS,GAAoC,EAAE,CAAA;IAC/C,WAAW,GAAsC,EAAE,CAAA;IACnD,sBAAsB,GAAyC,EAAE,CAAA;IAChE,uBAAuB,GAAsC,EAAE,CAAA;IAExE,YAAY,gBAA8B;QACxC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAChE,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC;IAED,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,mBAAmB;QACjB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,kBAAkB,CAAC,iBAAyB;QAC1C,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChD,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC;YACpD,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,aAAa,EAAE,mBAAmB,CAAC,aAAa;YAChD,eAAe,EAAE,mBAAmB,CAAC,eAAe;YACpD,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,mBAAmB,EAAE,mBAAmB,CAAC,mBAAmB;SAC7D,CAAA;IACH,CAAC;IAED,aAAa,CAAC,QAA2B;QACvC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC;gBACnD,QAAQ,CAAC,eAAe,CAAA;QAC5B,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAA;QACtD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;QACpE,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC5D,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;QACpD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,eAAyC;QACnE,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG;YAChD,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,aAAa,EAAE,KAAK;YACpB,UAAU,EAAE,eAAe,CAAC,UAAU;YACtC,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;YACf,mBAAmB,EAAE;gBACnB,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;gBAClC,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,OAAO;aAC9C;SACF,CAAA;IACH,CAAC;IAED,eAAe,CAAC,UAA+B;QAC7C,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,UAAU,CAAA;QACpD,2FAA2F;QAC3F,IAAI,IAAA,6BAAa,EAAC,iBAAiB,CAAC,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,EAAE,CAAC;YAClE,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;YAC1E,IAAI,IAAA,gCAAgB,EAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAClD,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAA;YAClC,CAAC;YACD,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,UAAU,EACV,cAAc,GACY;QAC1B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;YACpE,cAAc,CAAA;IAClB,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,aAAa,GACa;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAC/B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAC3D,CAAA;QACD,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,mBAAmB;YAChE,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9E,CAAC;CACF;AA5GD,qCA4GC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, doesNotHaveValue } from '../../value_checker'\n\ninterface ITestCaseAttemptData {\n  attempt: number\n  willBeRetried: boolean\n  testCaseId: string\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface ITestCaseAttempt {\n  attempt: number\n  willBeRetried: boolean\n  gherkinDocument: messages.GherkinDocument\n  pickle: messages.Pickle\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  testCase: messages.TestCase\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport default class EventDataCollector {\n  private gherkinDocumentMap: Record<string, messages.GherkinDocument> = {}\n  private pickleMap: Record<string, messages.Pickle> = {}\n  private testCaseMap: Record<string, messages.TestCase> = {}\n  private testCaseAttemptDataMap: Record<string, ITestCaseAttemptData> = {}\n  readonly undefinedParameterTypes: messages.UndefinedParameterType[] = []\n\n  constructor(eventBroadcaster: EventEmitter) {\n    eventBroadcaster.on('envelope', this.parseEnvelope.bind(this))\n  }\n\n  getGherkinDocument(uri: string): messages.GherkinDocument {\n    return this.gherkinDocumentMap[uri]\n  }\n\n  getPickle(pickleId: string): messages.Pickle {\n    return this.pickleMap[pickleId]\n  }\n\n  getTestCaseAttempts(): ITestCaseAttempt[] {\n    return Object.keys(this.testCaseAttemptDataMap).map((testCaseStartedId) => {\n      return this.getTestCaseAttempt(testCaseStartedId)\n    })\n  }\n\n  getTestCaseAttempt(testCaseStartedId: string): ITestCaseAttempt {\n    const testCaseAttemptData = this.testCaseAttemptDataMap[testCaseStartedId]\n    const testCase = this.testCaseMap[testCaseAttemptData.testCaseId]\n    const pickle = this.pickleMap[testCase.pickleId]\n    return {\n      gherkinDocument: this.gherkinDocumentMap[pickle.uri],\n      pickle,\n      testCase,\n      attempt: testCaseAttemptData.attempt,\n      willBeRetried: testCaseAttemptData.willBeRetried,\n      stepAttachments: testCaseAttemptData.stepAttachments,\n      stepResults: testCaseAttemptData.stepResults,\n      worstTestStepResult: testCaseAttemptData.worstTestStepResult,\n    }\n  }\n\n  parseEnvelope(envelope: messages.Envelope): void {\n    if (doesHaveValue(envelope.gherkinDocument)) {\n      this.gherkinDocumentMap[envelope.gherkinDocument.uri] =\n        envelope.gherkinDocument\n    } else if (doesHaveValue(envelope.pickle)) {\n      this.pickleMap[envelope.pickle.id] = envelope.pickle\n    } else if (doesHaveValue(envelope.undefinedParameterType)) {\n      this.undefinedParameterTypes.push(envelope.undefinedParameterType)\n    } else if (doesHaveValue(envelope.testCase)) {\n      this.testCaseMap[envelope.testCase.id] = envelope.testCase\n    } else if (doesHaveValue(envelope.testCaseStarted)) {\n      this.initTestCaseAttempt(envelope.testCaseStarted)\n    } else if (doesHaveValue(envelope.attachment)) {\n      this.storeAttachment(envelope.attachment)\n    } else if (doesHaveValue(envelope.testStepFinished)) {\n      this.storeTestStepResult(envelope.testStepFinished)\n    } else if (doesHaveValue(envelope.testCaseFinished)) {\n      this.storeTestCaseResult(envelope.testCaseFinished)\n    }\n  }\n\n  private initTestCaseAttempt(testCaseStarted: messages.TestCaseStarted): void {\n    this.testCaseAttemptDataMap[testCaseStarted.id] = {\n      attempt: testCaseStarted.attempt,\n      willBeRetried: false,\n      testCaseId: testCaseStarted.testCaseId,\n      stepAttachments: {},\n      stepResults: {},\n      worstTestStepResult: {\n        duration: { seconds: 0, nanos: 0 },\n        status: messages.TestStepResultStatus.UNKNOWN,\n      },\n    }\n  }\n\n  storeAttachment(attachment: messages.Attachment): void {\n    const { testCaseStartedId, testStepId } = attachment\n    // TODO: we shouldn't have to check if these properties have values - they are non-nullable\n    if (doesHaveValue(testCaseStartedId) && doesHaveValue(testStepId)) {\n      const { stepAttachments } = this.testCaseAttemptDataMap[testCaseStartedId]\n      if (doesNotHaveValue(stepAttachments[testStepId])) {\n        stepAttachments[testStepId] = []\n      }\n      stepAttachments[testStepId].push(attachment)\n    }\n  }\n\n  storeTestStepResult({\n    testCaseStartedId,\n    testStepId,\n    testStepResult,\n  }: messages.TestStepFinished): void {\n    this.testCaseAttemptDataMap[testCaseStartedId].stepResults[testStepId] =\n      testStepResult\n  }\n\n  storeTestCaseResult({\n    testCaseStartedId,\n    willBeRetried,\n  }: messages.TestCaseFinished): void {\n    const stepResults = Object.values(\n      this.testCaseAttemptDataMap[testCaseStartedId].stepResults\n    )\n    this.testCaseAttemptDataMap[testCaseStartedId].worstTestStepResult =\n      messages.getWorstTestStepResult(stepResults)\n    this.testCaseAttemptDataMap[testCaseStartedId].willBeRetried = willBeRetried\n  }\n}\n"]}
+{"version":3,"file":"event_data_collector.js","sourceRoot":"","sources":["../../../src/formatter/helpers/event_data_collector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6DAA8C;AAC9C,uDAAqE;AAsBrE,MAAqB,kBAAkB;IAC7B,kBAAkB,GAA6C,EAAE,CAAA;IACjE,SAAS,GAAoC,EAAE,CAAA;IAC/C,WAAW,GAAsC,EAAE,CAAA;IACnD,sBAAsB,GAAyC,EAAE,CAAA;IAChE,uBAAuB,GAAsC,EAAE,CAAA;IAExE,YAAY,gBAA8B;QACxC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAChE,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC;IAED,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,mBAAmB;QACjB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE;YACxE,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,kBAAkB,CAAC,iBAAyB;QAC1C,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChD,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC;YACpD,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,aAAa,EAAE,mBAAmB,CAAC,aAAa;YAChD,eAAe,EAAE,mBAAmB,CAAC,eAAe;YACpD,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,mBAAmB,EAAE,mBAAmB,CAAC,mBAAmB;SAC7D,CAAA;IACH,CAAC;IAED,aAAa,CAAC,QAA2B;QACvC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC;gBACnD,QAAQ,CAAC,eAAe,CAAA;QAC5B,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAA;QACtD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;QACpE,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC5D,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;QACpD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,eAAyC;QACnE,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG;YAChD,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,aAAa,EAAE,KAAK;YACpB,UAAU,EAAE,eAAe,CAAC,UAAU;YACtC,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;YACf,mBAAmB,EAAE;gBACnB,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;gBAClC,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,OAAO;aAC9C;SACF,CAAA;IACH,CAAC;IAED,eAAe,CAAC,UAA+B;QAC7C,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,UAAU,CAAA;QACpD,IAAI,IAAA,6BAAa,EAAC,iBAAiB,CAAC,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,EAAE,CAAC;YAClE,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAA;YAC1E,IAAI,IAAA,gCAAgB,EAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAClD,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAA;YAClC,CAAC;YACD,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,UAAU,EACV,cAAc,GACY;QAC1B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;YACpE,cAAc,CAAA;IAClB,CAAC;IAED,mBAAmB,CAAC,EAClB,iBAAiB,EACjB,aAAa,GACa;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAC/B,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAC3D,CAAA;QACD,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,mBAAmB;YAChE,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9E,CAAC;CACF;AA3GD,qCA2GC","sourcesContent":["import { EventEmitter } from 'node:events'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, doesNotHaveValue } from '../../value_checker'\n\ninterface ITestCaseAttemptData {\n  attempt: number\n  willBeRetried: boolean\n  testCaseId: string\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface ITestCaseAttempt {\n  attempt: number\n  willBeRetried: boolean\n  gherkinDocument: messages.GherkinDocument\n  pickle: messages.Pickle\n  stepAttachments: Record<string, messages.Attachment[]>\n  stepResults: Record<string, messages.TestStepResult>\n  testCase: messages.TestCase\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport default class EventDataCollector {\n  private gherkinDocumentMap: Record<string, messages.GherkinDocument> = {}\n  private pickleMap: Record<string, messages.Pickle> = {}\n  private testCaseMap: Record<string, messages.TestCase> = {}\n  private testCaseAttemptDataMap: Record<string, ITestCaseAttemptData> = {}\n  readonly undefinedParameterTypes: messages.UndefinedParameterType[] = []\n\n  constructor(eventBroadcaster: EventEmitter) {\n    eventBroadcaster.on('envelope', this.parseEnvelope.bind(this))\n  }\n\n  getGherkinDocument(uri: string): messages.GherkinDocument {\n    return this.gherkinDocumentMap[uri]\n  }\n\n  getPickle(pickleId: string): messages.Pickle {\n    return this.pickleMap[pickleId]\n  }\n\n  getTestCaseAttempts(): ITestCaseAttempt[] {\n    return Object.keys(this.testCaseAttemptDataMap).map((testCaseStartedId) => {\n      return this.getTestCaseAttempt(testCaseStartedId)\n    })\n  }\n\n  getTestCaseAttempt(testCaseStartedId: string): ITestCaseAttempt {\n    const testCaseAttemptData = this.testCaseAttemptDataMap[testCaseStartedId]\n    const testCase = this.testCaseMap[testCaseAttemptData.testCaseId]\n    const pickle = this.pickleMap[testCase.pickleId]\n    return {\n      gherkinDocument: this.gherkinDocumentMap[pickle.uri],\n      pickle,\n      testCase,\n      attempt: testCaseAttemptData.attempt,\n      willBeRetried: testCaseAttemptData.willBeRetried,\n      stepAttachments: testCaseAttemptData.stepAttachments,\n      stepResults: testCaseAttemptData.stepResults,\n      worstTestStepResult: testCaseAttemptData.worstTestStepResult,\n    }\n  }\n\n  parseEnvelope(envelope: messages.Envelope): void {\n    if (doesHaveValue(envelope.gherkinDocument)) {\n      this.gherkinDocumentMap[envelope.gherkinDocument.uri] =\n        envelope.gherkinDocument\n    } else if (doesHaveValue(envelope.pickle)) {\n      this.pickleMap[envelope.pickle.id] = envelope.pickle\n    } else if (doesHaveValue(envelope.undefinedParameterType)) {\n      this.undefinedParameterTypes.push(envelope.undefinedParameterType)\n    } else if (doesHaveValue(envelope.testCase)) {\n      this.testCaseMap[envelope.testCase.id] = envelope.testCase\n    } else if (doesHaveValue(envelope.testCaseStarted)) {\n      this.initTestCaseAttempt(envelope.testCaseStarted)\n    } else if (doesHaveValue(envelope.attachment)) {\n      this.storeAttachment(envelope.attachment)\n    } else if (doesHaveValue(envelope.testStepFinished)) {\n      this.storeTestStepResult(envelope.testStepFinished)\n    } else if (doesHaveValue(envelope.testCaseFinished)) {\n      this.storeTestCaseResult(envelope.testCaseFinished)\n    }\n  }\n\n  private initTestCaseAttempt(testCaseStarted: messages.TestCaseStarted): void {\n    this.testCaseAttemptDataMap[testCaseStarted.id] = {\n      attempt: testCaseStarted.attempt,\n      willBeRetried: false,\n      testCaseId: testCaseStarted.testCaseId,\n      stepAttachments: {},\n      stepResults: {},\n      worstTestStepResult: {\n        duration: { seconds: 0, nanos: 0 },\n        status: messages.TestStepResultStatus.UNKNOWN,\n      },\n    }\n  }\n\n  storeAttachment(attachment: messages.Attachment): void {\n    const { testCaseStartedId, testStepId } = attachment\n    if (doesHaveValue(testCaseStartedId) && doesHaveValue(testStepId)) {\n      const { stepAttachments } = this.testCaseAttemptDataMap[testCaseStartedId]\n      if (doesNotHaveValue(stepAttachments[testStepId])) {\n        stepAttachments[testStepId] = []\n      }\n      stepAttachments[testStepId].push(attachment)\n    }\n  }\n\n  storeTestStepResult({\n    testCaseStartedId,\n    testStepId,\n    testStepResult,\n  }: messages.TestStepFinished): void {\n    this.testCaseAttemptDataMap[testCaseStartedId].stepResults[testStepId] =\n      testStepResult\n  }\n\n  storeTestCaseResult({\n    testCaseStartedId,\n    willBeRetried,\n  }: messages.TestCaseFinished): void {\n    const stepResults = Object.values(\n      this.testCaseAttemptDataMap[testCaseStartedId].stepResults\n    )\n    this.testCaseAttemptDataMap[testCaseStartedId].worstTestStepResult =\n      messages.getWorstTestStepResult(stepResults)\n    this.testCaseAttemptDataMap[testCaseStartedId].willBeRetried = willBeRetried\n  }\n}\n"]}

package/lib/paths/types.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Paths that woll be used to load feature files and user code
+ * @public
+ * @remarks
+ * These values are the result of pre-processing to expand globs, expand
+ * directory references, and apply defaults where applicable.
+ */
 export interface IResolvedPaths {
     unexpandedSourcePaths: string[];
     sourcePaths: string[];

package/lib/paths/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/paths/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface IResolvedPaths {\n  unexpandedSourcePaths: string[]\n  sourcePaths: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/paths/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Paths that woll be used to load feature files and user code\n * @public\n * @remarks\n * These values are the result of pre-processing to expand globs, expand\n * directory references, and apply defaults where applicable.\n */\nexport interface IResolvedPaths {\n  unexpandedSourcePaths: string[]\n  sourcePaths: string[]\n  requirePaths: string[]\n  importPaths: string[]\n}\n"]}

package/lib/plugin/plugin_manager.d.ts

@@ -1,14 +1,16 @@
 import { UsableEnvironment } from '../environment';
-import { InternalPlugin, CoordinatorPluginEventValues, CoordinatorPluginEventKey, CoordinatorPluginTransformEventKey, Operation, FormatterPlugin } from './types';
+import { CoordinatorEventKey, CoordinatorEventValues, CoordinatorTransformKey, CoordinatorTransformValues, FormatterPlugin, Plugin, PluginOperation } from './types';
 export declare class PluginManager {
     private readonly environment;
-    private handlers;
+    private readonly handlers;
+    private readonly transformers;
     private cleanupFns;
     constructor(environment: UsableEnvironment);
-    private register;
-    initFormatter<OptionsType>(plugin: FormatterPlugin<OptionsType>, options: OptionsType, stream: NodeJS.WritableStream, write: (buffer: string | Uint8Array) => void, directory?: string): Promise<void>;
-    initCoordinator<OptionsType>(operation: Operation, plugin: InternalPlugin<OptionsType>, options: OptionsType): Promise<void>;
-    emit<K extends CoordinatorPluginEventKey>(event: K, value: CoordinatorPluginEventValues[K]): void;
-    transform<K extends CoordinatorPluginTransformEventKey>(event: K, value: CoordinatorPluginEventValues[K]): Promise<CoordinatorPluginEventValues[K]>;
+    private registerHandler;
+    private registerTransformer;
+    initFormatter<OptionsType>(plugin: FormatterPlugin<OptionsType>, options: OptionsType, stream: NodeJS.WritableStream, write: (buffer: string | Uint8Array) => void, directory?: string, specifier?: string): Promise<void>;
+    initCoordinator<OptionsType>(operation: PluginOperation, plugin: Plugin<OptionsType>, options: OptionsType, specifier?: string): Promise<void>;
+    emit<K extends CoordinatorEventKey>(event: K, value: CoordinatorEventValues[K]): void;
+    transform<K extends CoordinatorTransformKey>(event: K, value: CoordinatorTransformValues[K]): Promise<CoordinatorTransformValues[K]>;
     cleanup(): Promise<void>;
 }

package/lib/plugin/plugin_manager.js

@@ -6,6 +6,8 @@ class PluginManager {
     handlers = {
         message: [],
         'paths:resolve': [],
+    };
+    transformers = {
         'pickles:filter': [],
         'pickles:order': [],
     };
@@ -13,12 +15,27 @@ class PluginManager {
     constructor(environment) {
         this.environment = environment;
     }
-    async register(event, handler) {
-        this.handlers[event]?.push(handler);
+    async registerHandler(event, handler, specifier) {
+        if (!this.handlers[event]) {
+            throw new Error(`Cannot register handler for unknown event "${event}"`);
+        }
+        this.handlers[event].push({
+            handler,
+            specifier,
+        });
     }
-    async initFormatter(plugin, options, stream, write, directory) {
+    async registerTransformer(event, transformer, specifier) {
+        if (!this.transformers[event]) {
+            throw new Error(`Cannot register transformer for unknown event "${event}"`);
+        }
+        this.transformers[event].push({
+            transformer,
+            specifier,
+        });
+    }
+    async initFormatter(plugin, options, stream, write, directory, specifier) {
         const cleanupFn = await plugin.formatter({
-            on: (key, handler) => this.register(key, handler),
+            on: (key, handler) => this.registerHandler(key, handler, specifier),
             options: plugin.optionsKey
                 ? (options[plugin.optionsKey] ?? {})
                 : options,
@@ -28,32 +45,44 @@ class PluginManager {
             directory,
         });
         if (typeof cleanupFn === 'function') {
-            this.cleanupFns.push(cleanupFn);
+            this.cleanupFns.push({
+                cleanupFn: cleanupFn,
+                specifier,
+            });
         }
     }
-    async initCoordinator(operation, plugin, options) {
-        const cleanupFn = await plugin.coordinator({
+    async initCoordinator(operation, plugin, options, specifier) {
+        const context = {
             operation,
-            on: this.register.bind(this),
-            options,
+            on: (event, handler) => this.registerHandler(event, handler, specifier),
+            transform: (event, transformer) => this.registerTransformer(event, transformer, specifier),
+            options: 'optionsKey' in plugin && plugin.optionsKey
+                ? (options[plugin.optionsKey] ?? {})
+                : options,
             logger: this.environment.logger,
             environment: {
                 cwd: this.environment.cwd,
                 stderr: this.environment.stderr,
                 env: { ...this.environment.env },
             },
-        });
+        };
+        const cleanupFn = await wrapErrorAsync(async () => await plugin.coordinator(context), specifier, `Plugin "${specifier}" errored when trying to init`);
         if (typeof cleanupFn === 'function') {
-            this.cleanupFns.push(cleanupFn);
+            this.cleanupFns.push({
+                cleanupFn: cleanupFn,
+                specifier,
+            });
         }
     }
     emit(event, value) {
-        this.handlers[event].forEach((handler) => handler(value));
+        this.handlers[event].forEach(({ handler, specifier }) => {
+            wrapError(() => handler(value), specifier, `Plugin "${specifier}" errored when trying to handle a "${event}" event`);
+        });
     }
     async transform(event, value) {
         let transformed = value;
-        for (const handler of this.handlers[event]) {
-            const returned = await handler(transformed);
+        for (const { transformer, specifier } of this.transformers[event]) {
+            const returned = await wrapErrorAsync(async () => await transformer(transformed), specifier, `Plugin "${specifier}" errored when trying to do a "${event}" transform`);
             if (typeof returned !== 'undefined') {
                 transformed = returned;
             }
@@ -61,10 +90,32 @@ class PluginManager {
         return transformed;
     }
     async cleanup() {
-        for (const cleanupFn of this.cleanupFns) {
-            await cleanupFn();
+        for (const { cleanupFn, specifier } of this.cleanupFns) {
+            await wrapErrorAsync(async () => await cleanupFn(), specifier, `Plugin "${specifier}" errored when trying to cleanup`);
         }
     }
 }
 exports.PluginManager = PluginManager;
+function wrapError(fn, specifier, message) {
+    try {
+        return fn();
+    }
+    catch (error) {
+        if (specifier) {
+            throw new Error(message, { cause: error });
+        }
+        throw error;
+    }
+}
+async function wrapErrorAsync(fn, specifier, message) {
+    try {
+        return await fn();
+    }
+    catch (error) {
+        if (specifier) {
+            throw new Error(message, { cause: error });
+        }
+        throw error;
+    }
+}
 //# sourceMappingURL=plugin_manager.js.map

package/lib/plugin/plugin_manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin_manager.js","sourceRoot":"","sources":["../../src/plugin/plugin_manager.ts"],"names":[],"mappings":";;;AAgBA,MAAa,aAAa;IASK;IARrB,QAAQ,GAAoB;QAClC,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,EAAE;QACnB,gBAAgB,EAAE,EAAE;QACpB,eAAe,EAAE,EAAE;KACpB,CAAA;IACO,UAAU,GAAoB,EAAE,CAAA;IAExC,YAA6B,WAA8B;QAA9B,gBAAW,GAAX,WAAW,CAAmB;IAAG,CAAC;IAEvD,KAAK,CAAC,QAAQ,CACpB,KAAQ,EACR,OAAyC;QAEzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAoC,EACpC,OAAoB,EACpB,MAA6B,EAC7B,KAA4C,EAC5C,SAAkB;QAElB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC;YACvC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;YACjD,OAAO,EAAE,MAAM,CAAC,UAAU;gBACxB,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,MAAM;YACN,KAAK;YACL,SAAS;SACV,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,SAAoB,EACpB,MAAmC,EACnC,OAAoB;QAEpB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;YACzC,SAAS;YACT,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,OAAO;YACP,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,WAAW,EAAE;gBACX,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;aACjC;SACF,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,IAAI,CACF,KAAQ,EACR,KAAsC;QAEtC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,SAAS,CACb,KAAQ,EACR,KAAsC;QAEtC,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;YAC3C,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACpC,WAAW,GAAG,QAAQ,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,SAAS,EAAE,CAAA;QACnB,CAAC;IACH,CAAC;CACF;AAvFD,sCAuFC","sourcesContent":["import { UsableEnvironment } from '../environment'\nimport {\n  CoordinatorPluginEventHandler,\n  InternalPlugin,\n  PluginCleanup,\n  CoordinatorPluginEventValues,\n  CoordinatorPluginEventKey,\n  CoordinatorPluginTransformEventKey,\n  Operation,\n  FormatterPlugin,\n} from './types'\n\ntype HandlerRegistry = {\n  [K in CoordinatorPluginEventKey]: Array<CoordinatorPluginEventHandler<K>>\n}\n\nexport class PluginManager {\n  private handlers: HandlerRegistry = {\n    message: [],\n    'paths:resolve': [],\n    'pickles:filter': [],\n    'pickles:order': [],\n  }\n  private cleanupFns: PluginCleanup[] = []\n\n  constructor(private readonly environment: UsableEnvironment) {}\n\n  private async register<K extends CoordinatorPluginEventKey>(\n    event: K,\n    handler: CoordinatorPluginEventHandler<K>\n  ) {\n    this.handlers[event]?.push(handler)\n  }\n\n  async initFormatter<OptionsType>(\n    plugin: FormatterPlugin<OptionsType>,\n    options: OptionsType,\n    stream: NodeJS.WritableStream,\n    write: (buffer: string | Uint8Array) => void,\n    directory?: string\n  ) {\n    const cleanupFn = await plugin.formatter({\n      on: (key, handler) => this.register(key, handler),\n      options: plugin.optionsKey\n        ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n        : options,\n      logger: this.environment.logger,\n      stream,\n      write,\n      directory,\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push(cleanupFn)\n    }\n  }\n\n  async initCoordinator<OptionsType>(\n    operation: Operation,\n    plugin: InternalPlugin<OptionsType>,\n    options: OptionsType\n  ) {\n    const cleanupFn = await plugin.coordinator({\n      operation,\n      on: this.register.bind(this),\n      options,\n      logger: this.environment.logger,\n      environment: {\n        cwd: this.environment.cwd,\n        stderr: this.environment.stderr,\n        env: { ...this.environment.env },\n      },\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push(cleanupFn)\n    }\n  }\n\n  emit<K extends CoordinatorPluginEventKey>(\n    event: K,\n    value: CoordinatorPluginEventValues[K]\n  ): void {\n    this.handlers[event].forEach((handler) => handler(value))\n  }\n\n  async transform<K extends CoordinatorPluginTransformEventKey>(\n    event: K,\n    value: CoordinatorPluginEventValues[K]\n  ): Promise<CoordinatorPluginEventValues[K]> {\n    let transformed = value\n    for (const handler of this.handlers[event]) {\n      const returned = await handler(transformed)\n      if (typeof returned !== 'undefined') {\n        transformed = returned\n      }\n    }\n    return transformed\n  }\n\n  async cleanup(): Promise<void> {\n    for (const cleanupFn of this.cleanupFns) {\n      await cleanupFn()\n    }\n  }\n}\n"]}
+{"version":3,"file":"plugin_manager.js","sourceRoot":"","sources":["../../src/plugin/plugin_manager.ts"],"names":[],"mappings":";;;AAqCA,MAAa,aAAa;IAWK;IAVZ,QAAQ,GAAoB;QAC3C,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,EAAE;KACpB,CAAA;IACgB,YAAY,GAAwB;QACnD,gBAAgB,EAAE,EAAE;QACpB,eAAe,EAAE,EAAE;KACpB,CAAA;IACO,UAAU,GAAqB,EAAE,CAAA;IAEzC,YAA6B,WAA8B;QAA9B,gBAAW,GAAX,WAAW,CAAmB;IAAG,CAAC;IAEvD,KAAK,CAAC,eAAe,CAC3B,KAAQ,EACR,OAAmC,EACnC,SAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,8CAA8C,KAAK,GAAG,CAAC,CAAA;QACzE,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACxB,OAAO;YACP,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,KAAQ,EACR,WAAsC,EACtC,SAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,kDAAkD,KAAK,GAAG,CAC3D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YAC5B,WAAW;YACX,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,MAAoC,EACpC,OAAoB,EACpB,MAA6B,EAC7B,KAA4C,EAC5C,SAAkB,EAClB,SAAkB;QAElB,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC;YACvC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC;YACnE,OAAO,EAAE,MAAM,CAAC,UAAU;gBACxB,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,MAAM;YACN,KAAK;YACL,SAAS;SACV,CAAC,CAAA;QACF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBACnB,SAAS,EAAE,SAAS;gBACpB,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,SAA0B,EAC1B,MAA2B,EAC3B,OAAoB,EACpB,SAAkB;QAElB,MAAM,OAAO,GAAG;YACd,SAAS;YACT,EAAE,EAAE,CACF,KAAQ,EACR,OAAmC,EACnC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC;YACpD,SAAS,EAAE,CACT,KAAQ,EACR,WAAsC,EACtC,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC;YAC5D,OAAO,EACL,YAAY,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU;gBACzC,CAAC,CAAC,CAAE,OAAe,CAAC,MAAM,CAAC,UAAU,CAAC,IAAK,EAAkB,CAAC;gBAC9D,CAAC,CAAC,OAAO;YACb,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC/B,WAAW,EAAE;gBACX,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;aACjC;SACF,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,cAAc,CACpC,KAAK,IAAI,EAAE,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAC7C,SAAS,EACT,WAAW,SAAS,+BAA+B,CACpD,CAAA;QACD,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBACnB,SAAS,EAAE,SAAS;gBACpB,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CACF,KAAQ,EACR,KAAgC;QAEhC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;YACtD,SAAS,CACP,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EACpB,SAAS,EACT,WAAW,SAAS,sCAAsC,KAAK,SAAS,CACzE,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CACb,KAAQ,EACR,KAAoC;QAEpC,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,KAAK,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAClE,MAAM,QAAQ,GAAG,MAAM,cAAc,CACnC,KAAK,IAAI,EAAE,CAAC,MAAM,WAAW,CAAC,WAAW,CAAC,EAC1C,SAAS,EACT,WAAW,SAAS,kCAAkC,KAAK,aAAa,CACzE,CAAA;YACD,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACpC,WAAW,GAAG,QAAQ,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,KAAK,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvD,MAAM,cAAc,CAClB,KAAK,IAAI,EAAE,CAAC,MAAM,SAAS,EAAE,EAC7B,SAAS,EACT,WAAW,SAAS,kCAAkC,CACvD,CAAA;QACH,CAAC;IACH,CAAC;CACF;AArJD,sCAqJC;AAED,SAAS,SAAS,CAAI,EAAW,EAAE,SAAiB,EAAE,OAAe;IACnE,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,EAAoB,EACpB,SAAiB,EACjB,OAAe;IAEf,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC","sourcesContent":["import { UsableEnvironment } from '../environment'\nimport {\n  CoordinatorEventHandler,\n  CoordinatorEventKey,\n  CoordinatorEventValues,\n  CoordinatorTransformer,\n  CoordinatorTransformKey,\n  CoordinatorTransformValues,\n  FormatterPlugin,\n  Plugin,\n  PluginCleanup,\n  PluginOperation,\n} from './types'\n\ntype SourcedEventHandler<K extends CoordinatorEventKey> = {\n  handler: CoordinatorEventHandler<K>\n  specifier?: string\n}\n\ntype SourcedTransformer<K extends CoordinatorTransformKey> = {\n  transformer: CoordinatorTransformer<K>\n  specifier?: string\n}\n\ntype SourcedCleanup = {\n  cleanupFn: PluginCleanup\n  specifier?: string\n}\n\ntype HandlerRegistry = {\n  [K in CoordinatorEventKey]: Array<SourcedEventHandler<K>>\n}\n\ntype TransformerRegistry = {\n  [K in CoordinatorTransformKey]: Array<SourcedTransformer<K>>\n}\n\nexport class PluginManager {\n  private readonly handlers: HandlerRegistry = {\n    message: [],\n    'paths:resolve': [],\n  }\n  private readonly transformers: TransformerRegistry = {\n    'pickles:filter': [],\n    'pickles:order': [],\n  }\n  private cleanupFns: SourcedCleanup[] = []\n\n  constructor(private readonly environment: UsableEnvironment) {}\n\n  private async registerHandler<K extends CoordinatorEventKey>(\n    event: K,\n    handler: CoordinatorEventHandler<K>,\n    specifier?: string\n  ) {\n    if (!this.handlers[event]) {\n      throw new Error(`Cannot register handler for unknown event \"${event}\"`)\n    }\n    this.handlers[event].push({\n      handler,\n      specifier,\n    })\n  }\n\n  private async registerTransformer<K extends CoordinatorTransformKey>(\n    event: K,\n    transformer: CoordinatorTransformer<K>,\n    specifier?: string\n  ) {\n    if (!this.transformers[event]) {\n      throw new Error(\n        `Cannot register transformer for unknown event \"${event}\"`\n      )\n    }\n    this.transformers[event].push({\n      transformer,\n      specifier,\n    })\n  }\n\n  async initFormatter<OptionsType>(\n    plugin: FormatterPlugin<OptionsType>,\n    options: OptionsType,\n    stream: NodeJS.WritableStream,\n    write: (buffer: string | Uint8Array) => void,\n    directory?: string,\n    specifier?: string\n  ) {\n    const cleanupFn = await plugin.formatter({\n      on: (key, handler) => this.registerHandler(key, handler, specifier),\n      options: plugin.optionsKey\n        ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n        : options,\n      logger: this.environment.logger,\n      stream,\n      write,\n      directory,\n    })\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push({\n        cleanupFn: cleanupFn,\n        specifier,\n      })\n    }\n  }\n\n  async initCoordinator<OptionsType>(\n    operation: PluginOperation,\n    plugin: Plugin<OptionsType>,\n    options: OptionsType,\n    specifier?: string\n  ) {\n    const context = {\n      operation,\n      on: <K extends CoordinatorEventKey>(\n        event: K,\n        handler: CoordinatorEventHandler<K>\n      ) => this.registerHandler(event, handler, specifier),\n      transform: <K extends CoordinatorTransformKey>(\n        event: K,\n        transformer: CoordinatorTransformer<K>\n      ) => this.registerTransformer(event, transformer, specifier),\n      options:\n        'optionsKey' in plugin && plugin.optionsKey\n          ? ((options as any)[plugin.optionsKey] ?? ({} as OptionsType))\n          : options,\n      logger: this.environment.logger,\n      environment: {\n        cwd: this.environment.cwd,\n        stderr: this.environment.stderr,\n        env: { ...this.environment.env },\n      },\n    }\n    const cleanupFn = await wrapErrorAsync(\n      async () => await plugin.coordinator(context),\n      specifier,\n      `Plugin \"${specifier}\" errored when trying to init`\n    )\n    if (typeof cleanupFn === 'function') {\n      this.cleanupFns.push({\n        cleanupFn: cleanupFn,\n        specifier,\n      })\n    }\n  }\n\n  emit<K extends CoordinatorEventKey>(\n    event: K,\n    value: CoordinatorEventValues[K]\n  ): void {\n    this.handlers[event].forEach(({ handler, specifier }) => {\n      wrapError(\n        () => handler(value),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to handle a \"${event}\" event`\n      )\n    })\n  }\n\n  async transform<K extends CoordinatorTransformKey>(\n    event: K,\n    value: CoordinatorTransformValues[K]\n  ): Promise<CoordinatorTransformValues[K]> {\n    let transformed = value\n    for (const { transformer, specifier } of this.transformers[event]) {\n      const returned = await wrapErrorAsync(\n        async () => await transformer(transformed),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to do a \"${event}\" transform`\n      )\n      if (typeof returned !== 'undefined') {\n        transformed = returned\n      }\n    }\n    return transformed\n  }\n\n  async cleanup(): Promise<void> {\n    for (const { cleanupFn, specifier } of this.cleanupFns) {\n      await wrapErrorAsync(\n        async () => await cleanupFn(),\n        specifier,\n        `Plugin \"${specifier}\" errored when trying to cleanup`\n      )\n    }\n  }\n}\n\nfunction wrapError<T>(fn: () => T, specifier: string, message: string): T {\n  try {\n    return fn()\n  } catch (error) {\n    if (specifier) {\n      throw new Error(message, { cause: error })\n    }\n    throw error\n  }\n}\n\nasync function wrapErrorAsync<T>(\n  fn: () => Promise<T>,\n  specifier: string,\n  message: string\n): Promise<T> {\n  try {\n    return await fn()\n  } catch (error) {\n    if (specifier) {\n      throw new Error(message, { cause: error })\n    }\n    throw error\n  }\n}\n"]}

package/lib/plugin/types.d.ts

@@ -1,53 +1,141 @@
+import { Writable } from 'node:stream';
 import { Envelope } from '@cucumber/messages';
-import { ArrayValues, Promisable } from 'type-fest';
-import { IRunEnvironment } from '../environment';
 import { ILogger } from '../environment';
 import { IFilterablePickle } from '../filter';
 import { IResolvedPaths } from '../paths';
-import { coordinatorTransformKeys, coordinatorVoidKeys } from './events';
-export type Operation = 'loadSources' | 'loadSupport' | 'runCucumber';
-export type CoordinatorPluginEnvironment = Required<Pick<IRunEnvironment, 'cwd' | 'stderr' | 'env'>>;
-export type CoordinatorPluginVoidEventKey = ArrayValues<typeof coordinatorVoidKeys>;
-export type CoordinatorPluginTransformEventKey = ArrayValues<typeof coordinatorTransformKeys>;
-export type CoordinatorPluginEventKey = CoordinatorPluginVoidEventKey | CoordinatorPluginTransformEventKey;
-export type CoordinatorPluginEventValues = {
+/**
+ * The operation Cucumber is doing in this process
+ * @public
+ * @remarks
+ * `loadSources` and `loadSupport` are generally used as preflight operations
+ * for complex use cases. `runCucumber` is the one where tests are actually
+ * executed.
+ */
+export type PluginOperation = 'loadSources' | 'loadSupport' | 'runCucumber';
+/**
+ * Subset of the environment available to plugins
+ * @public
+ */
+export type CoordinatorEnvironment = {
+    /**
+     * Working directory for the project
+     */
+    cwd: string;
+    /**
+     * Writable stream where the test run's warning/error output is written
+     * and plugins can write to directly if required
+     */
+    stderr: Writable;
+    /**
+     * Environment variables
+     */
+    env: Record<string, string | undefined>;
+};
+/**
+ * Keys for event handlers that plugins can register
+ * @public
+ */
+export type CoordinatorEventKey = 'message' | 'paths:resolve';
+/**
+ * Keys for transforms that plugins can register
+ * @public
+ */
+export type CoordinatorTransformKey = 'pickles:filter' | 'pickles:order';
+/**
+ * Mapping of event keys to their value types
+ * @public
+ */
+export type CoordinatorEventValues = {
     message: Readonly<Envelope>;
     'paths:resolve': Readonly<IResolvedPaths>;
+};
+/**
+ * Mapping of transform keys to their value types
+ * @public
+ */
+export type CoordinatorTransformValues = {
     'pickles:filter': Readonly<Array<IFilterablePickle>>;
     'pickles:order': Readonly<Array<IFilterablePickle>>;
 };
-export type CoordinatorPluginEventHandler<K extends CoordinatorPluginEventKey> = (value: CoordinatorPluginEventValues[K]) => K extends CoordinatorPluginTransformEventKey ? Promisable<CoordinatorPluginEventValues[K]> : void;
-export interface CoordinatorPluginContext<OptionsType> {
-    operation: Operation;
-    on: <EventKey extends CoordinatorPluginEventKey>(event: EventKey, handler: CoordinatorPluginEventHandler<EventKey>) => void;
+/**
+ * Handler function for a coordinator event
+ * @public
+ * @remarks
+ * You can do async work here, but Cucumber will not await the Promise.
+ */
+export type CoordinatorEventHandler<K extends CoordinatorEventKey> = (value: CoordinatorEventValues[K]) => void;
+/**
+ * Transformer function for a coordinator transform
+ * @remarks
+ * Don't try to modify the original value. Return a transformed value, or
+ * `undefined` to pass through unchanged.
+ * @public
+ */
+export type CoordinatorTransformer<K extends CoordinatorTransformKey> = (value: CoordinatorTransformValues[K]) => PromiseLike<CoordinatorTransformValues[K]> | CoordinatorTransformValues[K];
+/**
+ * Context object passed to a plugin's coordinator function
+ * @public
+ */
+export type CoordinatorContext<OptionsType> = {
+    /**
+     * The operation Cucumber is doing in this process
+     */
+    operation: PluginOperation;
+    /**
+     * Register an event handler
+     */
+    on: <EventKey extends CoordinatorEventKey>(event: EventKey, handler: CoordinatorEventHandler<EventKey>) => void;
+    /**
+     * Register a transformer
+     */
+    transform: <EventKey extends CoordinatorTransformKey>(event: EventKey, handler: CoordinatorTransformer<EventKey>) => void;
+    /**
+     * Options for the plugin
+     */
     options: OptionsType;
+    /**
+     * Logger for emitting user-facing messages or diagnostics
+     */
     logger: ILogger;
-    environment: CoordinatorPluginEnvironment;
-}
-export type CoordinatorPluginFunction<OptionsType> = (context: CoordinatorPluginContext<OptionsType>) => Promisable<PluginCleanup | void>;
-export type PluginCleanup = () => Promisable<void>;
-/**
- * A plugin to implement Cucumber built-in functionality.
- *
- * Uses the same events and mechanisms as user-authored plugins, but is free to require configuration and context from
- * inside of Cucumber as its `options`, whereas user-authored plugins will be limited to `pluginOptions` from the
- * project configuration.
- */
-export interface InternalPlugin<OptionsType = any> {
+    /**
+     * Subset of the environment
+     */
+    environment: CoordinatorEnvironment;
+};
+/**
+ * Optional cleanup function returned by a plugin coordinator
+ * @public
+ */
+export type PluginCleanup = () => PromiseLike<void> | void;
+/**
+ * A plugin that can subscribe to events and register transforms
+ * @public
+ */
+export type Plugin<OptionsType = any> = {
     type: 'plugin';
-    coordinator: CoordinatorPluginFunction<OptionsType>;
-}
-export interface FormatterPluginContext<OptionsType> {
+    /**
+     * Coordinator function called during initialization
+     * @remarks
+     * Can do async work, and the Promise will be awaited. Can optionally return
+     * a cleanup function to be called when Cucumber is about to exit.
+     */
+    coordinator: (context: CoordinatorContext<OptionsType>) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
+    /**
+     * Optional key to extract plugin-specific options from the root options object
+     */
+    optionsKey?: string;
+};
+export type FormatterPluginContext<OptionsType> = {
     on: (key: 'message', handler: (value: Envelope) => void) => void;
     options: OptionsType;
     logger: ILogger;
     stream: NodeJS.WritableStream;
     write: (buffer: string | Uint8Array) => void;
     directory?: string;
-}
-export type FormatterPluginFunction<OptionsType> = (context: FormatterPluginContext<OptionsType>) => Promisable<PluginCleanup | void>;
-export interface FormatterPlugin<OptionsType = any> {
+};
+export type FormatterPluginFunction<OptionsType> = (context: FormatterPluginContext<OptionsType>) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
+export type FormatterPlugin<OptionsType = any> = {
     type: 'formatter';
     formatter: FormatterPluginFunction<OptionsType>;
     optionsKey?: string;
-}
+};

package/lib/plugin/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Envelope } from '@cucumber/messages'\nimport { ArrayValues, Promisable } from 'type-fest'\nimport { IRunEnvironment } from '../environment'\nimport { ILogger } from '../environment'\nimport { IFilterablePickle } from '../filter'\nimport { IResolvedPaths } from '../paths'\nimport { coordinatorTransformKeys, coordinatorVoidKeys } from './events'\n\nexport type Operation = 'loadSources' | 'loadSupport' | 'runCucumber'\n\nexport type CoordinatorPluginEnvironment = Required<\n  Pick<IRunEnvironment, 'cwd' | 'stderr' | 'env'>\n>\n\nexport type CoordinatorPluginVoidEventKey = ArrayValues<\n  typeof coordinatorVoidKeys\n>\nexport type CoordinatorPluginTransformEventKey = ArrayValues<\n  typeof coordinatorTransformKeys\n>\nexport type CoordinatorPluginEventKey =\n  | CoordinatorPluginVoidEventKey\n  | CoordinatorPluginTransformEventKey\n\nexport type CoordinatorPluginEventValues = {\n  // void\n  message: Readonly<Envelope>\n  'paths:resolve': Readonly<IResolvedPaths>\n  // transform\n  'pickles:filter': Readonly<Array<IFilterablePickle>>\n  'pickles:order': Readonly<Array<IFilterablePickle>>\n}\n\nexport type CoordinatorPluginEventHandler<K extends CoordinatorPluginEventKey> =\n  (\n    value: CoordinatorPluginEventValues[K]\n  ) => K extends CoordinatorPluginTransformEventKey\n    ? Promisable<CoordinatorPluginEventValues[K]>\n    : void\n\nexport interface CoordinatorPluginContext<OptionsType> {\n  operation: Operation\n  on: <EventKey extends CoordinatorPluginEventKey>(\n    event: EventKey,\n    handler: CoordinatorPluginEventHandler<EventKey>\n  ) => void\n  options: OptionsType\n  logger: ILogger\n  environment: CoordinatorPluginEnvironment\n}\n\nexport type CoordinatorPluginFunction<OptionsType> = (\n  context: CoordinatorPluginContext<OptionsType>\n) => Promisable<PluginCleanup | void>\n\nexport type PluginCleanup = () => Promisable<void>\n\n/**\n * A plugin to implement Cucumber built-in functionality.\n *\n * Uses the same events and mechanisms as user-authored plugins, but is free to require configuration and context from\n * inside of Cucumber as its `options`, whereas user-authored plugins will be limited to `pluginOptions` from the\n * project configuration.\n */\nexport interface InternalPlugin<OptionsType = any> {\n  type: 'plugin'\n  coordinator: CoordinatorPluginFunction<OptionsType>\n}\n\nexport interface FormatterPluginContext<OptionsType> {\n  on: (key: 'message', handler: (value: Envelope) => void) => void\n  options: OptionsType\n  logger: ILogger\n  stream: NodeJS.WritableStream\n  write: (buffer: string | Uint8Array) => void\n  directory?: string\n}\n\nexport type FormatterPluginFunction<OptionsType> = (\n  context: FormatterPluginContext<OptionsType>\n) => Promisable<PluginCleanup | void>\n\nexport interface FormatterPlugin<OptionsType = any> {\n  type: 'formatter'\n  formatter: FormatterPluginFunction<OptionsType>\n  optionsKey?: string\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Writable } from 'node:stream'\nimport { Envelope } from '@cucumber/messages'\nimport { ILogger } from '../environment'\nimport { IFilterablePickle } from '../filter'\nimport { IResolvedPaths } from '../paths'\n\n/**\n * The operation Cucumber is doing in this process\n * @public\n * @remarks\n * `loadSources` and `loadSupport` are generally used as preflight operations\n * for complex use cases. `runCucumber` is the one where tests are actually\n * executed.\n */\nexport type PluginOperation = 'loadSources' | 'loadSupport' | 'runCucumber'\n\n/**\n * Subset of the environment available to plugins\n * @public\n */\nexport type CoordinatorEnvironment = {\n  /**\n   * Working directory for the project\n   */\n  cwd: string\n  /**\n   * Writable stream where the test run's warning/error output is written\n   * and plugins can write to directly if required\n   */\n  stderr: Writable\n  /**\n   * Environment variables\n   */\n  env: Record<string, string | undefined>\n}\n\n/**\n * Keys for event handlers that plugins can register\n * @public\n */\nexport type CoordinatorEventKey = 'message' | 'paths:resolve'\n\n/**\n * Keys for transforms that plugins can register\n * @public\n */\nexport type CoordinatorTransformKey = 'pickles:filter' | 'pickles:order'\n\n/**\n * Mapping of event keys to their value types\n * @public\n */\nexport type CoordinatorEventValues = {\n  message: Readonly<Envelope>\n  'paths:resolve': Readonly<IResolvedPaths>\n}\n\n/**\n * Mapping of transform keys to their value types\n * @public\n */\nexport type CoordinatorTransformValues = {\n  'pickles:filter': Readonly<Array<IFilterablePickle>>\n  'pickles:order': Readonly<Array<IFilterablePickle>>\n}\n\n/**\n * Handler function for a coordinator event\n * @public\n * @remarks\n * You can do async work here, but Cucumber will not await the Promise.\n */\nexport type CoordinatorEventHandler<K extends CoordinatorEventKey> = (\n  value: CoordinatorEventValues[K]\n) => void\n\n/**\n * Transformer function for a coordinator transform\n * @remarks\n * Don't try to modify the original value. Return a transformed value, or\n * `undefined` to pass through unchanged.\n * @public\n */\nexport type CoordinatorTransformer<K extends CoordinatorTransformKey> = (\n  value: CoordinatorTransformValues[K]\n) => PromiseLike<CoordinatorTransformValues[K]> | CoordinatorTransformValues[K]\n\n/**\n * Context object passed to a plugin's coordinator function\n * @public\n */\nexport type CoordinatorContext<OptionsType> = {\n  /**\n   * The operation Cucumber is doing in this process\n   */\n  operation: PluginOperation\n  /**\n   * Register an event handler\n   */\n  on: <EventKey extends CoordinatorEventKey>(\n    event: EventKey,\n    handler: CoordinatorEventHandler<EventKey>\n  ) => void\n  /**\n   * Register a transformer\n   */\n  transform: <EventKey extends CoordinatorTransformKey>(\n    event: EventKey,\n    handler: CoordinatorTransformer<EventKey>\n  ) => void\n  /**\n   * Options for the plugin\n   */\n  options: OptionsType\n  /**\n   * Logger for emitting user-facing messages or diagnostics\n   */\n  logger: ILogger\n  /**\n   * Subset of the environment\n   */\n  environment: CoordinatorEnvironment\n}\n\n/**\n * Optional cleanup function returned by a plugin coordinator\n * @public\n */\nexport type PluginCleanup = () => PromiseLike<void> | void\n\n/**\n * A plugin that can subscribe to events and register transforms\n * @public\n */\nexport type Plugin<OptionsType = any> = {\n  type: 'plugin'\n  /**\n   * Coordinator function called during initialization\n   * @remarks\n   * Can do async work, and the Promise will be awaited. Can optionally return\n   * a cleanup function to be called when Cucumber is about to exit.\n   */\n  coordinator: (\n    context: CoordinatorContext<OptionsType>\n  ) => PromiseLike<PluginCleanup | void> | PluginCleanup | void\n  /**\n   * Optional key to extract plugin-specific options from the root options object\n   */\n  optionsKey?: string\n}\n\nexport type FormatterPluginContext<OptionsType> = {\n  on: (key: 'message', handler: (value: Envelope) => void) => void\n  options: OptionsType\n  logger: ILogger\n  stream: NodeJS.WritableStream\n  write: (buffer: string | Uint8Array) => void\n  directory?: string\n}\n\nexport type FormatterPluginFunction<OptionsType> = (\n  context: FormatterPluginContext<OptionsType>\n) => PromiseLike<PluginCleanup | void> | PluginCleanup | void\n\nexport type FormatterPlugin<OptionsType = any> = {\n  type: 'formatter'\n  formatter: FormatterPluginFunction<OptionsType>\n  optionsKey?: string\n}\n"]}

package/lib/publish/publish_plugin.d.ts

@@ -1,3 +1,2 @@
-import { InternalPlugin } from '../plugin';
-import { IPublishConfig } from './types';
-export declare const publishPlugin: InternalPlugin<IPublishConfig | false>;
+import { Plugin } from '../plugin';
+export declare const publishPlugin: Plugin;