@dev-blinq/cucumber-js 1.0.0

package/lib/formatter/progress_bar_formatter.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("./helpers");
+const _1 = __importDefault(require("./"));
+const progress_1 = __importDefault(require("progress"));
+const value_checker_1 = require("../value_checker");
+const issue_helpers_1 = require("./helpers/issue_helpers");
+const time_1 = require("../time");
+// Inspired by https://github.com/thekompanee/fuubar and https://github.com/martinciu/fuubar-cucumber
+class ProgressBarFormatter extends _1.default {
+    constructor(options) {
+        super(options);
+        options.eventBroadcaster.on('envelope', this.parseEnvelope.bind(this));
+        this.numberOfSteps = 0;
+        this.issueCount = 0;
+    }
+    incrementStepCount(pickleId) {
+        const pickle = this.eventDataCollector.getPickle(pickleId);
+        this.numberOfSteps += pickle.steps.length;
+    }
+    initializeProgressBar() {
+        if ((0, value_checker_1.doesHaveValue)(this.progressBar)) {
+            return;
+        }
+        this.progressBar = new progress_1.default(':current/:total steps [:bar] ', {
+            clear: true,
+            incomplete: ' ',
+            stream: this.stream,
+            total: this.numberOfSteps,
+            width: (0, value_checker_1.valueOrDefault)(this.stream.columns, 80),
+        });
+    }
+    logProgress({ testStepId, testCaseStartedId, }) {
+        const { testCase } = this.eventDataCollector.getTestCaseAttempt(testCaseStartedId);
+        const testStep = testCase.testSteps.find((s) => s.id === testStepId);
+        if ((0, value_checker_1.doesHaveValue)(testStep.pickleStepId)) {
+            this.progressBar.tick();
+        }
+    }
+    logUndefinedParametertype(parameterType) {
+        this.log(`Undefined parameter type: ${(0, issue_helpers_1.formatUndefinedParameterType)(parameterType)}\n`);
+    }
+    logErrorIfNeeded(testCaseFinished) {
+        const { worstTestStepResult } = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId);
+        if ((0, helpers_1.isIssue)(worstTestStepResult)) {
+            this.issueCount += 1;
+            const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId);
+            this.progressBar.interrupt((0, helpers_1.formatIssue)({
+                colorFns: this.colorFns,
+                number: this.issueCount,
+                snippetBuilder: this.snippetBuilder,
+                supportCodeLibrary: this.supportCodeLibrary,
+                testCaseAttempt,
+                printAttachments: this.printAttachments,
+            }));
+            if (testCaseFinished.willBeRetried) {
+                const stepsToRetry = testCaseAttempt.pickle.steps.length;
+                this.progressBar.tick(-stepsToRetry);
+            }
+        }
+    }
+    logSummary(testRunFinished) {
+        const testRunDuration = (0, time_1.durationBetweenTimestamps)(this.testRunStarted.timestamp, testRunFinished.timestamp);
+        this.log((0, helpers_1.formatSummary)({
+            colorFns: this.colorFns,
+            testCaseAttempts: this.eventDataCollector.getTestCaseAttempts(),
+            testRunDuration,
+        }));
+    }
+    parseEnvelope(envelope) {
+        if ((0, value_checker_1.doesHaveValue)(envelope.undefinedParameterType)) {
+            this.logUndefinedParametertype(envelope.undefinedParameterType);
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testCase)) {
+            this.incrementStepCount(envelope.testCase.pickleId);
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testStepStarted)) {
+            this.initializeProgressBar();
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testStepFinished)) {
+            this.logProgress(envelope.testStepFinished);
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testCaseFinished)) {
+            this.logErrorIfNeeded(envelope.testCaseFinished);
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testRunStarted)) {
+            this.testRunStarted = envelope.testRunStarted;
+        }
+        else if ((0, value_checker_1.doesHaveValue)(envelope.testRunFinished)) {
+            this.logSummary(envelope.testRunFinished);
+        }
+    }
+}
+exports.default = ProgressBarFormatter;
+ProgressBarFormatter.documentation = 'Similar to the Progress Formatter, but provides a real-time updating progress bar based on the total number of steps to be executed in the test run';
+//# sourceMappingURL=progress_bar_formatter.js.map

