@cucumber/cucumber 10.1.0 → 10.3.0

package/lib/configuration/parse_configuration.js

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

package/lib/configuration/parse_configuration.js.map

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

package/lib/configuration/types.d.ts

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

package/lib/configuration/types.js.map

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

package/lib/filter/types.d.ts

@@ -1,4 +1,12 @@
 import { GherkinDocument, Location, Pickle } from '@cucumber/messages';
+/**
+ * The ordering strategy for pickles
+ * @public
+ * @example "defined"
+ * @example "random"
+ * @example "random:234119"
+ */
+export type IPickleOrder = 'defined' | '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\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 \"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"]}

package/lib/formatter/builder.d.ts

@@ -4,7 +4,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'node:events';
 import { Writable as WritableStream } from 'node:stream';
-import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import { SupportCodeLibrary } from '../support_code_library_builder/types';
 import { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax';
 import EventDataCollector from './helpers/event_data_collector';
 import StepDefinitionSnippetBuilder from './step_definition_snippet_builder';
@@ -13,7 +13,7 @@ interface IGetStepDefinitionSnippetBuilderOptions {
     cwd: string;
     snippetInterface?: SnippetInterface;
     snippetSyntax?: string;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
 }
 export interface IBuildOptions {
     env: NodeJS.ProcessEnv;
@@ -24,7 +24,7 @@ export interface IBuildOptions {
     parsedArgvOptions: FormatOptions;
     stream: WritableStream;
     cleanup: IFormatterCleanupFn;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
 }
 declare const FormatterBuilder: {
     build(type: string, options: IBuildOptions): Promise<Formatter>;

package/lib/formatter/builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../src/formatter/builder.ts"],"names":[],"mappings":";;;;;AAAA,0DAA4B;AAG5B,uCAAwC;AACxC,oDAAkE;AAElE,qFAAmF;AAEnF,wGAA4E;AAC5E,4HAAiG;AACjG,oEAAyC;AACzC,sEAA6C;AA0B7C,MAAM,gBAAgB,GAAG;IACvB,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAAsB;QAC9C,MAAM,oBAAoB,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,CACtE,IAAI,EACJ,OAAO,CAAC,GAAG,CACZ,CAAA;QACD,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAC1B,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,GAAG,EACX,OAAO,CAAC,iBAAiB,CAAC,aAAa,CACxC,CAAA;QACD,MAAM,cAAc,GAClB,MAAM,gBAAgB,CAAC,+BAA+B,CAAC;YACrD,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,gBAAgB,EAAE,OAAO,CAAC,iBAAiB,CAAC,gBAAgB;YAC5D,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,aAAa;YACtD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC,CAAA;QACJ,OAAO,IAAI,oBAAoB,CAAC;YAC9B,QAAQ;YACR,cAAc;YACd,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,IAAY,EACZ,GAAW;QAEX,MAAM,UAAU,GACd,oBAAU,CAAC,aAAa,EAAE,CAAA;QAE5B,OAAO,UAAU,CAAC,IAAI,CAAC;YACrB,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAClB,CAAC,CAAC,MAAM,gBAAgB,CAAC,eAAe,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,+BAA+B,CAAC,EACpC,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GACsB;QACxC,IAAI,IAAA,gCAAgB,EAAC,gBAAgB,CAAC,EAAE;YACtC,gBAAgB,GAAG,iCAAgB,CAAC,WAAW,CAAA;SAChD;QACD,IAAI,MAAM,GAAG,mCAAuB,CAAA;QACpC,IAAI,IAAA,6BAAa,EAAC,aAAa,CAAC,EAAE;YAChC,MAAM,GAAG,MAAM,gBAAgB,CAAC,eAAe,CAC7C,QAAQ,EACR,aAAa,EACb,GAAG,CACJ,CAAA;SACF;QACD,OAAO,IAAI,yCAA4B,CAAC;YACtC,aAAa,EAAE,IAAI,MAAM,CAAC,gBAAgB,CAAC;YAC3C,qBAAqB,EAAE,kBAAkB,CAAC,qBAAqB;SAChE,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAA4B,EAC5B,UAAkB,EAClB,GAAW;QAEX,IAAI,UAAU,GAAiB,UAAU,CAAA;QACzC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,UAAU,GAAG,IAAA,wBAAa,EAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAA;SAC1D;aAAM,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC3C,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;SACjC;QACD,IAAI,WAAW,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC7D,WAAW,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;QAC9D,IAAI,IAAA,6BAAa,EAAC,WAAW,CAAC,EAAE;YAC9B,OAAO,WAAW,CAAA;SACnB;aAAM;YACL,MAAM,IAAI,KAAK,CACb,UAAU,IAAI,KAAK,UAAU,oCAAoC,CAClE,CAAA;SACF;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,SAAuB;QACpC,OAAO,MAAM,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,kBAAkB,CAAC,YAAiB;QAClC,IAAI,IAAA,gCAAgB,EAAC,YAAY,CAAC,EAAE;YAClC,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;YACtC,OAAO,YAAY,CAAA;SACpB;aAAM,IACL,OAAO,YAAY,KAAK,QAAQ;YAChC,OAAO,YAAY,CAAC,OAAO,KAAK,UAAU,EAC1C;YACA,OAAO,YAAY,CAAC,OAAO,CAAA;SAC5B;aAAM,IACL,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ;YACxC,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAClD;YACA,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,CAAA;SACpC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF,CAAA;AAED,kBAAe,gBAAgB,CAAA","sourcesContent":["import path from 'node:path'\nimport { EventEmitter } from 'node:events'\nimport { Writable as WritableStream } from 'node:stream'\nimport { pathToFileURL } from 'node:url'\nimport { doesHaveValue, doesNotHaveValue } from '../value_checker'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\nimport EventDataCollector from './helpers/event_data_collector'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport JavascriptSnippetSyntax from './step_definition_snippet_builder/javascript_snippet_syntax'\nimport getColorFns from './get_color_fns'\nimport Formatters from './helpers/formatters'\nimport Formatter, {\n  FormatOptions,\n  IFormatterCleanupFn,\n  IFormatterLogFn,\n} from '.'\n\ninterface IGetStepDefinitionSnippetBuilderOptions {\n  cwd: string\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nexport interface IBuildOptions {\n  env: NodeJS.ProcessEnv\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  stream: WritableStream\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nconst FormatterBuilder = {\n  async build(type: string, options: IBuildOptions): Promise<Formatter> {\n    const FormatterConstructor = await FormatterBuilder.getConstructorByType(\n      type,\n      options.cwd\n    )\n    const colorFns = getColorFns(\n      options.stream,\n      options.env,\n      options.parsedArgvOptions.colorsEnabled\n    )\n    const snippetBuilder =\n      await FormatterBuilder.getStepDefinitionSnippetBuilder({\n        cwd: options.cwd,\n        snippetInterface: options.parsedArgvOptions.snippetInterface,\n        snippetSyntax: options.parsedArgvOptions.snippetSyntax,\n        supportCodeLibrary: options.supportCodeLibrary,\n      })\n    return new FormatterConstructor({\n      colorFns,\n      snippetBuilder,\n      ...options,\n    })\n  },\n\n  async getConstructorByType(\n    type: string,\n    cwd: string\n  ): Promise<typeof Formatter> {\n    const formatters: Record<string, typeof Formatter> =\n      Formatters.getFormatters()\n\n    return formatters[type]\n      ? formatters[type]\n      : await FormatterBuilder.loadCustomClass('formatter', type, cwd)\n  },\n\n  async getStepDefinitionSnippetBuilder({\n    cwd,\n    snippetInterface,\n    snippetSyntax,\n    supportCodeLibrary,\n  }: IGetStepDefinitionSnippetBuilderOptions) {\n    if (doesNotHaveValue(snippetInterface)) {\n      snippetInterface = SnippetInterface.Synchronous\n    }\n    let Syntax = JavascriptSnippetSyntax\n    if (doesHaveValue(snippetSyntax)) {\n      Syntax = await FormatterBuilder.loadCustomClass(\n        'syntax',\n        snippetSyntax,\n        cwd\n      )\n    }\n    return new StepDefinitionSnippetBuilder({\n      snippetSyntax: new Syntax(snippetInterface),\n      parameterTypeRegistry: supportCodeLibrary.parameterTypeRegistry,\n    })\n  },\n\n  async loadCustomClass(\n    type: 'formatter' | 'syntax',\n    descriptor: string,\n    cwd: string\n  ) {\n    let normalized: URL | string = descriptor\n    if (descriptor.startsWith('.')) {\n      normalized = pathToFileURL(path.resolve(cwd, descriptor))\n    } else if (descriptor.startsWith('file://')) {\n      normalized = new URL(descriptor)\n    }\n    let CustomClass = await FormatterBuilder.loadFile(normalized)\n    CustomClass = FormatterBuilder.resolveConstructor(CustomClass)\n    if (doesHaveValue(CustomClass)) {\n      return CustomClass\n    } else {\n      throw new Error(\n        `Custom ${type} (${descriptor}) does not export a function/class`\n      )\n    }\n  },\n\n  async loadFile(urlOrName: URL | string) {\n    return await import(urlOrName.toString())\n  },\n\n  resolveConstructor(ImportedCode: any) {\n    if (doesNotHaveValue(ImportedCode)) {\n      return null\n    }\n    if (typeof ImportedCode === 'function') {\n      return ImportedCode\n    } else if (\n      typeof ImportedCode === 'object' &&\n      typeof ImportedCode.default === 'function'\n    ) {\n      return ImportedCode.default\n    } else if (\n      typeof ImportedCode.default === 'object' &&\n      typeof ImportedCode.default.default === 'function'\n    ) {\n      return ImportedCode.default.default\n    }\n    return null\n  },\n}\n\nexport default FormatterBuilder\n"]}
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../src/formatter/builder.ts"],"names":[],"mappings":";;;;;AAAA,0DAA4B;AAG5B,uCAAwC;AACxC,oDAAkE;AAElE,qFAAmF;AAEnF,wGAA4E;AAC5E,4HAAiG;AACjG,oEAAyC;AACzC,sEAA6C;AA0B7C,MAAM,gBAAgB,GAAG;IACvB,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAAsB;QAC9C,MAAM,oBAAoB,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,CACtE,IAAI,EACJ,OAAO,CAAC,GAAG,CACZ,CAAA;QACD,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAC1B,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,GAAG,EACX,OAAO,CAAC,iBAAiB,CAAC,aAAa,CACxC,CAAA;QACD,MAAM,cAAc,GAClB,MAAM,gBAAgB,CAAC,+BAA+B,CAAC;YACrD,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,gBAAgB,EAAE,OAAO,CAAC,iBAAiB,CAAC,gBAAgB;YAC5D,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,aAAa;YACtD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC,CAAA;QACJ,OAAO,IAAI,oBAAoB,CAAC;YAC9B,QAAQ;YACR,cAAc;YACd,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,IAAY,EACZ,GAAW;QAEX,MAAM,UAAU,GACd,oBAAU,CAAC,aAAa,EAAE,CAAA;QAE5B,OAAO,UAAU,CAAC,IAAI,CAAC;YACrB,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAClB,CAAC,CAAC,MAAM,gBAAgB,CAAC,eAAe,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,+BAA+B,CAAC,EACpC,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GACsB;QACxC,IAAI,IAAA,gCAAgB,EAAC,gBAAgB,CAAC,EAAE;YACtC,gBAAgB,GAAG,iCAAgB,CAAC,WAAW,CAAA;SAChD;QACD,IAAI,MAAM,GAAG,mCAAuB,CAAA;QACpC,IAAI,IAAA,6BAAa,EAAC,aAAa,CAAC,EAAE;YAChC,MAAM,GAAG,MAAM,gBAAgB,CAAC,eAAe,CAC7C,QAAQ,EACR,aAAa,EACb,GAAG,CACJ,CAAA;SACF;QACD,OAAO,IAAI,yCAA4B,CAAC;YACtC,aAAa,EAAE,IAAI,MAAM,CAAC,gBAAgB,CAAC;YAC3C,qBAAqB,EAAE,kBAAkB,CAAC,qBAAqB;SAChE,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAA4B,EAC5B,UAAkB,EAClB,GAAW;QAEX,IAAI,UAAU,GAAiB,UAAU,CAAA;QACzC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,UAAU,GAAG,IAAA,wBAAa,EAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAA;SAC1D;aAAM,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC3C,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;SACjC;QACD,IAAI,WAAW,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC7D,WAAW,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;QAC9D,IAAI,IAAA,6BAAa,EAAC,WAAW,CAAC,EAAE;YAC9B,OAAO,WAAW,CAAA;SACnB;aAAM;YACL,MAAM,IAAI,KAAK,CACb,UAAU,IAAI,KAAK,UAAU,oCAAoC,CAClE,CAAA;SACF;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,SAAuB;QACpC,OAAO,MAAM,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,kBAAkB,CAAC,YAAiB;QAClC,IAAI,IAAA,gCAAgB,EAAC,YAAY,CAAC,EAAE;YAClC,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;YACtC,OAAO,YAAY,CAAA;SACpB;aAAM,IACL,OAAO,YAAY,KAAK,QAAQ;YAChC,OAAO,YAAY,CAAC,OAAO,KAAK,UAAU,EAC1C;YACA,OAAO,YAAY,CAAC,OAAO,CAAA;SAC5B;aAAM,IACL,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ;YACxC,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAClD;YACA,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,CAAA;SACpC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF,CAAA;AAED,kBAAe,gBAAgB,CAAA","sourcesContent":["import path from 'node:path'\nimport { EventEmitter } from 'node:events'\nimport { Writable as WritableStream } from 'node:stream'\nimport { pathToFileURL } from 'node:url'\nimport { doesHaveValue, doesNotHaveValue } from '../value_checker'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\nimport EventDataCollector from './helpers/event_data_collector'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport JavascriptSnippetSyntax from './step_definition_snippet_builder/javascript_snippet_syntax'\nimport getColorFns from './get_color_fns'\nimport Formatters from './helpers/formatters'\nimport Formatter, {\n  FormatOptions,\n  IFormatterCleanupFn,\n  IFormatterLogFn,\n} from '.'\n\ninterface IGetStepDefinitionSnippetBuilderOptions {\n  cwd: string\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  supportCodeLibrary: SupportCodeLibrary\n}\n\nexport interface IBuildOptions {\n  env: NodeJS.ProcessEnv\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  stream: WritableStream\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: SupportCodeLibrary\n}\n\nconst FormatterBuilder = {\n  async build(type: string, options: IBuildOptions): Promise<Formatter> {\n    const FormatterConstructor = await FormatterBuilder.getConstructorByType(\n      type,\n      options.cwd\n    )\n    const colorFns = getColorFns(\n      options.stream,\n      options.env,\n      options.parsedArgvOptions.colorsEnabled\n    )\n    const snippetBuilder =\n      await FormatterBuilder.getStepDefinitionSnippetBuilder({\n        cwd: options.cwd,\n        snippetInterface: options.parsedArgvOptions.snippetInterface,\n        snippetSyntax: options.parsedArgvOptions.snippetSyntax,\n        supportCodeLibrary: options.supportCodeLibrary,\n      })\n    return new FormatterConstructor({\n      colorFns,\n      snippetBuilder,\n      ...options,\n    })\n  },\n\n  async getConstructorByType(\n    type: string,\n    cwd: string\n  ): Promise<typeof Formatter> {\n    const formatters: Record<string, typeof Formatter> =\n      Formatters.getFormatters()\n\n    return formatters[type]\n      ? formatters[type]\n      : await FormatterBuilder.loadCustomClass('formatter', type, cwd)\n  },\n\n  async getStepDefinitionSnippetBuilder({\n    cwd,\n    snippetInterface,\n    snippetSyntax,\n    supportCodeLibrary,\n  }: IGetStepDefinitionSnippetBuilderOptions) {\n    if (doesNotHaveValue(snippetInterface)) {\n      snippetInterface = SnippetInterface.Synchronous\n    }\n    let Syntax = JavascriptSnippetSyntax\n    if (doesHaveValue(snippetSyntax)) {\n      Syntax = await FormatterBuilder.loadCustomClass(\n        'syntax',\n        snippetSyntax,\n        cwd\n      )\n    }\n    return new StepDefinitionSnippetBuilder({\n      snippetSyntax: new Syntax(snippetInterface),\n      parameterTypeRegistry: supportCodeLibrary.parameterTypeRegistry,\n    })\n  },\n\n  async loadCustomClass(\n    type: 'formatter' | 'syntax',\n    descriptor: string,\n    cwd: string\n  ) {\n    let normalized: URL | string = descriptor\n    if (descriptor.startsWith('.')) {\n      normalized = pathToFileURL(path.resolve(cwd, descriptor))\n    } else if (descriptor.startsWith('file://')) {\n      normalized = new URL(descriptor)\n    }\n    let CustomClass = await FormatterBuilder.loadFile(normalized)\n    CustomClass = FormatterBuilder.resolveConstructor(CustomClass)\n    if (doesHaveValue(CustomClass)) {\n      return CustomClass\n    } else {\n      throw new Error(\n        `Custom ${type} (${descriptor}) does not export a function/class`\n      )\n    }\n  },\n\n  async loadFile(urlOrName: URL | string) {\n    return await import(urlOrName.toString())\n  },\n\n  resolveConstructor(ImportedCode: any) {\n    if (doesNotHaveValue(ImportedCode)) {\n      return null\n    }\n    if (typeof ImportedCode === 'function') {\n      return ImportedCode\n    } else if (\n      typeof ImportedCode === 'object' &&\n      typeof ImportedCode.default === 'function'\n    ) {\n      return ImportedCode.default\n    } else if (\n      typeof ImportedCode.default === 'object' &&\n      typeof ImportedCode.default.default === 'function'\n    ) {\n      return ImportedCode.default.default\n    }\n    return null\n  },\n}\n\nexport default FormatterBuilder\n"]}

package/lib/formatter/helpers/issue_helpers.d.ts

@@ -1,7 +1,7 @@
 import * as messages from '@cucumber/messages';
 import { IColorFns } from '../get_color_fns';
 import StepDefinitionSnippetBuilder from '../step_definition_snippet_builder';
-import { ISupportCodeLibrary } from '../../support_code_library_builder/types';
+import { SupportCodeLibrary } from '../../support_code_library_builder/types';
 import { ITestCaseAttempt } from './event_data_collector';
 export declare function isFailure(result: messages.TestStepResult, willBeRetried?: boolean): boolean;
 export declare function isWarning(result: messages.TestStepResult, willBeRetried?: boolean): boolean;
@@ -11,7 +11,7 @@ export interface IFormatIssueRequest {
     number: number;
     snippetBuilder: StepDefinitionSnippetBuilder;
     testCaseAttempt: ITestCaseAttempt;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
     printAttachments?: boolean;
 }
 export declare function formatIssue({ colorFns, number, snippetBuilder, testCaseAttempt, supportCodeLibrary, printAttachments, }: IFormatIssueRequest): string;

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

@@ -1 +1 @@
-{"version":3,"file":"issue_helpers.js","sourceRoot":"","sources":["../../../src/formatter/helpers/issue_helpers.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAKxC,+EAAqE;AAGrE,SAAgB,SAAS,CACvB,MAA+B,EAC/B,gBAAyB,KAAK;IAE9B,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,WAAW;QAC7B,MAAM,CAAC,MAAM,KAAK,WAAW;QAC7B,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,CAC/C,CAAA;AACH,CAAC;AATD,8BASC;AAED,SAAgB,SAAS,CACvB,MAA+B,EAC/B,gBAAyB,KAAK;IAE9B,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,aAAa,CAAC,CAC7E,CAAA;AACH,CAAC;AAPD,8BAOC;AAED,SAAgB,OAAO,CAAC,MAA+B;IACrD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAA;AAC/C,CAAC;AAFD,0BAEC;AAWD,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,gBAAgB,GAAG,IAAI,GACH;IACpB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAA;IACvC,MAAM,wBAAwB,GAAG,IAAA,mDAAqB,EAAC;QACrD,QAAQ;QACR,cAAc;QACd,eAAe;QACf,kBAAkB;QAClB,gBAAgB;KACjB,CAAC,CAAA;IACF,MAAM,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAClD,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC7C,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,GAAG,MAAM,GAAG,IAAI,EAAE,CAAA;SAC1B;QACD,OAAO,IAAA,uBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IACF,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC;AAxBD,kCAwBC;AAED,SAAgB,6BAA6B,CAC3C,uBAA0D;IAE1D,MAAM,MAAM,GAAG,CAAC,gCAAgC,CAAC,CAAA;IACjD,MAAM,UAAU,GAAoD,EAAE,CAAA;IACtE,uBAAuB,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAChD,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;IAChD,CAAC,CAAC,CAAA;IACF,MAAM,CAAC,IAAI,CACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;SACtB,GAAG,CACF,CAAC,aAAa,EAAE,EAAE,CAAC,KAAK,4BAA4B,CAAC,aAAa,CAAC,EAAE,CACtE;SACA,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;IACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACnB,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACxB,CAAC;AAjBD,sEAiBC;AAED,SAAgB,4BAA4B,CAC1C,aAA8C;IAE9C,OAAO,IAAI,aAAa,CAAC,IAAI,YAAY,aAAa,CAAC,UAAU,IAAI,CAAA;AACvE,CAAC;AAJD,oEAIC","sourcesContent":["import indentString from 'indent-string'\nimport * as messages from '@cucumber/messages'\nimport { IColorFns } from '../get_color_fns'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { ISupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { formatTestCaseAttempt } from './test_case_attempt_formatter'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nexport function isFailure(\n  result: messages.TestStepResult,\n  willBeRetried: boolean = false\n): boolean {\n  return (\n    result.status === 'AMBIGUOUS' ||\n    result.status === 'UNDEFINED' ||\n    (result.status === 'FAILED' && !willBeRetried)\n  )\n}\n\nexport function isWarning(\n  result: messages.TestStepResult,\n  willBeRetried: boolean = false\n): boolean {\n  return (\n    result.status === 'PENDING' || (result.status === 'FAILED' && willBeRetried)\n  )\n}\n\nexport function isIssue(result: messages.TestStepResult): boolean {\n  return isFailure(result) || isWarning(result)\n}\n\nexport interface IFormatIssueRequest {\n  colorFns: IColorFns\n  number: number\n  snippetBuilder: StepDefinitionSnippetBuilder\n  testCaseAttempt: ITestCaseAttempt\n  supportCodeLibrary: ISupportCodeLibrary\n  printAttachments?: boolean\n}\n\nexport function formatIssue({\n  colorFns,\n  number,\n  snippetBuilder,\n  testCaseAttempt,\n  supportCodeLibrary,\n  printAttachments = true,\n}: IFormatIssueRequest): string {\n  const prefix = `${number.toString()}) `\n  const formattedTestCaseAttempt = formatTestCaseAttempt({\n    colorFns,\n    snippetBuilder,\n    testCaseAttempt,\n    supportCodeLibrary,\n    printAttachments,\n  })\n  const lines = formattedTestCaseAttempt.split('\\n')\n  const updatedLines = lines.map((line, index) => {\n    if (index === 0) {\n      return `${prefix}${line}`\n    }\n    return indentString(line, prefix.length)\n  })\n  return updatedLines.join('\\n')\n}\n\nexport function formatUndefinedParameterTypes(\n  undefinedParameterTypes: messages.UndefinedParameterType[]\n): string {\n  const output = [`Undefined parameter types:\\n\\n`]\n  const withLatest: Record<string, messages.UndefinedParameterType> = {}\n  undefinedParameterTypes.forEach((parameterType) => {\n    withLatest[parameterType.name] = parameterType\n  })\n  output.push(\n    Object.values(withLatest)\n      .map(\n        (parameterType) => `- ${formatUndefinedParameterType(parameterType)}`\n      )\n      .join('\\n')\n  )\n  output.push('\\n\\n')\n  return output.join('')\n}\n\nexport function formatUndefinedParameterType(\n  parameterType: messages.UndefinedParameterType\n): string {\n  return `\"${parameterType.name}\" e.g. \\`${parameterType.expression}\\``\n}\n"]}
+{"version":3,"file":"issue_helpers.js","sourceRoot":"","sources":["../../../src/formatter/helpers/issue_helpers.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAKxC,+EAAqE;AAGrE,SAAgB,SAAS,CACvB,MAA+B,EAC/B,gBAAyB,KAAK;IAE9B,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,WAAW;QAC7B,MAAM,CAAC,MAAM,KAAK,WAAW;QAC7B,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,CAC/C,CAAA;AACH,CAAC;AATD,8BASC;AAED,SAAgB,SAAS,CACvB,MAA+B,EAC/B,gBAAyB,KAAK;IAE9B,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,aAAa,CAAC,CAC7E,CAAA;AACH,CAAC;AAPD,8BAOC;AAED,SAAgB,OAAO,CAAC,MAA+B;IACrD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAA;AAC/C,CAAC;AAFD,0BAEC;AAWD,SAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,MAAM,EACN,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,gBAAgB,GAAG,IAAI,GACH;IACpB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAA;IACvC,MAAM,wBAAwB,GAAG,IAAA,mDAAqB,EAAC;QACrD,QAAQ;QACR,cAAc;QACd,eAAe;QACf,kBAAkB;QAClB,gBAAgB;KACjB,CAAC,CAAA;IACF,MAAM,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAClD,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC7C,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,GAAG,MAAM,GAAG,IAAI,EAAE,CAAA;SAC1B;QACD,OAAO,IAAA,uBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IACF,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC;AAxBD,kCAwBC;AAED,SAAgB,6BAA6B,CAC3C,uBAA0D;IAE1D,MAAM,MAAM,GAAG,CAAC,gCAAgC,CAAC,CAAA;IACjD,MAAM,UAAU,GAAoD,EAAE,CAAA;IACtE,uBAAuB,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAChD,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;IAChD,CAAC,CAAC,CAAA;IACF,MAAM,CAAC,IAAI,CACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;SACtB,GAAG,CACF,CAAC,aAAa,EAAE,EAAE,CAAC,KAAK,4BAA4B,CAAC,aAAa,CAAC,EAAE,CACtE;SACA,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;IACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACnB,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACxB,CAAC;AAjBD,sEAiBC;AAED,SAAgB,4BAA4B,CAC1C,aAA8C;IAE9C,OAAO,IAAI,aAAa,CAAC,IAAI,YAAY,aAAa,CAAC,UAAU,IAAI,CAAA;AACvE,CAAC;AAJD,oEAIC","sourcesContent":["import indentString from 'indent-string'\nimport * as messages from '@cucumber/messages'\nimport { IColorFns } from '../get_color_fns'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { SupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { formatTestCaseAttempt } from './test_case_attempt_formatter'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nexport function isFailure(\n  result: messages.TestStepResult,\n  willBeRetried: boolean = false\n): boolean {\n  return (\n    result.status === 'AMBIGUOUS' ||\n    result.status === 'UNDEFINED' ||\n    (result.status === 'FAILED' && !willBeRetried)\n  )\n}\n\nexport function isWarning(\n  result: messages.TestStepResult,\n  willBeRetried: boolean = false\n): boolean {\n  return (\n    result.status === 'PENDING' || (result.status === 'FAILED' && willBeRetried)\n  )\n}\n\nexport function isIssue(result: messages.TestStepResult): boolean {\n  return isFailure(result) || isWarning(result)\n}\n\nexport interface IFormatIssueRequest {\n  colorFns: IColorFns\n  number: number\n  snippetBuilder: StepDefinitionSnippetBuilder\n  testCaseAttempt: ITestCaseAttempt\n  supportCodeLibrary: SupportCodeLibrary\n  printAttachments?: boolean\n}\n\nexport function formatIssue({\n  colorFns,\n  number,\n  snippetBuilder,\n  testCaseAttempt,\n  supportCodeLibrary,\n  printAttachments = true,\n}: IFormatIssueRequest): string {\n  const prefix = `${number.toString()}) `\n  const formattedTestCaseAttempt = formatTestCaseAttempt({\n    colorFns,\n    snippetBuilder,\n    testCaseAttempt,\n    supportCodeLibrary,\n    printAttachments,\n  })\n  const lines = formattedTestCaseAttempt.split('\\n')\n  const updatedLines = lines.map((line, index) => {\n    if (index === 0) {\n      return `${prefix}${line}`\n    }\n    return indentString(line, prefix.length)\n  })\n  return updatedLines.join('\\n')\n}\n\nexport function formatUndefinedParameterTypes(\n  undefinedParameterTypes: messages.UndefinedParameterType[]\n): string {\n  const output = [`Undefined parameter types:\\n\\n`]\n  const withLatest: Record<string, messages.UndefinedParameterType> = {}\n  undefinedParameterTypes.forEach((parameterType) => {\n    withLatest[parameterType.name] = parameterType\n  })\n  output.push(\n    Object.values(withLatest)\n      .map(\n        (parameterType) => `- ${formatUndefinedParameterType(parameterType)}`\n      )\n      .join('\\n')\n  )\n  output.push('\\n\\n')\n  return output.join('')\n}\n\nexport function formatUndefinedParameterType(\n  parameterType: messages.UndefinedParameterType\n): string {\n  return `\"${parameterType.name}\" e.g. \\`${parameterType.expression}\\``\n}\n"]}

package/lib/formatter/helpers/test_case_attempt_formatter.d.ts

@@ -1,12 +1,12 @@
 import { IColorFns } from '../get_color_fns';
 import StepDefinitionSnippetBuilder from '../step_definition_snippet_builder';
-import { ISupportCodeLibrary } from '../../support_code_library_builder/types';
+import { SupportCodeLibrary } from '../../support_code_library_builder/types';
 import { ITestCaseAttempt } from './event_data_collector';
 export interface IFormatTestCaseAttemptRequest {
     colorFns: IColorFns;
     testCaseAttempt: ITestCaseAttempt;
     snippetBuilder: StepDefinitionSnippetBuilder;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
     printAttachments?: boolean;
 }
 export declare function formatTestCaseAttempt({ colorFns, snippetBuilder, supportCodeLibrary, testCaseAttempt, printAttachments, }: IFormatTestCaseAttemptRequest): string;

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

@@ -1 +1 @@
-{"version":3,"file":"test_case_attempt_formatter.js","sourceRoot":"","sources":["../../../src/formatter/helpers/test_case_attempt_formatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAAwC;AACxC,6DAA8C;AAC9C,sDAA6B;AAE7B,uDAAmE;AAGnE,yDAAmD;AACnD,yEAGmC;AACnC,uEAA8D;AAG9D,MAAM,UAAU,GAA+C,IAAI,GAAG,CAAC;IACrE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,iBAAO,CAAC,KAAK,CAAC;IACxD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,iBAAO,CAAC,KAAK,CAAC;IACrD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,iBAAO,CAAC,IAAI,CAAC;IACpD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC;IAC5C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC;IAC5C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,GAAG,CAAC;CAC/C,CAAC,CAAA;AAEF,SAAS,cAAc,CAAC,QAAyB;IAC/C,QAAQ,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAC9B,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS,CAAC;QAC7C,KAAK,QAAQ,CAAC,oBAAoB,CAAC,MAAM;YACvC,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAA;QAChC,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS;YAC1C,OAAO,GACL,kDAAkD,GAAG,MACvD,GAAG,IAAA,uBAAY,EAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAA;QAC1C,KAAK,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,OAAO,SAAS,CAAA;KACnB;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAQD,SAAS,UAAU,CAAC,EAClB,QAAQ,EACR,QAAQ,EACR,gBAAgB,GACG;IACnB,MAAM,EACJ,IAAI,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,cAAc,EACd,WAAW,GACZ,GAAG,QAAQ,CAAA;IACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,GAAG,IAAA,8BAAc,EAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IACvE,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;IAC7D,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC,EAAE;QACvB,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,CAAA;KAC9B;IACD,IAAI,IAAA,6BAAa,EAAC,cAAc,CAAC,EAAE;QACjC,IAAI,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAA,iCAAc,EAAC,cAAc,CAAC,CAAC,EAAE,CAAA;KAClE;IACD,IAAI,IAAI,IAAI,CAAA;IACZ,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACpC,MAAM,aAAa,GAAG,IAAA,4CAAkB,EAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC3D,IAAI,IAAI,IAAA,uBAAY,EAAC,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;KACvD;IACD,IAAI,IAAA,8BAAc,EAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE;QAC1C,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE;YACpD,IAAI,OAAO,GAAG,EAAE,CAAA;YAChB,IAAI,SAAS,KAAK,YAAY,EAAE;gBAC9B,OAAO,GAAG,KAAK,IAAI,EAAE,CAAA;aACtB;iBAAM,IAAI,QAAQ,EAAE;gBACnB,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAA;aAC1B;YACD,IAAI,IAAI,IAAA,uBAAY,EAAC,eAAe,SAAS,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;QAClE,CAAC,CAAC,CAAA;KACH;IACD,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IACxC,IAAI,OAAO,KAAK,EAAE,EAAE;QAClB,IAAI,IAAI,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;KACjD;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAUD,SAAgB,qBAAqB,CAAC,EACpC,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACc;IAC9B,MAAM,MAAM,GAAG,IAAA,+CAAoB,EAAC;QAClC,cAAc;QACd,eAAe;QACf,kBAAkB;KACnB,CAAC,CAAA;IACF,IAAI,IAAI,GAAG,aAAa,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC9C,IAAI,IAAI,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,aAAa,CAAC,CAAA;IAC9E,IAAI,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAC7B,IAAA,iCAAc,EAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAC/C,IAAI,CAAA;IACL,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpC,IAAI,IAAI,UAAU,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAC9D,CAAC,CAAC,CAAA;IACF,OAAO,GAAG,IAAI,IAAI,CAAA;AACpB,CAAC;AArBD,sDAqBC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,aAAsB;IAC7D,IAAI,OAAO,GAAG,CAAC,IAAI,aAAa,EAAE;QAChC,MAAM,SAAS,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;QACnD,OAAO,aAAa,SAAS,GAAG,UAAU,GAAG,CAAA;KAC9C;IACD,OAAO,EAAE,CAAA;AACX,CAAC","sourcesContent":["import indentString from 'indent-string'\nimport * as messages from '@cucumber/messages'\nimport figures from 'figures'\nimport { IColorFns } from '../get_color_fns'\nimport { doesHaveValue, valueOrDefault } from '../../value_checker'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { ISupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { formatLocation } from './location_helpers'\nimport {\n  IParsedTestStep,\n  parseTestCaseAttempt,\n} from './test_case_attempt_parser'\nimport { formatStepArgument } from './step_argument_formatter'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nconst CHARACTERS: Map<messages.TestStepResultStatus, string> = new Map([\n  [messages.TestStepResultStatus.AMBIGUOUS, figures.cross],\n  [messages.TestStepResultStatus.FAILED, figures.cross],\n  [messages.TestStepResultStatus.PASSED, figures.tick],\n  [messages.TestStepResultStatus.PENDING, '?'],\n  [messages.TestStepResultStatus.SKIPPED, '-'],\n  [messages.TestStepResultStatus.UNDEFINED, '?'],\n])\n\nfunction getStepMessage(testStep: IParsedTestStep): string {\n  switch (testStep.result.status) {\n    case messages.TestStepResultStatus.AMBIGUOUS:\n    case messages.TestStepResultStatus.FAILED:\n      return testStep.result.message\n    case messages.TestStepResultStatus.UNDEFINED:\n      return `${\n        'Undefined. Implement with the following snippet:' + '\\n\\n'\n      }${indentString(testStep.snippet, 2)}\\n`\n    case messages.TestStepResultStatus.PENDING:\n      return 'Pending'\n  }\n  return ''\n}\n\ninterface IFormatStepRequest {\n  colorFns: IColorFns\n  testStep: IParsedTestStep\n  printAttachments?: boolean\n}\n\nfunction formatStep({\n  colorFns,\n  testStep,\n  printAttachments,\n}: IFormatStepRequest): string {\n  const {\n    name,\n    result: { status },\n    actionLocation,\n    attachments,\n  } = testStep\n  const colorFn = colorFns.forStatus(status)\n  const identifier = testStep.keyword + valueOrDefault(testStep.text, '')\n  let text = colorFn(`${CHARACTERS.get(status)} ${identifier}`)\n  if (doesHaveValue(name)) {\n    text += colorFn(` (${name})`)\n  }\n  if (doesHaveValue(actionLocation)) {\n    text += ` # ${colorFns.location(formatLocation(actionLocation))}`\n  }\n  text += '\\n'\n  if (doesHaveValue(testStep.argument)) {\n    const argumentsText = formatStepArgument(testStep.argument)\n    text += indentString(`${colorFn(argumentsText)}\\n`, 4)\n  }\n  if (valueOrDefault(printAttachments, true)) {\n    attachments.forEach(({ body, mediaType, fileName }) => {\n      let message = ''\n      if (mediaType === 'text/plain') {\n        message = `: ${body}`\n      } else if (fileName) {\n        message = `: ${fileName}`\n      }\n      text += indentString(`Attachment (${mediaType})${message}\\n`, 4)\n    })\n  }\n  const message = getStepMessage(testStep)\n  if (message !== '') {\n    text += `${indentString(colorFn(message), 4)}\\n`\n  }\n  return text\n}\n\nexport interface IFormatTestCaseAttemptRequest {\n  colorFns: IColorFns\n  testCaseAttempt: ITestCaseAttempt\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: ISupportCodeLibrary\n  printAttachments?: boolean\n}\n\nexport function formatTestCaseAttempt({\n  colorFns,\n  snippetBuilder,\n  supportCodeLibrary,\n  testCaseAttempt,\n  printAttachments,\n}: IFormatTestCaseAttemptRequest): string {\n  const parsed = parseTestCaseAttempt({\n    snippetBuilder,\n    testCaseAttempt,\n    supportCodeLibrary,\n  })\n  let text = `Scenario: ${parsed.testCase.name}`\n  text += getAttemptText(parsed.testCase.attempt, testCaseAttempt.willBeRetried)\n  text += ` # ${colorFns.location(\n    formatLocation(parsed.testCase.sourceLocation)\n  )}\\n`\n  parsed.testSteps.forEach((testStep) => {\n    text += formatStep({ colorFns, testStep, printAttachments })\n  })\n  return `${text}\\n`\n}\n\nfunction getAttemptText(attempt: number, willBeRetried: boolean): string {\n  if (attempt > 0 || willBeRetried) {\n    const numberStr = (attempt + 1).toString()\n    const retriedStr = willBeRetried ? ', retried' : ''\n    return ` (attempt ${numberStr}${retriedStr})`\n  }\n  return ''\n}\n"]}
+{"version":3,"file":"test_case_attempt_formatter.js","sourceRoot":"","sources":["../../../src/formatter/helpers/test_case_attempt_formatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAAwC;AACxC,6DAA8C;AAC9C,sDAA6B;AAE7B,uDAAmE;AAGnE,yDAAmD;AACnD,yEAGmC;AACnC,uEAA8D;AAG9D,MAAM,UAAU,GAA+C,IAAI,GAAG,CAAC;IACrE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,iBAAO,CAAC,KAAK,CAAC;IACxD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,iBAAO,CAAC,KAAK,CAAC;IACrD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,iBAAO,CAAC,IAAI,CAAC;IACpD,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC;IAC5C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC;IAC5C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,GAAG,CAAC;CAC/C,CAAC,CAAA;AAEF,SAAS,cAAc,CAAC,QAAyB;IAC/C,QAAQ,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAC9B,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS,CAAC;QAC7C,KAAK,QAAQ,CAAC,oBAAoB,CAAC,MAAM;YACvC,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAA;QAChC,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS;YAC1C,OAAO,GACL,kDAAkD,GAAG,MACvD,GAAG,IAAA,uBAAY,EAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAA;QAC1C,KAAK,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,OAAO,SAAS,CAAA;KACnB;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAQD,SAAS,UAAU,CAAC,EAClB,QAAQ,EACR,QAAQ,EACR,gBAAgB,GACG;IACnB,MAAM,EACJ,IAAI,EACJ,MAAM,EAAE,EAAE,MAAM,EAAE,EAClB,cAAc,EACd,WAAW,GACZ,GAAG,QAAQ,CAAA;IACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,GAAG,IAAA,8BAAc,EAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IACvE,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;IAC7D,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC,EAAE;QACvB,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,CAAA;KAC9B;IACD,IAAI,IAAA,6BAAa,EAAC,cAAc,CAAC,EAAE;QACjC,IAAI,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAA,iCAAc,EAAC,cAAc,CAAC,CAAC,EAAE,CAAA;KAClE;IACD,IAAI,IAAI,IAAI,CAAA;IACZ,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACpC,MAAM,aAAa,GAAG,IAAA,4CAAkB,EAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC3D,IAAI,IAAI,IAAA,uBAAY,EAAC,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;KACvD;IACD,IAAI,IAAA,8BAAc,EAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE;QAC1C,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE;YACpD,IAAI,OAAO,GAAG,EAAE,CAAA;YAChB,IAAI,SAAS,KAAK,YAAY,EAAE;gBAC9B,OAAO,GAAG,KAAK,IAAI,EAAE,CAAA;aACtB;iBAAM,IAAI,QAAQ,EAAE;gBACnB,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAA;aAC1B;YACD,IAAI,IAAI,IAAA,uBAAY,EAAC,eAAe,SAAS,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;QAClE,CAAC,CAAC,CAAA;KACH;IACD,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IACxC,IAAI,OAAO,KAAK,EAAE,EAAE;QAClB,IAAI,IAAI,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;KACjD;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAUD,SAAgB,qBAAqB,CAAC,EACpC,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACc;IAC9B,MAAM,MAAM,GAAG,IAAA,+CAAoB,EAAC;QAClC,cAAc;QACd,eAAe;QACf,kBAAkB;KACnB,CAAC,CAAA;IACF,IAAI,IAAI,GAAG,aAAa,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC9C,IAAI,IAAI,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,aAAa,CAAC,CAAA;IAC9E,IAAI,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAC7B,IAAA,iCAAc,EAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAC/C,IAAI,CAAA;IACL,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpC,IAAI,IAAI,UAAU,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAC9D,CAAC,CAAC,CAAA;IACF,OAAO,GAAG,IAAI,IAAI,CAAA;AACpB,CAAC;AArBD,sDAqBC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,aAAsB;IAC7D,IAAI,OAAO,GAAG,CAAC,IAAI,aAAa,EAAE;QAChC,MAAM,SAAS,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;QACnD,OAAO,aAAa,SAAS,GAAG,UAAU,GAAG,CAAA;KAC9C;IACD,OAAO,EAAE,CAAA;AACX,CAAC","sourcesContent":["import indentString from 'indent-string'\nimport * as messages from '@cucumber/messages'\nimport figures from 'figures'\nimport { IColorFns } from '../get_color_fns'\nimport { doesHaveValue, valueOrDefault } from '../../value_checker'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { SupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { formatLocation } from './location_helpers'\nimport {\n  IParsedTestStep,\n  parseTestCaseAttempt,\n} from './test_case_attempt_parser'\nimport { formatStepArgument } from './step_argument_formatter'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nconst CHARACTERS: Map<messages.TestStepResultStatus, string> = new Map([\n  [messages.TestStepResultStatus.AMBIGUOUS, figures.cross],\n  [messages.TestStepResultStatus.FAILED, figures.cross],\n  [messages.TestStepResultStatus.PASSED, figures.tick],\n  [messages.TestStepResultStatus.PENDING, '?'],\n  [messages.TestStepResultStatus.SKIPPED, '-'],\n  [messages.TestStepResultStatus.UNDEFINED, '?'],\n])\n\nfunction getStepMessage(testStep: IParsedTestStep): string {\n  switch (testStep.result.status) {\n    case messages.TestStepResultStatus.AMBIGUOUS:\n    case messages.TestStepResultStatus.FAILED:\n      return testStep.result.message\n    case messages.TestStepResultStatus.UNDEFINED:\n      return `${\n        'Undefined. Implement with the following snippet:' + '\\n\\n'\n      }${indentString(testStep.snippet, 2)}\\n`\n    case messages.TestStepResultStatus.PENDING:\n      return 'Pending'\n  }\n  return ''\n}\n\ninterface IFormatStepRequest {\n  colorFns: IColorFns\n  testStep: IParsedTestStep\n  printAttachments?: boolean\n}\n\nfunction formatStep({\n  colorFns,\n  testStep,\n  printAttachments,\n}: IFormatStepRequest): string {\n  const {\n    name,\n    result: { status },\n    actionLocation,\n    attachments,\n  } = testStep\n  const colorFn = colorFns.forStatus(status)\n  const identifier = testStep.keyword + valueOrDefault(testStep.text, '')\n  let text = colorFn(`${CHARACTERS.get(status)} ${identifier}`)\n  if (doesHaveValue(name)) {\n    text += colorFn(` (${name})`)\n  }\n  if (doesHaveValue(actionLocation)) {\n    text += ` # ${colorFns.location(formatLocation(actionLocation))}`\n  }\n  text += '\\n'\n  if (doesHaveValue(testStep.argument)) {\n    const argumentsText = formatStepArgument(testStep.argument)\n    text += indentString(`${colorFn(argumentsText)}\\n`, 4)\n  }\n  if (valueOrDefault(printAttachments, true)) {\n    attachments.forEach(({ body, mediaType, fileName }) => {\n      let message = ''\n      if (mediaType === 'text/plain') {\n        message = `: ${body}`\n      } else if (fileName) {\n        message = `: ${fileName}`\n      }\n      text += indentString(`Attachment (${mediaType})${message}\\n`, 4)\n    })\n  }\n  const message = getStepMessage(testStep)\n  if (message !== '') {\n    text += `${indentString(colorFn(message), 4)}\\n`\n  }\n  return text\n}\n\nexport interface IFormatTestCaseAttemptRequest {\n  colorFns: IColorFns\n  testCaseAttempt: ITestCaseAttempt\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: SupportCodeLibrary\n  printAttachments?: boolean\n}\n\nexport function formatTestCaseAttempt({\n  colorFns,\n  snippetBuilder,\n  supportCodeLibrary,\n  testCaseAttempt,\n  printAttachments,\n}: IFormatTestCaseAttemptRequest): string {\n  const parsed = parseTestCaseAttempt({\n    snippetBuilder,\n    testCaseAttempt,\n    supportCodeLibrary,\n  })\n  let text = `Scenario: ${parsed.testCase.name}`\n  text += getAttemptText(parsed.testCase.attempt, testCaseAttempt.willBeRetried)\n  text += ` # ${colorFns.location(\n    formatLocation(parsed.testCase.sourceLocation)\n  )}\\n`\n  parsed.testSteps.forEach((testStep) => {\n    text += formatStep({ colorFns, testStep, printAttachments })\n  })\n  return `${text}\\n`\n}\n\nfunction getAttemptText(attempt: number, willBeRetried: boolean): string {\n  if (attempt > 0 || willBeRetried) {\n    const numberStr = (attempt + 1).toString()\n    const retriedStr = willBeRetried ? ', retried' : ''\n    return ` (attempt ${numberStr}${retriedStr})`\n  }\n  return ''\n}\n"]}

package/lib/formatter/helpers/test_case_attempt_parser.d.ts

@@ -1,6 +1,6 @@
 import * as messages from '@cucumber/messages';
 import StepDefinitionSnippetBuilder from '../step_definition_snippet_builder';
-import { ISupportCodeLibrary } from '../../support_code_library_builder/types';
+import { SupportCodeLibrary } from '../../support_code_library_builder/types';
 import { ILineAndUri } from '../../types';
 import { ITestCaseAttempt } from './event_data_collector';
 export interface IParsedTestStep {
@@ -27,6 +27,6 @@ export interface IParsedTestCaseAttempt {
 export interface IParseTestCaseAttemptRequest {
     testCaseAttempt: ITestCaseAttempt;
     snippetBuilder: StepDefinitionSnippetBuilder;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
 }
 export declare function parseTestCaseAttempt({ testCaseAttempt, snippetBuilder, supportCodeLibrary, }: IParseTestCaseAttemptRequest): IParsedTestCaseAttempt;

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

@@ -1 +1 @@
-{"version":3,"file":"test_case_attempt_parser.js","sourceRoot":"","sources":["../../../src/formatter/helpers/test_case_attempt_parser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA8C;AAC9C,iDAAmD;AAGnD,uDAAmE;AAGnE,iDAAgE;AAChE,uEAGkC;AAClC,mDAAkE;AAyClE,SAAS,SAAS,CAAC,EACjB,YAAY,EACZ,cAAc,EACd,OAAO,EACP,WAAW,EACX,UAAU,EACV,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,mBAAmB,GACD;IAClB,MAAM,GAAG,GAAoB;QAC3B,WAAW,EAAE,mBAAmB;QAChC,OAAO,EAAE,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC;YAC3C,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,OAAO;QACX,MAAM,EAAE,cAAc;KACvB,CAAA;IACD,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,IAAI,cAAsC,CAAA;QAC1C,IAAI,YAAY,EAAE;YAChB,cAAc,GAAG,kBAAkB,CAAC,6BAA6B,CAAC,IAAI,CACpE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,MAAM,CAChC,CAAA;SACF;aAAM;YACL,cAAc,GAAG,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,CACnE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,MAAM,CAChC,CAAA;SACF;QACD,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,cAAc,CAAC,GAAG;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAA;QACD,GAAG,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAA;KAC/B;IACD,IACE,IAAA,6BAAa,EAAC,QAAQ,CAAC,iBAAiB,CAAC;QACzC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EACvC;QACA,MAAM,cAAc,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAC5D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAC9C,CAAA;QACD,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,cAAc,CAAC,GAAG;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAA;KACF;IACD,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;QACxC,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;SAC7D,CAAA;QACD,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC1B,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACtC,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;SACnC;KACF;IACD,IAAI,cAAc,CAAC,MAAM,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE;QACrE,GAAG,CAAC,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAA;KAChE;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAQD,yEAAyE;AACzE,mCAAmC;AACnC,SAAgB,oBAAoB,CAAC,EACnC,eAAe,EACf,cAAc,EACd,kBAAkB,GACW;IAC7B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAA,2CAAiB,EAAC,eAAe,CAAC,CAAA;IACzD,MAAM,0BAA0B,GAC9B,IAAA,uDAA6B,EAAC,eAAe,CAAC,CAAA;IAChD,MAAM,aAAa,GAAG,IAAA,gCAAgB,EAAC,MAAM,CAAC,CAAA;IAC9C,MAAM,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAA;IACpC,MAAM,cAAc,GAAoB;QACtC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,cAAc,EAAE;YACd,GAAG,EAAE,iBAAiB;YACtB,IAAI,EAAE,0BAA0B,CAC9B,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAChD,CAAC,IAAI;SACP;QACD,mBAAmB,EAAE,eAAe,CAAC,mBAAmB;KACzD,CAAA;IACD,MAAM,eAAe,GAAsB,EAAE,CAAA;IAC7C,IAAI,YAAY,GAAG,IAAI,CAAA;IACvB,IAAI,mBAAmB,GAAG,0BAAW,CAAC,YAAY,CAAA;IAElD,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtC,MAAM,cAAc,GAClB,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,yBAAc,EAAE,CAAA;QAElE,YAAY,GAAG,YAAY,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAE7D,IAAI,OAAO,EAAE,WAAW,EAAE,UAAU,CAAA;QACpC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACxC,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;YACjD,OAAO,GAAG,IAAA,8BAAc,EAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA;YACxD,WAAW,GAAG,IAAA,iCAAkB,EAAC;gBAC/B,OAAO;gBACP,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ;gBAC1C,mBAAmB;aACpB,CAAC,CAAA;SACH;QACD,MAAM,UAAU,GAAG,SAAS,CAAC;YAC3B,YAAY;YACZ,cAAc;YACd,OAAO;YACP,WAAW;YACX,UAAU;YACV,SAAS,EAAE,iBAAiB;YAC5B,cAAc;YACd,kBAAkB;YAClB,QAAQ;YACR,cAAc;YACd,mBAAmB,EAAE,IAAA,8BAAc,EACjC,eAAe,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC5C,EAAE,CACH;SACF,CAAC,CAAA;QACF,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAChC,mBAAmB,GAAG,WAAW,CAAA;IACnC,CAAC,CAAC,CAAA;IACF,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,SAAS,EAAE,eAAe;KAC3B,CAAA;AACH,CAAC;AAjED,oDAiEC","sourcesContent":["import * as messages from '@cucumber/messages'\nimport { TestStepResult } from '@cucumber/messages'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { ISupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { doesHaveValue, valueOrDefault } from '../../value_checker'\nimport TestCaseHookDefinition from '../../models/test_case_hook_definition'\nimport { ILineAndUri } from '../../types'\nimport { getStepKeywordType, KeywordType } from './keyword_type'\nimport {\n  getGherkinScenarioLocationMap,\n  getGherkinStepMap,\n} from './gherkin_document_parser'\nimport { getPickleStepMap, getStepKeyword } from './pickle_parser'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nexport interface IParsedTestStep {\n  actionLocation?: ILineAndUri\n  argument?: messages.PickleStepArgument\n  attachments: messages.Attachment[]\n  keyword: string\n  name?: string\n  result: messages.TestStepResult\n  snippet?: string\n  sourceLocation?: ILineAndUri\n  text?: string\n}\n\nexport interface IParsedTestCase {\n  attempt: number\n  name: string\n  sourceLocation?: ILineAndUri\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface IParsedTestCaseAttempt {\n  testCase: IParsedTestCase\n  testSteps: IParsedTestStep[]\n}\n\ninterface IParseStepRequest {\n  isBeforeHook: boolean\n  gherkinStepMap: Record<string, messages.Step>\n  keyword: string\n  keywordType: KeywordType\n  pickleStep: messages.PickleStep\n  pickleUri: string\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: ISupportCodeLibrary\n  testStep: messages.TestStep\n  testStepResult: messages.TestStepResult\n  testStepAttachments: messages.Attachment[]\n}\n\nfunction parseStep({\n  isBeforeHook,\n  gherkinStepMap,\n  keyword,\n  keywordType,\n  pickleStep,\n  pickleUri,\n  snippetBuilder,\n  supportCodeLibrary,\n  testStep,\n  testStepResult,\n  testStepAttachments,\n}: IParseStepRequest): IParsedTestStep {\n  const out: IParsedTestStep = {\n    attachments: testStepAttachments,\n    keyword: doesHaveValue(testStep.pickleStepId)\n      ? keyword\n      : isBeforeHook\n      ? 'Before'\n      : 'After',\n    result: testStepResult,\n  }\n  if (doesHaveValue(testStep.hookId)) {\n    let hookDefinition: TestCaseHookDefinition\n    if (isBeforeHook) {\n      hookDefinition = supportCodeLibrary.beforeTestCaseHookDefinitions.find(\n        (x) => x.id === testStep.hookId\n      )\n    } else {\n      hookDefinition = supportCodeLibrary.afterTestCaseHookDefinitions.find(\n        (x) => x.id === testStep.hookId\n      )\n    }\n    out.actionLocation = {\n      uri: hookDefinition.uri,\n      line: hookDefinition.line,\n    }\n    out.name = hookDefinition.name\n  }\n  if (\n    doesHaveValue(testStep.stepDefinitionIds) &&\n    testStep.stepDefinitionIds.length === 1\n  ) {\n    const stepDefinition = supportCodeLibrary.stepDefinitions.find(\n      (x) => x.id === testStep.stepDefinitionIds[0]\n    )\n    out.actionLocation = {\n      uri: stepDefinition.uri,\n      line: stepDefinition.line,\n    }\n  }\n  if (doesHaveValue(testStep.pickleStepId)) {\n    out.sourceLocation = {\n      uri: pickleUri,\n      line: gherkinStepMap[pickleStep.astNodeIds[0]].location.line,\n    }\n    out.text = pickleStep.text\n    if (doesHaveValue(pickleStep.argument)) {\n      out.argument = pickleStep.argument\n    }\n  }\n  if (testStepResult.status === messages.TestStepResultStatus.UNDEFINED) {\n    out.snippet = snippetBuilder.build({ keywordType, pickleStep })\n  }\n  return out\n}\n\nexport interface IParseTestCaseAttemptRequest {\n  testCaseAttempt: ITestCaseAttempt\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\n// Converts a testCaseAttempt into a json object with all data needed for\n// displaying it in a pretty format\nexport function parseTestCaseAttempt({\n  testCaseAttempt,\n  snippetBuilder,\n  supportCodeLibrary,\n}: IParseTestCaseAttemptRequest): IParsedTestCaseAttempt {\n  const { testCase, pickle, gherkinDocument } = testCaseAttempt\n  const gherkinStepMap = getGherkinStepMap(gherkinDocument)\n  const gherkinScenarioLocationMap =\n    getGherkinScenarioLocationMap(gherkinDocument)\n  const pickleStepMap = getPickleStepMap(pickle)\n  const relativePickleUri = pickle.uri\n  const parsedTestCase: IParsedTestCase = {\n    attempt: testCaseAttempt.attempt,\n    name: pickle.name,\n    sourceLocation: {\n      uri: relativePickleUri,\n      line: gherkinScenarioLocationMap[\n        pickle.astNodeIds[pickle.astNodeIds.length - 1]\n      ].line,\n    },\n    worstTestStepResult: testCaseAttempt.worstTestStepResult,\n  }\n  const parsedTestSteps: IParsedTestStep[] = []\n  let isBeforeHook = true\n  let previousKeywordType = KeywordType.Precondition\n\n  testCase.testSteps.forEach((testStep) => {\n    const testStepResult =\n      testCaseAttempt.stepResults[testStep.id] || new TestStepResult()\n\n    isBeforeHook = isBeforeHook && doesHaveValue(testStep.hookId)\n\n    let keyword, keywordType, pickleStep\n    if (doesHaveValue(testStep.pickleStepId)) {\n      pickleStep = pickleStepMap[testStep.pickleStepId]\n      keyword = getStepKeyword({ pickleStep, gherkinStepMap })\n      keywordType = getStepKeywordType({\n        keyword,\n        language: gherkinDocument.feature.language,\n        previousKeywordType,\n      })\n    }\n    const parsedStep = parseStep({\n      isBeforeHook,\n      gherkinStepMap,\n      keyword,\n      keywordType,\n      pickleStep,\n      pickleUri: relativePickleUri,\n      snippetBuilder,\n      supportCodeLibrary,\n      testStep,\n      testStepResult,\n      testStepAttachments: valueOrDefault(\n        testCaseAttempt.stepAttachments[testStep.id],\n        []\n      ),\n    })\n    parsedTestSteps.push(parsedStep)\n    previousKeywordType = keywordType\n  })\n  return {\n    testCase: parsedTestCase,\n    testSteps: parsedTestSteps,\n  }\n}\n"]}
+{"version":3,"file":"test_case_attempt_parser.js","sourceRoot":"","sources":["../../../src/formatter/helpers/test_case_attempt_parser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA8C;AAC9C,iDAAmD;AAGnD,uDAAmE;AAGnE,iDAAgE;AAChE,uEAGkC;AAClC,mDAAkE;AAyClE,SAAS,SAAS,CAAC,EACjB,YAAY,EACZ,cAAc,EACd,OAAO,EACP,WAAW,EACX,UAAU,EACV,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,mBAAmB,GACD;IAClB,MAAM,GAAG,GAAoB;QAC3B,WAAW,EAAE,mBAAmB;QAChC,OAAO,EAAE,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC;YAC3C,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,OAAO;QACX,MAAM,EAAE,cAAc;KACvB,CAAA;IACD,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,IAAI,cAAsC,CAAA;QAC1C,IAAI,YAAY,EAAE;YAChB,cAAc,GAAG,kBAAkB,CAAC,6BAA6B,CAAC,IAAI,CACpE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,MAAM,CAChC,CAAA;SACF;aAAM;YACL,cAAc,GAAG,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,CACnE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,MAAM,CAChC,CAAA;SACF;QACD,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,cAAc,CAAC,GAAG;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAA;QACD,GAAG,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAA;KAC/B;IACD,IACE,IAAA,6BAAa,EAAC,QAAQ,CAAC,iBAAiB,CAAC;QACzC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EACvC;QACA,MAAM,cAAc,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAC5D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAC9C,CAAA;QACD,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,cAAc,CAAC,GAAG;YACvB,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAA;KACF;IACD,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;QACxC,GAAG,CAAC,cAAc,GAAG;YACnB,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;SAC7D,CAAA;QACD,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC1B,IAAI,IAAA,6BAAa,EAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACtC,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;SACnC;KACF;IACD,IAAI,cAAc,CAAC,MAAM,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE;QACrE,GAAG,CAAC,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAA;KAChE;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAQD,yEAAyE;AACzE,mCAAmC;AACnC,SAAgB,oBAAoB,CAAC,EACnC,eAAe,EACf,cAAc,EACd,kBAAkB,GACW;IAC7B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAA,2CAAiB,EAAC,eAAe,CAAC,CAAA;IACzD,MAAM,0BAA0B,GAC9B,IAAA,uDAA6B,EAAC,eAAe,CAAC,CAAA;IAChD,MAAM,aAAa,GAAG,IAAA,gCAAgB,EAAC,MAAM,CAAC,CAAA;IAC9C,MAAM,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAA;IACpC,MAAM,cAAc,GAAoB;QACtC,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,cAAc,EAAE;YACd,GAAG,EAAE,iBAAiB;YACtB,IAAI,EAAE,0BAA0B,CAC9B,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAChD,CAAC,IAAI;SACP;QACD,mBAAmB,EAAE,eAAe,CAAC,mBAAmB;KACzD,CAAA;IACD,MAAM,eAAe,GAAsB,EAAE,CAAA;IAC7C,IAAI,YAAY,GAAG,IAAI,CAAA;IACvB,IAAI,mBAAmB,GAAG,0BAAW,CAAC,YAAY,CAAA;IAElD,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtC,MAAM,cAAc,GAClB,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,yBAAc,EAAE,CAAA;QAElE,YAAY,GAAG,YAAY,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAE7D,IAAI,OAAO,EAAE,WAAW,EAAE,UAAU,CAAA;QACpC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACxC,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;YACjD,OAAO,GAAG,IAAA,8BAAc,EAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA;YACxD,WAAW,GAAG,IAAA,iCAAkB,EAAC;gBAC/B,OAAO;gBACP,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ;gBAC1C,mBAAmB;aACpB,CAAC,CAAA;SACH;QACD,MAAM,UAAU,GAAG,SAAS,CAAC;YAC3B,YAAY;YACZ,cAAc;YACd,OAAO;YACP,WAAW;YACX,UAAU;YACV,SAAS,EAAE,iBAAiB;YAC5B,cAAc;YACd,kBAAkB;YAClB,QAAQ;YACR,cAAc;YACd,mBAAmB,EAAE,IAAA,8BAAc,EACjC,eAAe,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC5C,EAAE,CACH;SACF,CAAC,CAAA;QACF,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAChC,mBAAmB,GAAG,WAAW,CAAA;IACnC,CAAC,CAAC,CAAA;IACF,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,SAAS,EAAE,eAAe;KAC3B,CAAA;AACH,CAAC;AAjED,oDAiEC","sourcesContent":["import * as messages from '@cucumber/messages'\nimport { TestStepResult } from '@cucumber/messages'\nimport StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'\nimport { SupportCodeLibrary } from '../../support_code_library_builder/types'\nimport { doesHaveValue, valueOrDefault } from '../../value_checker'\nimport TestCaseHookDefinition from '../../models/test_case_hook_definition'\nimport { ILineAndUri } from '../../types'\nimport { getStepKeywordType, KeywordType } from './keyword_type'\nimport {\n  getGherkinScenarioLocationMap,\n  getGherkinStepMap,\n} from './gherkin_document_parser'\nimport { getPickleStepMap, getStepKeyword } from './pickle_parser'\nimport { ITestCaseAttempt } from './event_data_collector'\n\nexport interface IParsedTestStep {\n  actionLocation?: ILineAndUri\n  argument?: messages.PickleStepArgument\n  attachments: messages.Attachment[]\n  keyword: string\n  name?: string\n  result: messages.TestStepResult\n  snippet?: string\n  sourceLocation?: ILineAndUri\n  text?: string\n}\n\nexport interface IParsedTestCase {\n  attempt: number\n  name: string\n  sourceLocation?: ILineAndUri\n  worstTestStepResult: messages.TestStepResult\n}\n\nexport interface IParsedTestCaseAttempt {\n  testCase: IParsedTestCase\n  testSteps: IParsedTestStep[]\n}\n\ninterface IParseStepRequest {\n  isBeforeHook: boolean\n  gherkinStepMap: Record<string, messages.Step>\n  keyword: string\n  keywordType: KeywordType\n  pickleStep: messages.PickleStep\n  pickleUri: string\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: SupportCodeLibrary\n  testStep: messages.TestStep\n  testStepResult: messages.TestStepResult\n  testStepAttachments: messages.Attachment[]\n}\n\nfunction parseStep({\n  isBeforeHook,\n  gherkinStepMap,\n  keyword,\n  keywordType,\n  pickleStep,\n  pickleUri,\n  snippetBuilder,\n  supportCodeLibrary,\n  testStep,\n  testStepResult,\n  testStepAttachments,\n}: IParseStepRequest): IParsedTestStep {\n  const out: IParsedTestStep = {\n    attachments: testStepAttachments,\n    keyword: doesHaveValue(testStep.pickleStepId)\n      ? keyword\n      : isBeforeHook\n      ? 'Before'\n      : 'After',\n    result: testStepResult,\n  }\n  if (doesHaveValue(testStep.hookId)) {\n    let hookDefinition: TestCaseHookDefinition\n    if (isBeforeHook) {\n      hookDefinition = supportCodeLibrary.beforeTestCaseHookDefinitions.find(\n        (x) => x.id === testStep.hookId\n      )\n    } else {\n      hookDefinition = supportCodeLibrary.afterTestCaseHookDefinitions.find(\n        (x) => x.id === testStep.hookId\n      )\n    }\n    out.actionLocation = {\n      uri: hookDefinition.uri,\n      line: hookDefinition.line,\n    }\n    out.name = hookDefinition.name\n  }\n  if (\n    doesHaveValue(testStep.stepDefinitionIds) &&\n    testStep.stepDefinitionIds.length === 1\n  ) {\n    const stepDefinition = supportCodeLibrary.stepDefinitions.find(\n      (x) => x.id === testStep.stepDefinitionIds[0]\n    )\n    out.actionLocation = {\n      uri: stepDefinition.uri,\n      line: stepDefinition.line,\n    }\n  }\n  if (doesHaveValue(testStep.pickleStepId)) {\n    out.sourceLocation = {\n      uri: pickleUri,\n      line: gherkinStepMap[pickleStep.astNodeIds[0]].location.line,\n    }\n    out.text = pickleStep.text\n    if (doesHaveValue(pickleStep.argument)) {\n      out.argument = pickleStep.argument\n    }\n  }\n  if (testStepResult.status === messages.TestStepResultStatus.UNDEFINED) {\n    out.snippet = snippetBuilder.build({ keywordType, pickleStep })\n  }\n  return out\n}\n\nexport interface IParseTestCaseAttemptRequest {\n  testCaseAttempt: ITestCaseAttempt\n  snippetBuilder: StepDefinitionSnippetBuilder\n  supportCodeLibrary: SupportCodeLibrary\n}\n\n// Converts a testCaseAttempt into a json object with all data needed for\n// displaying it in a pretty format\nexport function parseTestCaseAttempt({\n  testCaseAttempt,\n  snippetBuilder,\n  supportCodeLibrary,\n}: IParseTestCaseAttemptRequest): IParsedTestCaseAttempt {\n  const { testCase, pickle, gherkinDocument } = testCaseAttempt\n  const gherkinStepMap = getGherkinStepMap(gherkinDocument)\n  const gherkinScenarioLocationMap =\n    getGherkinScenarioLocationMap(gherkinDocument)\n  const pickleStepMap = getPickleStepMap(pickle)\n  const relativePickleUri = pickle.uri\n  const parsedTestCase: IParsedTestCase = {\n    attempt: testCaseAttempt.attempt,\n    name: pickle.name,\n    sourceLocation: {\n      uri: relativePickleUri,\n      line: gherkinScenarioLocationMap[\n        pickle.astNodeIds[pickle.astNodeIds.length - 1]\n      ].line,\n    },\n    worstTestStepResult: testCaseAttempt.worstTestStepResult,\n  }\n  const parsedTestSteps: IParsedTestStep[] = []\n  let isBeforeHook = true\n  let previousKeywordType = KeywordType.Precondition\n\n  testCase.testSteps.forEach((testStep) => {\n    const testStepResult =\n      testCaseAttempt.stepResults[testStep.id] || new TestStepResult()\n\n    isBeforeHook = isBeforeHook && doesHaveValue(testStep.hookId)\n\n    let keyword, keywordType, pickleStep\n    if (doesHaveValue(testStep.pickleStepId)) {\n      pickleStep = pickleStepMap[testStep.pickleStepId]\n      keyword = getStepKeyword({ pickleStep, gherkinStepMap })\n      keywordType = getStepKeywordType({\n        keyword,\n        language: gherkinDocument.feature.language,\n        previousKeywordType,\n      })\n    }\n    const parsedStep = parseStep({\n      isBeforeHook,\n      gherkinStepMap,\n      keyword,\n      keywordType,\n      pickleStep,\n      pickleUri: relativePickleUri,\n      snippetBuilder,\n      supportCodeLibrary,\n      testStep,\n      testStepResult,\n      testStepAttachments: valueOrDefault(\n        testCaseAttempt.stepAttachments[testStep.id],\n        []\n      ),\n    })\n    parsedTestSteps.push(parsedStep)\n    previousKeywordType = keywordType\n  })\n  return {\n    testCase: parsedTestCase,\n    testSteps: parsedTestSteps,\n  }\n}\n"]}

package/lib/formatter/index.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 import { Writable } from 'node:stream';
 import { EventEmitter } from 'node:events';
-import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import { SupportCodeLibrary } from '../support_code_library_builder/types';
 import { IColorFns } from './get_color_fns';
 import { EventDataCollector } from './helpers';
 import StepDefinitionSnippetBuilder from './step_definition_snippet_builder';
@@ -18,10 +18,6 @@ export interface FormatOptions {
     printAttachments?: boolean;
     [customKey: string]: any;
 }
-export interface IPublishConfig {
-    url: string;
-    token: string;
-}
 export type IFormatterStream = Writable;
 export type IFormatterLogFn = (buffer: string | Uint8Array) => void;
 export type IFormatterCleanupFn = () => Promise<any>;
@@ -35,7 +31,7 @@ export interface IFormatterOptions {
     snippetBuilder: StepDefinitionSnippetBuilder;
     stream: Writable;
     cleanup: IFormatterCleanupFn;
-    supportCodeLibrary: ISupportCodeLibrary;
+    supportCodeLibrary: SupportCodeLibrary;
 }
 export default class Formatter {
     protected colorFns: IColorFns;
@@ -44,7 +40,7 @@ export default class Formatter {
     protected log: IFormatterLogFn;
     protected snippetBuilder: StepDefinitionSnippetBuilder;
     protected stream: Writable;
-    protected supportCodeLibrary: ISupportCodeLibrary;
+    protected supportCodeLibrary: SupportCodeLibrary;
     protected printAttachments: boolean;
     private readonly cleanup;
     static readonly documentation: string;

package/lib/formatter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/formatter/index.ts"],"names":[],"mappings":";;AAGA,oDAAiD;AAyCjD,MAAqB,SAAS;IAClB,QAAQ,CAAW;IACnB,GAAG,CAAQ;IACX,kBAAkB,CAAoB;IACtC,GAAG,CAAiB;IACpB,cAAc,CAA8B;IAC5C,MAAM,CAAU;IAChB,kBAAkB,CAAqB;IACvC,gBAAgB,CAAS;IAClB,OAAO,CAAqB;IAC7C,MAAM,CAAU,aAAa,CAAQ;IAErC,YAAY,OAA0B;QACpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAA,8BAAc,EACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAC1C,IAAI,CACL,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;IACtB,CAAC;CACF;AA9BD,4BA8BC","sourcesContent":["import { Writable } from 'node:stream'\nimport { EventEmitter } from 'node:events'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport { valueOrDefault } from '../value_checker'\nimport { IColorFns } from './get_color_fns'\nimport { EventDataCollector } from './helpers'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\n\nexport interface FormatRerunOptions {\n  separator?: string\n}\n\nexport interface FormatOptions {\n  colorsEnabled?: boolean\n  rerun?: FormatRerunOptions\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  printAttachments?: boolean\n  [customKey: string]: any\n}\n\nexport interface IPublishConfig {\n  url: string\n  token: string\n}\n\nexport type IFormatterStream = Writable\nexport type IFormatterLogFn = (buffer: string | Uint8Array) => void\nexport type IFormatterCleanupFn = () => Promise<any>\n\nexport interface IFormatterOptions {\n  colorFns: IColorFns\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  snippetBuilder: StepDefinitionSnippetBuilder\n  stream: Writable\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nexport default class Formatter {\n  protected colorFns: IColorFns\n  protected cwd: string\n  protected eventDataCollector: EventDataCollector\n  protected log: IFormatterLogFn\n  protected snippetBuilder: StepDefinitionSnippetBuilder\n  protected stream: Writable\n  protected supportCodeLibrary: ISupportCodeLibrary\n  protected printAttachments: boolean\n  private readonly cleanup: IFormatterCleanupFn\n  static readonly documentation: string\n\n  constructor(options: IFormatterOptions) {\n    this.colorFns = options.colorFns\n    this.cwd = options.cwd\n    this.eventDataCollector = options.eventDataCollector\n    this.log = options.log\n    this.snippetBuilder = options.snippetBuilder\n    this.stream = options.stream\n    this.supportCodeLibrary = options.supportCodeLibrary\n    this.cleanup = options.cleanup\n    this.printAttachments = valueOrDefault(\n      options.parsedArgvOptions.printAttachments,\n      true\n    )\n  }\n\n  async finished(): Promise<void> {\n    await this.cleanup()\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/formatter/index.ts"],"names":[],"mappings":";;AAGA,oDAAiD;AAoCjD,MAAqB,SAAS;IAClB,QAAQ,CAAW;IACnB,GAAG,CAAQ;IACX,kBAAkB,CAAoB;IACtC,GAAG,CAAiB;IACpB,cAAc,CAA8B;IAC5C,MAAM,CAAU;IAChB,kBAAkB,CAAoB;IACtC,gBAAgB,CAAS;IAClB,OAAO,CAAqB;IAC7C,MAAM,CAAU,aAAa,CAAQ;IAErC,YAAY,OAA0B;QACpC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAA,8BAAc,EACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAC1C,IAAI,CACL,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;IACtB,CAAC;CACF;AA9BD,4BA8BC","sourcesContent":["import { Writable } from 'node:stream'\nimport { EventEmitter } from 'node:events'\nimport { SupportCodeLibrary } from '../support_code_library_builder/types'\nimport { valueOrDefault } from '../value_checker'\nimport { IColorFns } from './get_color_fns'\nimport { EventDataCollector } from './helpers'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\n\nexport interface FormatRerunOptions {\n  separator?: string\n}\n\nexport interface FormatOptions {\n  colorsEnabled?: boolean\n  rerun?: FormatRerunOptions\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  printAttachments?: boolean\n  [customKey: string]: any\n}\n\nexport type IFormatterStream = Writable\nexport type IFormatterLogFn = (buffer: string | Uint8Array) => void\nexport type IFormatterCleanupFn = () => Promise<any>\n\nexport interface IFormatterOptions {\n  colorFns: IColorFns\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  snippetBuilder: StepDefinitionSnippetBuilder\n  stream: Writable\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: SupportCodeLibrary\n}\n\nexport default class Formatter {\n  protected colorFns: IColorFns\n  protected cwd: string\n  protected eventDataCollector: EventDataCollector\n  protected log: IFormatterLogFn\n  protected snippetBuilder: StepDefinitionSnippetBuilder\n  protected stream: Writable\n  protected supportCodeLibrary: SupportCodeLibrary\n  protected printAttachments: boolean\n  private readonly cleanup: IFormatterCleanupFn\n  static readonly documentation: string\n\n  constructor(options: IFormatterOptions) {\n    this.colorFns = options.colorFns\n    this.cwd = options.cwd\n    this.eventDataCollector = options.eventDataCollector\n    this.log = options.log\n    this.snippetBuilder = options.snippetBuilder\n    this.stream = options.stream\n    this.supportCodeLibrary = options.supportCodeLibrary\n    this.cleanup = options.cleanup\n    this.printAttachments = valueOrDefault(\n      options.parsedArgvOptions.printAttachments,\n      true\n    )\n  }\n\n  async finished(): Promise<void> {\n    await this.cleanup()\n  }\n}\n"]}

package/lib/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * User code functions and helpers
+ *
+ * @packageDocumentation
+ * @module (root)
+ * @remarks
+ * These docs cover the functions and helpers for user code registration and test setup. The entry point is `@cucumber/cucumber`.
+ */
 import * as messages from '@cucumber/messages';
 import { default as _Cli } from './cli';
 import * as cliHelpers from './cli/helpers';
@@ -5,10 +13,10 @@ import * as formatterHelpers from './formatter/helpers';
 import { default as _PickleFilter } from './pickle_filter';
 import * as parallelCanAssignHelpers from './support_code_library_builder/parallel_can_assign_helpers';
 import { default as _Runtime } from './runtime';
+export declare const version: string;
 export { default as supportCodeLibraryBuilder } from './support_code_library_builder';
 export { default as DataTable } from './models/data_table';
 export { default as TestCaseHookDefinition } from './models/test_case_hook_definition';
-export { version } from './version';
 export { default as Formatter, IFormatterOptions } from './formatter';
 export { default as FormatterBuilder } from './formatter/builder';
 export { default as JsonFormatter } from './formatter/json_formatter';
@@ -40,19 +48,19 @@ export { ITestCaseHookParameter, ITestStepHookParameter, } from './support_code_
 export declare const Status: typeof messages.TestStepResultStatus;
 export { wrapPromiseWithTimeout } from './time';
 /**
- * @deprecated use `runCucumber` instead; see <https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md>
+ * @deprecated use `runCucumber` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md
  */
 export declare const Cli: typeof _Cli;
 /**
- * @deprecated use `loadSources` instead; see <https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md>
+ * @deprecated use `loadSources` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md
  */
 export declare const parseGherkinMessageStream: typeof cliHelpers.parseGherkinMessageStream;
 /**
- * @deprecated use `loadSources` instead; see <https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md>
+ * @deprecated use `loadSources` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md
  */
 export declare const PickleFilter: typeof _PickleFilter;
 /**
- * @deprecated use `runCucumber` instead; see <https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md>
+ * @deprecated use `runCucumber` instead; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md
  */
 export declare const Runtime: typeof _Runtime;
 export { INewRuntimeOptions, IRuntimeOptions } from './runtime';