package/lib/formatter/progress_bar_formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress_bar_formatter.js","sourceRoot":"","sources":["../../src/formatter/progress_bar_formatter.ts"],"names":[],"mappings":";;;;;AAAA,uCAA+D;AAC/D,0CAAiD;AACjD,wDAAkC;AAGlC,oDAAgE;AAChE,2DAAsE;AACtE,kCAAmD;AAEnD,qGAAqG;AACrG,MAAqB,oBAAqB,SAAQ,UAAS;IAQzD,YAAY,OAA0B;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACtE,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,kBAAkB,CAAC,QAAgB;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC1D,IAAI,CAAC,aAAa,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAA;IAC3C,CAAC;IAED,qBAAqB;QACnB,IAAI,IAAA,6BAAa,EAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACnC,OAAM;SACP;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAW,CAAC,+BAA+B,EAAE;YAClE,KAAK,EAAE,IAAI;YACX,UAAU,EAAE,GAAG;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,aAAa;YACzB,KAAK,EAAE,IAAA,8BAAc,EAAE,IAAI,CAAC,MAAyB,CAAC,OAAO,EAAE,EAAE,CAAC;SACnE,CAAC,CAAA;IACJ,CAAC;IAED,WAAW,CAAC,EACV,UAAU,EACV,iBAAiB,GACS;QAC1B,MAAM,EAAE,QAAQ,EAAE,GAChB,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;QAC/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,UAAU,CAAC,CAAA;QACpE,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YACxC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;SACxB;IACH,CAAC;IAED,yBAAyB,CACvB,aAA8C;QAE9C,IAAI,CAAC,GAAG,CACN,6BAA6B,IAAA,4CAA4B,EACvD,aAAa,CACd,IAAI,CACN,CAAA;IACH,CAAC;IAED,gBAAgB,CAAC,gBAA2C;QAC1D,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CACxE,gBAAgB,CAAC,iBAAiB,CACnC,CAAA;QACD,IAAI,IAAA,iBAAO,EAAC,mBAAmB,CAAC,EAAE;YAChC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAA;YACpB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAChE,gBAAgB,CAAC,iBAAiB,CACnC,CAAA;YACD,IAAI,CAAC,WAAW,CAAC,SAAS,CACxB,IAAA,qBAAW,EAAC;gBACV,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,MAAM,EAAE,IAAI,CAAC,UAAU;gBACvB,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,eAAe;gBACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;aACxC,CAAC,CACH,CAAA;YACD,IAAI,gBAAgB,CAAC,aAAa,EAAE;gBAClC,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAA;gBACxD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAA;aACrC;SACF;IACH,CAAC;IAED,UAAU,CAAC,eAAyC;QAClD,MAAM,eAAe,GAAG,IAAA,gCAAyB,EAC/C,IAAI,CAAC,cAAc,CAAC,SAAS,EAC7B,eAAe,CAAC,SAAS,CAC1B,CAAA;QACD,IAAI,CAAC,GAAG,CACN,IAAA,uBAAa,EAAC;YACZ,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,gBAAgB,EAAE,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,EAAE;YAC/D,eAAe;SAChB,CAAC,CACH,CAAA;IACH,CAAC;IAED,aAAa,CAAC,QAA2B;QACvC,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,sBAAsB,CAAC,EAAE;YAClD,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;SAChE;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC3C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;SACpD;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;YAClD,IAAI,CAAC,qBAAqB,EAAE,CAAA;SAC7B;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;YACnD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;SAC5C;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;YACnD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;SACjD;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;YACjD,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAA;SAC9C;aAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;YAClD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;SAC1C;IACH,CAAC;;AA/GH,uCAgHC;AA3GwB,kCAAa,GAClC,qJAAqJ,CAAA","sourcesContent":["import { formatIssue, formatSummary, isIssue } from './helpers'\nimport Formatter, { IFormatterOptions } from './'\nimport ProgressBar from 'progress'\nimport { WriteStream as TtyWriteStream } from 'tty'\nimport * as messages from '@cucumber/messages'\nimport { doesHaveValue, valueOrDefault } from '../value_checker'\nimport { formatUndefinedParameterType } from './helpers/issue_helpers'\nimport { durationBetweenTimestamps } from '../time'\n\n// Inspired by https://github.com/thekompanee/fuubar and https://github.com/martinciu/fuubar-cucumber\nexport default class ProgressBarFormatter extends Formatter {\n  private numberOfSteps: number\n  private testRunStarted: messages.TestRunStarted\n  private issueCount: number\n  public progressBar: ProgressBar\n  public static readonly documentation: string =\n    'Similar to the Progress Formatter, but provides a real-time updating progress bar based on the total number of steps to be executed in the test run'\n\n  constructor(options: IFormatterOptions) {\n    super(options)\n    options.eventBroadcaster.on('envelope', this.parseEnvelope.bind(this))\n    this.numberOfSteps = 0\n    this.issueCount = 0\n  }\n\n  incrementStepCount(pickleId: string): void {\n    const pickle = this.eventDataCollector.getPickle(pickleId)\n    this.numberOfSteps += pickle.steps.length\n  }\n\n  initializeProgressBar(): void {\n    if (doesHaveValue(this.progressBar)) {\n      return\n    }\n    this.progressBar = new ProgressBar(':current/:total steps [:bar] ', {\n      clear: true,\n      incomplete: ' ',\n      stream: this.stream,\n      total: this.numberOfSteps,\n      width: valueOrDefault((this.stream as TtyWriteStream).columns, 80),\n    })\n  }\n\n  logProgress({\n    testStepId,\n    testCaseStartedId,\n  }: messages.TestStepFinished): void {\n    const { testCase } =\n      this.eventDataCollector.getTestCaseAttempt(testCaseStartedId)\n    const testStep = testCase.testSteps.find((s) => s.id === testStepId)\n    if (doesHaveValue(testStep.pickleStepId)) {\n      this.progressBar.tick()\n    }\n  }\n\n  logUndefinedParametertype(\n    parameterType: messages.UndefinedParameterType\n  ): void {\n    this.log(\n      `Undefined parameter type: ${formatUndefinedParameterType(\n        parameterType\n      )}\\n`\n    )\n  }\n\n  logErrorIfNeeded(testCaseFinished: messages.TestCaseFinished): void {\n    const { worstTestStepResult } = this.eventDataCollector.getTestCaseAttempt(\n      testCaseFinished.testCaseStartedId\n    )\n    if (isIssue(worstTestStepResult)) {\n      this.issueCount += 1\n      const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(\n        testCaseFinished.testCaseStartedId\n      )\n      this.progressBar.interrupt(\n        formatIssue({\n          colorFns: this.colorFns,\n          number: this.issueCount,\n          snippetBuilder: this.snippetBuilder,\n          supportCodeLibrary: this.supportCodeLibrary,\n          testCaseAttempt,\n          printAttachments: this.printAttachments,\n        })\n      )\n      if (testCaseFinished.willBeRetried) {\n        const stepsToRetry = testCaseAttempt.pickle.steps.length\n        this.progressBar.tick(-stepsToRetry)\n      }\n    }\n  }\n\n  logSummary(testRunFinished: messages.TestRunFinished): void {\n    const testRunDuration = durationBetweenTimestamps(\n      this.testRunStarted.timestamp,\n      testRunFinished.timestamp\n    )\n    this.log(\n      formatSummary({\n        colorFns: this.colorFns,\n        testCaseAttempts: this.eventDataCollector.getTestCaseAttempts(),\n        testRunDuration,\n      })\n    )\n  }\n\n  parseEnvelope(envelope: messages.Envelope): void {\n    if (doesHaveValue(envelope.undefinedParameterType)) {\n      this.logUndefinedParametertype(envelope.undefinedParameterType)\n    } else if (doesHaveValue(envelope.testCase)) {\n      this.incrementStepCount(envelope.testCase.pickleId)\n    } else if (doesHaveValue(envelope.testStepStarted)) {\n      this.initializeProgressBar()\n    } else if (doesHaveValue(envelope.testStepFinished)) {\n      this.logProgress(envelope.testStepFinished)\n    } else if (doesHaveValue(envelope.testCaseFinished)) {\n      this.logErrorIfNeeded(envelope.testCaseFinished)\n    } else if (doesHaveValue(envelope.testRunStarted)) {\n      this.testRunStarted = envelope.testRunStarted\n    } else if (doesHaveValue(envelope.testRunFinished)) {\n      this.logSummary(envelope.testRunFinished)\n    }\n  }\n}\n"]}

package/lib/formatter/progress_formatter.d.ts

@@ -0,0 +1,9 @@
+import SummaryFormatter from './summary_formatter';
+import { IFormatterOptions } from './index';
+import * as messages from '@cucumber/messages';
+import ITestStepFinished = messages.TestStepFinished;
+export default class ProgressFormatter extends SummaryFormatter {
+    static readonly documentation: string;
+    constructor(options: IFormatterOptions);
+    logProgress({ testStepResult: { status } }: ITestStepFinished): void;
+}

package/lib/formatter/progress_formatter.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summary_formatter_1 = __importDefault(require("./summary_formatter"));
+const value_checker_1 = require("../value_checker");
+const messages = __importStar(require("@cucumber/messages"));
+const STATUS_CHARACTER_MAPPING = new Map([
+    [messages.TestStepResultStatus.AMBIGUOUS, 'A'],
+    [messages.TestStepResultStatus.FAILED, 'F'],
+    [messages.TestStepResultStatus.PASSED, '.'],
+    [messages.TestStepResultStatus.PENDING, 'P'],
+    [messages.TestStepResultStatus.SKIPPED, '-'],
+    [messages.TestStepResultStatus.UNDEFINED, 'U'],
+]);
+class ProgressFormatter extends summary_formatter_1.default {
+    constructor(options) {
+        options.eventBroadcaster.on('envelope', (envelope) => {
+            if ((0, value_checker_1.doesHaveValue)(envelope.testRunFinished)) {
+                this.log('\n\n');
+            }
+            else if ((0, value_checker_1.doesHaveValue)(envelope.testStepFinished)) {
+                this.logProgress(envelope.testStepFinished);
+            }
+        });
+        super(options);
+    }
+    logProgress({ testStepResult: { status } }) {
+        const character = this.colorFns.forStatus(status)(STATUS_CHARACTER_MAPPING.get(status));
+        this.log(character);
+    }
+}
+exports.default = ProgressFormatter;
+ProgressFormatter.documentation = 'Prints one character per scenario.';
+//# sourceMappingURL=progress_formatter.js.map

package/lib/formatter/progress_formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress_formatter.js","sourceRoot":"","sources":["../../src/formatter/progress_formatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4EAAkD;AAClD,oDAAgD;AAEhD,6DAA8C;AAI9C,MAAM,wBAAwB,GAC5B,IAAI,GAAG,CAAC;IACN,CAAC,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,GAAG,CAAC;IAC9C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC;IAC3C,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC;IAC3C,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;AAEJ,MAAqB,iBAAkB,SAAQ,2BAAgB;IAI7D,YAAY,OAA0B;QACpC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAmB,EAAE,EAAE;YAC9D,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;gBAC3C,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;aACjB;iBAAM,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;gBACnD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;aAC5C;QACH,CAAC,CAAC,CAAA;QACF,KAAK,CAAC,OAAO,CAAC,CAAA;IAChB,CAAC;IAED,WAAW,CAAC,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,EAAqB;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAC/C,wBAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,CACrC,CAAA;QACD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC;;AApBH,oCAqBC;AApBwB,+BAAa,GAClC,oCAAoC,CAAA","sourcesContent":["import SummaryFormatter from './summary_formatter'\nimport { doesHaveValue } from '../value_checker'\nimport { IFormatterOptions } from './index'\nimport * as messages from '@cucumber/messages'\nimport IEnvelope = messages.Envelope\nimport ITestStepFinished = messages.TestStepFinished\n\nconst STATUS_CHARACTER_MAPPING: Map<messages.TestStepResultStatus, string> =\n  new Map([\n    [messages.TestStepResultStatus.AMBIGUOUS, 'A'],\n    [messages.TestStepResultStatus.FAILED, 'F'],\n    [messages.TestStepResultStatus.PASSED, '.'],\n    [messages.TestStepResultStatus.PENDING, 'P'],\n    [messages.TestStepResultStatus.SKIPPED, '-'],\n    [messages.TestStepResultStatus.UNDEFINED, 'U'],\n  ])\n\nexport default class ProgressFormatter extends SummaryFormatter {\n  public static readonly documentation: string =\n    'Prints one character per scenario.'\n\n  constructor(options: IFormatterOptions) {\n    options.eventBroadcaster.on('envelope', (envelope: IEnvelope) => {\n      if (doesHaveValue(envelope.testRunFinished)) {\n        this.log('\\n\\n')\n      } else if (doesHaveValue(envelope.testStepFinished)) {\n        this.logProgress(envelope.testStepFinished)\n      }\n    })\n    super(options)\n  }\n\n  logProgress({ testStepResult: { status } }: ITestStepFinished): void {\n    const character = this.colorFns.forStatus(status)(\n      STATUS_CHARACTER_MAPPING.get(status)\n    )\n    this.log(character)\n  }\n}\n"]}

package/lib/formatter/rerun_formatter.d.ts

@@ -0,0 +1,13 @@
+import Formatter, { IFormatterOptions } from './';
+interface UriToLinesMap {
+    [uri: string]: number[];
+}
+export default class RerunFormatter extends Formatter {
+    protected readonly separator: string;
+    static readonly documentation: string;
+    constructor(options: IFormatterOptions);
+    getFailureMap(): UriToLinesMap;
+    formatFailedTestCases(): string;
+    logFailedTestCases(): void;
+}
+export {};

package/lib/formatter/rerun_formatter.js

@@ -0,0 +1,80 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = __importDefault(require("./"));
+const gherkin_document_parser_1 = require("./helpers/gherkin_document_parser");
+const value_checker_1 = require("../value_checker");
+const messages = __importStar(require("@cucumber/messages"));
+const DEFAULT_SEPARATOR = '\n';
+function isFailedAttempt(worstTestStepResult) {
+    return worstTestStepResult.status !== messages.TestStepResultStatus.PASSED;
+}
+class RerunFormatter extends _1.default {
+    constructor(options) {
+        super(options);
+        options.eventBroadcaster.on('envelope', (envelope) => {
+            if ((0, value_checker_1.doesHaveValue)(envelope.testRunFinished)) {
+                this.logFailedTestCases();
+            }
+        });
+        const rerunOptions = (0, value_checker_1.valueOrDefault)(options.parsedArgvOptions.rerun, {});
+        this.separator = (0, value_checker_1.valueOrDefault)(rerunOptions.separator, DEFAULT_SEPARATOR);
+    }
+    getFailureMap() {
+        const mapping = {};
+        this.eventDataCollector
+            .getTestCaseAttempts()
+            .forEach(({ gherkinDocument, pickle, worstTestStepResult, willBeRetried }) => {
+            if (isFailedAttempt(worstTestStepResult) && !willBeRetried) {
+                const relativeUri = pickle.uri;
+                const line = (0, gherkin_document_parser_1.getGherkinScenarioLocationMap)(gherkinDocument)[pickle.astNodeIds[pickle.astNodeIds.length - 1]].line;
+                if ((0, value_checker_1.doesNotHaveValue)(mapping[relativeUri])) {
+                    mapping[relativeUri] = [];
+                }
+                mapping[relativeUri].push(line);
+            }
+        });
+        return mapping;
+    }
+    formatFailedTestCases() {
+        const mapping = this.getFailureMap();
+        return Object.keys(mapping)
+            .map((uri) => {
+            const lines = mapping[uri];
+            return `${uri}:${lines.join(':')}`;
+        })
+            .join(this.separator);
+    }
+    logFailedTestCases() {
+        const failedTestCases = this.formatFailedTestCases();
+        this.log(failedTestCases);
+    }
+}
+exports.default = RerunFormatter;
+RerunFormatter.documentation = 'Prints failing files with line numbers.';
+//# sourceMappingURL=rerun_formatter.js.map

package/lib/formatter/rerun_formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rerun_formatter.js","sourceRoot":"","sources":["../../src/formatter/rerun_formatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAiD;AACjD,+EAAiF;AACjF,oDAIyB;AACzB,6DAA8C;AAE9C,MAAM,iBAAiB,GAAG,IAAI,CAAA;AAM9B,SAAS,eAAe,CAAC,mBAA4C;IACnE,OAAO,mBAAmB,CAAC,MAAM,KAAK,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAA;AAC5E,CAAC;AAED,MAAqB,cAAe,SAAQ,UAAS;IAKnD,YAAY,OAA0B;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAA2B,EAAE,EAAE;YACtE,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;gBAC3C,IAAI,CAAC,kBAAkB,EAAE,CAAA;aAC1B;QACH,CAAC,CAAC,CAAA;QACF,MAAM,YAAY,GAAG,IAAA,8BAAc,EAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACxE,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAc,EAAC,YAAY,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAA;IAC5E,CAAC;IAED,aAAa;QACX,MAAM,OAAO,GAAkB,EAAE,CAAA;QACjC,IAAI,CAAC,kBAAkB;aACpB,mBAAmB,EAAE;aACrB,OAAO,CACN,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,mBAAmB,EAAE,aAAa,EAAE,EAAE,EAAE;YAClE,IAAI,eAAe,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,EAAE;gBAC1D,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAA;gBAC9B,MAAM,IAAI,GACR,IAAA,uDAA6B,EAAC,eAAe,CAAC,CAC5C,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAChD,CAAC,IAAI,CAAA;gBACR,IAAI,IAAA,gCAAgB,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE;oBAC1C,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;iBAC1B;gBACD,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;aAChC;QACH,CAAC,CACF,CAAA;QAEH,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,qBAAqB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpC,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;aACxB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;YAC1B,OAAO,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QACpC,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACzB,CAAC;IAED,kBAAkB;QAChB,MAAM,eAAe,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAA;QACpD,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IAC3B,CAAC;;AArDH,iCAsDC;AApDwB,4BAAa,GAClC,yCAAyC,CAAA","sourcesContent":["import Formatter, { IFormatterOptions } from './'\nimport { getGherkinScenarioLocationMap } from './helpers/gherkin_document_parser'\nimport {\n  doesHaveValue,\n  doesNotHaveValue,\n  valueOrDefault,\n} from '../value_checker'\nimport * as messages from '@cucumber/messages'\n\nconst DEFAULT_SEPARATOR = '\\n'\n\ninterface UriToLinesMap {\n  [uri: string]: number[]\n}\n\nfunction isFailedAttempt(worstTestStepResult: messages.TestStepResult) {\n  return worstTestStepResult.status !== messages.TestStepResultStatus.PASSED\n}\n\nexport default class RerunFormatter extends Formatter {\n  protected readonly separator: string\n  public static readonly documentation: string =\n    'Prints failing files with line numbers.'\n\n  constructor(options: IFormatterOptions) {\n    super(options)\n    options.eventBroadcaster.on('envelope', (envelope: messages.Envelope) => {\n      if (doesHaveValue(envelope.testRunFinished)) {\n        this.logFailedTestCases()\n      }\n    })\n    const rerunOptions = valueOrDefault(options.parsedArgvOptions.rerun, {})\n    this.separator = valueOrDefault(rerunOptions.separator, DEFAULT_SEPARATOR)\n  }\n\n  getFailureMap(): UriToLinesMap {\n    const mapping: UriToLinesMap = {}\n    this.eventDataCollector\n      .getTestCaseAttempts()\n      .forEach(\n        ({ gherkinDocument, pickle, worstTestStepResult, willBeRetried }) => {\n          if (isFailedAttempt(worstTestStepResult) && !willBeRetried) {\n            const relativeUri = pickle.uri\n            const line =\n              getGherkinScenarioLocationMap(gherkinDocument)[\n                pickle.astNodeIds[pickle.astNodeIds.length - 1]\n              ].line\n            if (doesNotHaveValue(mapping[relativeUri])) {\n              mapping[relativeUri] = []\n            }\n            mapping[relativeUri].push(line)\n          }\n        }\n      )\n\n    return mapping\n  }\n\n  formatFailedTestCases(): string {\n    const mapping = this.getFailureMap()\n\n    return Object.keys(mapping)\n      .map((uri) => {\n        const lines = mapping[uri]\n        return `${uri}:${lines.join(':')}`\n      })\n      .join(this.separator)\n  }\n\n  logFailedTestCases(): void {\n    const failedTestCases = this.formatFailedTestCases()\n    this.log(failedTestCases)\n  }\n}\n"]}

package/lib/formatter/snippets_formatter.d.ts

@@ -0,0 +1,6 @@
+import Formatter, { IFormatterOptions } from './';
+export default class SnippetsFormatter extends Formatter {
+    static readonly documentation: string;
+    constructor(options: IFormatterOptions);
+    logSnippets(): void;
+}

package/lib/formatter/snippets_formatter.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = __importDefault(require("./"));
+const helpers_1 = require("./helpers");
+const value_checker_1 = require("../value_checker");
+const messages = __importStar(require("@cucumber/messages"));
+class SnippetsFormatter extends _1.default {
+    constructor(options) {
+        super(options);
+        options.eventBroadcaster.on('envelope', (envelope) => {
+            if ((0, value_checker_1.doesHaveValue)(envelope.testRunFinished)) {
+                this.logSnippets();
+            }
+        });
+    }
+    logSnippets() {
+        const snippets = [];
+        this.eventDataCollector.getTestCaseAttempts().forEach((testCaseAttempt) => {
+            const parsed = (0, helpers_1.parseTestCaseAttempt)({
+                snippetBuilder: this.snippetBuilder,
+                supportCodeLibrary: this.supportCodeLibrary,
+                testCaseAttempt,
+            });
+            parsed.testSteps.forEach((testStep) => {
+                if (testStep.result.status === messages.TestStepResultStatus.UNDEFINED) {
+                    snippets.push(testStep.snippet);
+                }
+            });
+        });
+        this.log(snippets.join('\n\n'));
+    }
+}
+exports.default = SnippetsFormatter;
+SnippetsFormatter.documentation = "The Snippets Formatter doesn't output anything regarding the test run; it just prints snippets to implement any undefined steps";
+//# sourceMappingURL=snippets_formatter.js.map

package/lib/formatter/snippets_formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snippets_formatter.js","sourceRoot":"","sources":["../../src/formatter/snippets_formatter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAiD;AACjD,uCAAgD;AAChD,oDAAgD;AAChD,6DAA8C;AAG9C,MAAqB,iBAAkB,SAAQ,UAAS;IAItD,YAAY,OAA0B;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAmB,EAAE,EAAE;YAC9D,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;gBAC3C,IAAI,CAAC,WAAW,EAAE,CAAA;aACnB;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAa,EAAE,CAAA;QAC7B,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YACxE,MAAM,MAAM,GAAG,IAAA,8BAAoB,EAAC;gBAClC,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,eAAe;aAChB,CAAC,CAAA;YACF,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACpC,IACE,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAClE;oBACA,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;iBAChC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACjC,CAAC;;AA9BH,oCA+BC;AA9BwB,+BAAa,GAClC,iIAAiI,CAAA","sourcesContent":["import Formatter, { IFormatterOptions } from './'\nimport { parseTestCaseAttempt } from './helpers'\nimport { doesHaveValue } from '../value_checker'\nimport * as messages from '@cucumber/messages'\nimport IEnvelope = messages.Envelope\n\nexport default class SnippetsFormatter extends Formatter {\n  public static readonly documentation: string =\n    \"The Snippets Formatter doesn't output anything regarding the test run; it just prints snippets to implement any undefined steps\"\n\n  constructor(options: IFormatterOptions) {\n    super(options)\n    options.eventBroadcaster.on('envelope', (envelope: IEnvelope) => {\n      if (doesHaveValue(envelope.testRunFinished)) {\n        this.logSnippets()\n      }\n    })\n  }\n\n  logSnippets(): void {\n    const snippets: string[] = []\n    this.eventDataCollector.getTestCaseAttempts().forEach((testCaseAttempt) => {\n      const parsed = parseTestCaseAttempt({\n        snippetBuilder: this.snippetBuilder,\n        supportCodeLibrary: this.supportCodeLibrary,\n        testCaseAttempt,\n      })\n      parsed.testSteps.forEach((testStep) => {\n        if (\n          testStep.result.status === messages.TestStepResultStatus.UNDEFINED\n        ) {\n          snippets.push(testStep.snippet)\n        }\n      })\n    })\n    this.log(snippets.join('\\n\\n'))\n  }\n}\n"]}

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

@@ -0,0 +1,20 @@
+import { KeywordType } from '../helpers';
+import { ISnippetSnytax } from './snippet_syntax';
+import { ParameterTypeRegistry } from '@cucumber/cucumber-expressions';
+import * as messages from '@cucumber/messages';
+export interface INewStepDefinitionSnippetBuilderOptions {
+    snippetSyntax: ISnippetSnytax;
+    parameterTypeRegistry: ParameterTypeRegistry;
+}
+export interface IBuildRequest {
+    keywordType: KeywordType;
+    pickleStep: messages.PickleStep;
+}
+export default class StepDefinitionSnippetBuilder {
+    private readonly snippetSyntax;
+    private readonly cucumberExpressionGenerator;
+    constructor({ snippetSyntax, parameterTypeRegistry, }: INewStepDefinitionSnippetBuilderOptions);
+    build({ keywordType, pickleStep }: IBuildRequest): string;
+    getFunctionName(keywordType: KeywordType): string;
+    getStepParameterNames(step: messages.PickleStep): string[];
+}

package/lib/formatter/step_definition_snippet_builder/index.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("../helpers");
+const step_arguments_1 = require("../../step_arguments");
+const cucumber_expressions_1 = require("@cucumber/cucumber-expressions");
+const value_checker_1 = require("../../value_checker");
+class StepDefinitionSnippetBuilder {
+    constructor({ snippetSyntax, parameterTypeRegistry, }) {
+        this.snippetSyntax = snippetSyntax;
+        this.cucumberExpressionGenerator = new cucumber_expressions_1.CucumberExpressionGenerator(() => parameterTypeRegistry.parameterTypes);
+    }
+    build({ keywordType, pickleStep }) {
+        const comment = 'Write code here that turns the phrase above into concrete actions';
+        const functionName = this.getFunctionName(keywordType);
+        const generatedExpressions = this.cucumberExpressionGenerator.generateExpressions(pickleStep.text);
+        const stepParameterNames = this.getStepParameterNames(pickleStep);
+        return this.snippetSyntax.build({
+            comment,
+            functionName,
+            generatedExpressions,
+            stepParameterNames,
+        });
+    }
+    getFunctionName(keywordType) {
+        switch (keywordType) {
+            case helpers_1.KeywordType.Event:
+                return 'When';
+            case helpers_1.KeywordType.Outcome:
+                return 'Then';
+            case helpers_1.KeywordType.Precondition:
+                return 'Given';
+        }
+    }
+    getStepParameterNames(step) {
+        if ((0, value_checker_1.doesHaveValue)(step.argument)) {
+            const argumentName = (0, step_arguments_1.parseStepArgument)(step.argument, {
+                dataTable: () => 'dataTable',
+                docString: () => 'docString',
+            });
+            return [argumentName];
+        }
+        return [];
+    }
+}
+exports.default = StepDefinitionSnippetBuilder;
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,7 @@
+import { ISnippetSnytax, ISnippetSyntaxBuildOptions, SnippetInterface } from './snippet_syntax';
+export default class JavaScriptSnippetSyntax implements ISnippetSnytax {
+    private readonly snippetInterface;
+    constructor(snippetInterface: SnippetInterface);
+    build({ comment, generatedExpressions, functionName, stepParameterNames, }: ISnippetSyntaxBuildOptions): string;
+    private escapeSpecialCharacters;
+}

package/lib/formatter/step_definition_snippet_builder/javascript_snippet_syntax.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const snippet_syntax_1 = require("./snippet_syntax");
+const CALLBACK_NAME = 'callback';
+class JavaScriptSnippetSyntax {
+    constructor(snippetInterface) {
+        this.snippetInterface = snippetInterface;
+    }
+    build({ comment, generatedExpressions, functionName, stepParameterNames, }) {
+        let functionKeyword = 'function ';
+        if (this.snippetInterface === snippet_syntax_1.SnippetInterface.AsyncAwait) {
+            functionKeyword = 'async ' + functionKeyword;
+        }
+        let implementation;
+        if (this.snippetInterface === snippet_syntax_1.SnippetInterface.Callback) {
+            implementation = `${CALLBACK_NAME}(null, 'pending');`;
+        }
+        else if (this.snippetInterface === snippet_syntax_1.SnippetInterface.Promise) {
+            implementation = "return Promise.resolve('pending');";
+        }
+        else {
+            implementation = "return 'pending';";
+        }
+        const definitionChoices = generatedExpressions.map((generatedExpression, index) => {
+            const prefix = index === 0 ? '' : '// ';
+            const allParameterNames = generatedExpression.parameterNames.concat(stepParameterNames);
+            if (this.snippetInterface === snippet_syntax_1.SnippetInterface.Callback) {
+                allParameterNames.push(CALLBACK_NAME);
+            }
+            return `${prefix + functionName}('${this.escapeSpecialCharacters(generatedExpression)}', ${functionKeyword}(${allParameterNames.join(', ')}) {\n`;
+        });
+        return (`${definitionChoices.join('')}  // ${comment}\n` +
+            `  ${implementation}\n` +
+            '});');
+    }
+    escapeSpecialCharacters(generatedExpression) {
+        let source = generatedExpression.source;
+        // double up any backslashes because we're in a javascript string
+        source = source.replace(/\\/g, '\\\\');
+        // escape any single quotes because that's our quote delimiter
+        source = source.replace(/'/g, "\\'");
+        return source;
+    }
+}
+exports.default = JavaScriptSnippetSyntax;
+//# sourceMappingURL=javascript_snippet_syntax.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"javascript_snippet_syntax.js","sourceRoot":"","sources":["../../../src/formatter/step_definition_snippet_builder/javascript_snippet_syntax.ts"],"names":[],"mappings":";;AACA,qDAIyB;AAEzB,MAAM,aAAa,GAAG,UAAU,CAAA;AAEhC,MAAqB,uBAAuB;IAG1C,YAAY,gBAAkC;QAC5C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,EACJ,OAAO,EACP,oBAAoB,EACpB,YAAY,EACZ,kBAAkB,GACS;QAC3B,IAAI,eAAe,GAAG,WAAW,CAAA;QACjC,IAAI,IAAI,CAAC,gBAAgB,KAAK,iCAAgB,CAAC,UAAU,EAAE;YACzD,eAAe,GAAG,QAAQ,GAAG,eAAe,CAAA;SAC7C;QAED,IAAI,cAAsB,CAAA;QAC1B,IAAI,IAAI,CAAC,gBAAgB,KAAK,iCAAgB,CAAC,QAAQ,EAAE;YACvD,cAAc,GAAG,GAAG,aAAa,oBAAoB,CAAA;SACtD;aAAM,IAAI,IAAI,CAAC,gBAAgB,KAAK,iCAAgB,CAAC,OAAO,EAAE;YAC7D,cAAc,GAAG,oCAAoC,CAAA;SACtD;aAAM;YACL,cAAc,GAAG,mBAAmB,CAAA;SACrC;QAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,GAAG,CAChD,CAAC,mBAAmB,EAAE,KAAK,EAAE,EAAE;YAC7B,MAAM,MAAM,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACvC,MAAM,iBAAiB,GACrB,mBAAmB,CAAC,cAAc,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;YAC/D,IAAI,IAAI,CAAC,gBAAgB,KAAK,iCAAgB,CAAC,QAAQ,EAAE;gBACvD,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;aACtC;YACD,OAAO,GAAG,MAAM,GAAG,YAAY,KAAK,IAAI,CAAC,uBAAuB,CAC9D,mBAAmB,CACpB,MAAM,eAAe,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC/D,CAAC,CACF,CAAA;QAED,OAAO,CACL,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,OAAO,IAAI;YAChD,KAAK,cAAc,IAAI;YACvB,KAAK,CACN,CAAA;IACH,CAAC;IAEO,uBAAuB,CAAC,mBAAwC;QACtE,IAAI,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAA;QACvC,iEAAiE;QACjE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QACtC,8DAA8D;QAC9D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACpC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAxDD,0CAwDC","sourcesContent":["import { GeneratedExpression } from '@cucumber/cucumber-expressions'\nimport {\n  ISnippetSnytax,\n  ISnippetSyntaxBuildOptions,\n  SnippetInterface,\n} from './snippet_syntax'\n\nconst CALLBACK_NAME = 'callback'\n\nexport default class JavaScriptSnippetSyntax implements ISnippetSnytax {\n  private readonly snippetInterface: SnippetInterface\n\n  constructor(snippetInterface: SnippetInterface) {\n    this.snippetInterface = snippetInterface\n  }\n\n  build({\n    comment,\n    generatedExpressions,\n    functionName,\n    stepParameterNames,\n  }: ISnippetSyntaxBuildOptions): string {\n    let functionKeyword = 'function '\n    if (this.snippetInterface === SnippetInterface.AsyncAwait) {\n      functionKeyword = 'async ' + functionKeyword\n    }\n\n    let implementation: string\n    if (this.snippetInterface === SnippetInterface.Callback) {\n      implementation = `${CALLBACK_NAME}(null, 'pending');`\n    } else if (this.snippetInterface === SnippetInterface.Promise) {\n      implementation = \"return Promise.resolve('pending');\"\n    } else {\n      implementation = \"return 'pending';\"\n    }\n\n    const definitionChoices = generatedExpressions.map(\n      (generatedExpression, index) => {\n        const prefix = index === 0 ? '' : '// '\n        const allParameterNames =\n          generatedExpression.parameterNames.concat(stepParameterNames)\n        if (this.snippetInterface === SnippetInterface.Callback) {\n          allParameterNames.push(CALLBACK_NAME)\n        }\n        return `${prefix + functionName}('${this.escapeSpecialCharacters(\n          generatedExpression\n        )}', ${functionKeyword}(${allParameterNames.join(', ')}) {\\n`\n      }\n    )\n\n    return (\n      `${definitionChoices.join('')}  // ${comment}\\n` +\n      `  ${implementation}\\n` +\n      '});'\n    )\n  }\n\n  private escapeSpecialCharacters(generatedExpression: GeneratedExpression) {\n    let source = generatedExpression.source\n    // double up any backslashes because we're in a javascript string\n    source = source.replace(/\\\\/g, '\\\\\\\\')\n    // escape any single quotes because that's our quote delimiter\n    source = source.replace(/'/g, \"\\\\'\")\n    return source\n  }\n}\n"]}

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

@@ -0,0 +1,16 @@
+import { GeneratedExpression } from '@cucumber/cucumber-expressions';
+export declare enum SnippetInterface {
+    AsyncAwait = "async-await",
+    Callback = "callback",
+    Promise = "promise",
+    Synchronous = "synchronous"
+}
+export interface ISnippetSyntaxBuildOptions {
+    comment: string;
+    functionName: string;
+    generatedExpressions: readonly GeneratedExpression[];
+    stepParameterNames: string[];
+}
+export interface ISnippetSnytax {
+    build: (options: ISnippetSyntaxBuildOptions) => string;
+}

package/lib/formatter/step_definition_snippet_builder/snippet_syntax.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnippetInterface = void 0;
+var SnippetInterface;
+(function (SnippetInterface) {
+    SnippetInterface["AsyncAwait"] = "async-await";
+    SnippetInterface["Callback"] = "callback";
+    SnippetInterface["Promise"] = "promise";
+    SnippetInterface["Synchronous"] = "synchronous";
+})(SnippetInterface = exports.SnippetInterface || (exports.SnippetInterface = {}));
+//# sourceMappingURL=snippet_syntax.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snippet_syntax.js","sourceRoot":"","sources":["../../../src/formatter/step_definition_snippet_builder/snippet_syntax.ts"],"names":[],"mappings":";;;AAEA,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,8CAA0B,CAAA;IAC1B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;AAC7B,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B","sourcesContent":["import { GeneratedExpression } from '@cucumber/cucumber-expressions'\n\nexport enum SnippetInterface {\n  AsyncAwait = 'async-await',\n  Callback = 'callback',\n  Promise = 'promise',\n  Synchronous = 'synchronous',\n}\n\nexport interface ISnippetSyntaxBuildOptions {\n  comment: string\n  functionName: string\n  generatedExpressions: readonly GeneratedExpression[]\n  stepParameterNames: string[]\n}\n\nexport interface ISnippetSnytax {\n  build: (options: ISnippetSyntaxBuildOptions) => string\n}\n"]}

package/lib/formatter/summary_formatter.d.ts

@@ -0,0 +1,14 @@
+import Formatter, { IFormatterOptions } from './';
+import * as messages from '@cucumber/messages';
+import { ITestCaseAttempt } from './helpers/event_data_collector';
+interface ILogIssuesRequest {
+    issues: ITestCaseAttempt[];
+    title: string;
+}
+export default class SummaryFormatter extends Formatter {
+    static readonly documentation: string;
+    constructor(options: IFormatterOptions);
+    logSummary(testRunDuration: messages.Duration): void;
+    logIssues({ issues, title }: ILogIssuesRequest): void;
+}
+export {};