@lynxwall/cucumber-tsflow 6.5.6 → 7.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 # cucumber-tsflow
 
-Provides 'specflow' like bindings for CucumberJS 9.6.0+ in TypeScript 5.0+.
+Provides 'specflow' like bindings for CucumberJS 11.2.0+ in TypeScript 5.8+.
 
 Supports Vue3 files in cucumber tests.
 
@@ -20,7 +20,7 @@ In addition, the following features have been added:
     - **2** - Implemented scenarios are passing but there are pending, undefined or unknown scenario steps.
     - **3** - One or more scenario steps have failed.
 
-- Typescript and esbuild transpiler support.
+- CommonJS transpilers using either esbuild or ts-node.
 
 - Vue3 transformer used to handle .vue files in tests.
 
@@ -61,6 +61,12 @@ cucumber-tsflow uses TypeScript Decorators to create SpecFlow like bindings for
 npm install @lynxwall/cucumber-tsflow --save-dev
 ```
 
+#### pnpm
+
+```bash
+pnpm add @lynxwall/cucumber-tsflow --save-dev
+```
+
 #### yarn
 
 ```bash
@@ -230,9 +236,9 @@ In addition to cucumber configuration options the following two options have bee
 | `debugFile`      | `string`  | No         | `--debug-file`       | Path to a file with steps for debugging                      |         |
 | `enableVueStyle` | `boolean` | No         | `--enable-vue-style` | Enable Vue `<style>` block when compiling Vue SFC.           | false   |
 
-#### Transpiler and Vue3 supported
+### Transpiler and Vue3 supported
 
-Using TypeScript with cucumberJs requires a couple of tsconfig.json parameters as described here: [Transpiling](https://github.com/cucumber/cucumber-js/blob/v9.1.0/docs/transpiling.md)
+Using TypeScript with CucumberJs requires a couple of tsconfig.json parameters as described here: [Transpiling](https://github.com/cucumber/cucumber-js/blob/v11.2.0/docs/transpiling.md). In addition, there is no support for transpiling Vue files with CucumberJS. 
 
 As a result, cucumber-tsflow adds several configurations for transpiling TypeScript code using the recommended configuration. In addition, support has been added to transform .vue files during test execution allowing you to test Vue SFC components using cucumber.
 
@@ -247,6 +253,10 @@ The following transpilers are provided:
 - **tsvue**: Uses typescript to transpile TypeScript code and adds a hook for .vue files, which transforms Vue SFC components into commonJS.
   - **jsdom** is also loaded globally to support loading and testing Vue SFC components.
 
+<div style="padding: 15px; border: 1px solid transparent; border-color: transparent; margin-bottom: 20px; border-radius: 4px; color: #8a6d3b; background-color: #fcf8e3; border-color: #faebcc;">
+<strong><span style="color: #000">Note:</span></strong> The transpilers provide with cucumber-tsflow will only support CommonJS modules. In other words, if your package.json file has 'type: module' you will not be able to use these transpilers. However, you can use ts-node for transpiling as documented here: <a ref='https://github.com/cucumber/cucumber-js/blob/v11.2.0/docs/transpiling.md#esm'>Transpiling</a> 
+</div>
+
 ##### Using the transpiler configuration option
 
 When configuring cucumber to execute tests you can specify which transpiler to use with the `transpiler` configuration option as shown below:
@@ -266,12 +276,12 @@ You can also use the `requireModule` parameter to configure a transpiler. The fo
 ```json
 {
 	"default": {
-		"requireModule": ["@lynxwall/cucumber-tsflow/lib/esvue"]
+		"requireModule": ["@lynxwall/cucumber-tsflow/esvue"]
 	}
 }
 ```
 
-#### Debug File support
+### Debug File support
 
 The new `debugFile` configuration option allows you to specify a .ts file with step definitions that you want to debug. This will search for a matching feature and execute the tests in that feature. This option is helpful when debugging tests and you don't want to run all of the tests.
 
@@ -284,9 +294,9 @@ If using VSCode to edit your project the following launch configurations can be
 	"name": "Debug All",
 	"type": "node",
 	"request": "launch",
-	"program": "${workspaceRoot}/node_modules/@lynxwall/cucumber-tsflow/bin/cucumber-tsflow",
+	"program": "${workspaceRoot}/node_modules/@lynxwall/cucumber-tsflow/bin/cucumber-tsflow/vue",
 	"stopOnEntry": true,
-	"args": ["-p", "default"],
+	"args": ["-p", "esvue"],
 	"cwd": "${workspaceRoot}",
 	"runtimeExecutable": null,
 	"runtimeArgs": ["--nolazy"],
@@ -305,9 +315,9 @@ If using VSCode to edit your project the following launch configurations can be
 	"name": "Debug Feature",
 	"type": "node",
 	"request": "launch",
-	"program": "${workspaceRoot}/node_modules/@lynxwall/cucumber-tsflow/bin/cucumber-tsflow",
+	"program": "${workspaceRoot}/node_modules/@lynxwall/cucumber-tsflow/bin/cucumber-tsflow/vue",
 	"stopOnEntry": true,
-	"args": ["--debug-file", "${file}", "-p", "default"],
+	"args": ["--debug-file", "${file}", "-p", "esvue"],
 	"cwd": "${workspaceRoot}",
 	"runtimeExecutable": null,
 	"runtimeArgs": ["--nolazy"],
@@ -580,7 +590,7 @@ With Context Injection you first need to define one or more classes that will be
 
 ```typescript
 import { World } from '@cucumber/cucumber';
-import { EndTestCaseInfo, StartTestCaseInfo } from '@lynxwall/cucumber-tsflow/lib/cucumber/test-case-info';
+import { EndTestCaseInfo, StartTestCaseInfo } from '@lynxwall/cucumber-tsflow';
 
 export class ScenarioContext {
 	public world: World;
@@ -614,7 +624,7 @@ export class ScenarioContext {
 
 ```typescript
 import { World } from '@cucumber/cucumber';
-import { EndTestCaseInfo, StartTestCaseInfo } from '@lynxwall/cucumber-tsflow/lib/cucumber/test-case-info';
+import { EndTestCaseInfo, StartTestCaseInfo } from '@lynxwall/cucumber-tsflow';
 
 export class ScenarioContext {
 	public world: World;

package/api/index.d.ts

@@ -0,0 +1,6 @@
+/*
+allows TypeScript to see `@cucumber/cucumber/api` where it doesn't yet support
+subpath exports, see <https://github.com/microsoft/TypeScript/issues/33079>
+ */
+
+export * from '../lib/api';

package/bin/cucumber-tsflow

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
-require('../lib/cli/run.js').default();
+#!/usr/bin/env node
+
+require('../lib/cli/run.js').default();

package/bin/cucumber-tsflow.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/cli/run.js').default();

package/lib/api/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * JavaScript API for running and extending Cucumber
+ *
+ * @packageDocumentation
+ * @module api
+ * @remarks
+ * These docs cover the API used for running Cucumber-tsflow programmatically. The entry point is `@lynxwall/cucumber-tsflow/api`.
+ */
+export { IConfiguration } from '@cucumber/cucumber/lib/configuration/index';
+export { IRunEnvironment } from '@cucumber/cucumber/lib/environment/index';
+export { IPickleOrder } from '@cucumber/cucumber/lib/filter/index';
+export { IPublishConfig } from '@cucumber/cucumber/lib/publish/index';
+export * from './load-configuration';
+export * from '@cucumber/cucumber/lib/api/load_sources';
+export * from './load-support';
+export * from './run-cucumber';
+export * from '@cucumber/cucumber/lib/api/types';

package/lib/api/index.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * JavaScript API for running and extending Cucumber
+ *
+ * @packageDocumentation
+ * @module api
+ * @remarks
+ * These docs cover the API used for running Cucumber-tsflow programmatically. The entry point is `@lynxwall/cucumber-tsflow/api`.
+ */
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./load-configuration"), exports);
+__exportStar(require("@cucumber/cucumber/lib/api/load_sources"), exports);
+__exportStar(require("./load-support"), exports);
+__exportStar(require("./run-cucumber"), exports);
+__exportStar(require("@cucumber/cucumber/lib/api/types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;AAMH,uDAAqC;AACrC,0EAAwD;AACxD,iDAA+B;AAC/B,iDAA+B;AAC/B,mEAAiD","sourcesContent":["/**\r\n * JavaScript API for running and extending Cucumber\r\n *\r\n * @packageDocumentation\r\n * @module api\r\n * @remarks\r\n * These docs cover the API used for running Cucumber-tsflow programmatically. The entry point is `@lynxwall/cucumber-tsflow/api`.\r\n */\r\n\r\nexport { IConfiguration } from '@cucumber/cucumber/lib/configuration/index';\r\nexport { IRunEnvironment } from '@cucumber/cucumber/lib/environment/index';\r\nexport { IPickleOrder } from '@cucumber/cucumber/lib/filter/index';\r\nexport { IPublishConfig } from '@cucumber/cucumber/lib/publish/index';\r\nexport * from './load-configuration';\r\nexport * from '@cucumber/cucumber/lib/api/load_sources';\r\nexport * from './load-support';\r\nexport * from './run-cucumber';\r\nexport * from '@cucumber/cucumber/lib/api/types';\r\n"]}

package/lib/api/load-configuration.d.ts

@@ -0,0 +1,21 @@
+import { ILoadConfigurationOptions, IRunConfiguration } from '@cucumber/cucumber/lib/api/types';
+import { IRunEnvironment } from '@cucumber/cucumber/lib/environment/index';
+import { ITsflowConfiguration } from '../cli/argv-parser';
+export interface ITsflowResolvedConfiguration {
+    /**
+     * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.
+     */
+    useConfiguration: ITsflowConfiguration;
+    /**
+     * The format that can be passed into `runCucumber`.
+     */
+    runConfiguration: IRunConfiguration;
+}
+/**
+ * Load user-authored configuration to be used in a test run.
+ *
+ * @public
+ * @param options - Coordinates required to find configuration.
+ * @param environment - Project environment.
+ */
+export declare const loadConfiguration: (options?: ILoadConfigurationOptions, environment?: IRunEnvironment) => Promise<ITsflowResolvedConfiguration>;

package/lib/api/load-configuration.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfiguration = void 0;
+const locate_file_1 = require("@cucumber/cucumber/lib/configuration/locate_file");
+const index_1 = require("@cucumber/cucumber/lib/configuration/index");
+const validate_configuration_1 = require("@cucumber/cucumber/lib/configuration/validate_configuration");
+const convert_configuration_1 = require("@cucumber/cucumber/lib/api/convert_configuration");
+const index_2 = require("@cucumber/cucumber/lib/environment/index");
+const helpers_1 = require("../utils/helpers");
+const gherkin_manager_1 = __importDefault(require("../gherkin/gherkin-manager"));
+const ansis_1 = __importDefault(require("ansis"));
+/**
+ * Load user-authored configuration to be used in a test run.
+ *
+ * @public
+ * @param options - Coordinates required to find configuration.
+ * @param environment - Project environment.
+ */
+const loadConfiguration = async (options = {}, environment = {}) => {
+    const { cwd, env, logger } = (0, index_2.makeEnvironment)(environment);
+    const configFile = options.file ?? (0, locate_file_1.locateFile)(cwd);
+    if (configFile) {
+        logger.debug(`Configuration will be loaded from "${configFile}"`);
+    }
+    else if (configFile === false) {
+        logger.debug('Skipping configuration file resolution');
+    }
+    else {
+        logger.debug('No configuration file found');
+    }
+    const profileConfiguration = configFile ? await (0, index_1.fromFile)(logger, cwd, configFile, options.profiles) : {};
+    // if a feature was passed in on command line it's added
+    // to the provided configuration as paths. We need to clear
+    // any paths from configuration so that only the feature passed
+    // in is executed.
+    const paths = options.provided.paths;
+    if (paths && paths?.length > 0) {
+        profileConfiguration.paths = [];
+    }
+    const original = (0, index_1.mergeConfigurations)(index_1.DEFAULT_CONFIGURATION, profileConfiguration, (0, index_1.parseConfiguration)(logger, 'Provided', options.provided));
+    switch (original.transpiler) {
+        case 'esvue':
+            original.requireModule.push('@lynxwall/cucumber-tsflow/lib/esvue');
+            break;
+        case 'tsvue':
+            original.requireModule.push('@lynxwall/cucumber-tsflow/lib/tsvue');
+            break;
+        case 'tsnode':
+            original.requireModule.push('@lynxwall/cucumber-tsflow/lib/tsnode');
+            break;
+        default:
+            // defaulting to esbuild
+            original.requireModule.push('@lynxwall/cucumber-tsflow/lib/esnode');
+            break;
+    }
+    // set the snippet syntax
+    if (!original.formatOptions.snippetSyntax) {
+        original.formatOptions.snippetSyntax = '@lynxwall/cucumber-tsflow/snippet';
+    }
+    // look for behave format
+    for (let idx = 0; idx < original.format.length; idx++) {
+        if (typeof original.format[idx] === 'string') {
+            const formatItem = original.format[idx];
+            if (formatItem.startsWith('behave:')) {
+                original.format[idx] = formatItem.replace('behave', '@lynxwall/cucumber-tsflow/behave');
+            }
+        }
+        else if (original.format[idx].length > 0) {
+            const formatItem = original.format[idx][0];
+            if (formatItem.startsWith('behave')) {
+                const newVal = formatItem.replace('behave', '@lynxwall/cucumber-tsflow/behave');
+                original.format[idx] = original.format[idx].length > 1 ? [newVal, original.format[idx][1]] : [newVal];
+            }
+        }
+    }
+    // look for junitbamboo format
+    for (let idx = 0; idx < original.format.length; idx++) {
+        if (typeof original.format[idx] === 'string') {
+            const formatItem = original.format[idx];
+            if (formatItem.startsWith('junitbamboo:')) {
+                original.format[idx] = formatItem.replace('junitbamboo', '@lynxwall/cucumber-tsflow/junitbamboo');
+            }
+        }
+        else if (original.format[idx].length > 0) {
+            const formatItem = original.format[idx][0];
+            if (formatItem.startsWith('junitbamboo')) {
+                const newVal = formatItem.replace('junitbamboo', '@lynxwall/cucumber-tsflow/junitbamboo');
+                original.format[idx] = original.format[idx].length > 1 ? [newVal, original.format[idx][1]] : [newVal];
+            }
+        }
+    }
+    // check to see if a debugFile was passed in
+    if ((0, helpers_1.hasStringValue)(original.debugFile)) {
+        // Initialize gherkin manager with path to feature files
+        const gherkin = new gherkin_manager_1.default();
+        await gherkin.loadFeatures(original.paths);
+        const features = gherkin.findFeaturesByStepFile(original.debugFile);
+        if (features.length > 0) {
+            original.paths = [];
+            features.forEach(x => original.paths.push(x.featureFile));
+        }
+        else {
+            // log a message if the feature path is not found
+            logger.warn(ansis_1.default.yellow(`\nUnable to find feature for debugFile: ${original.debugFile}`));
+            logger.warn(ansis_1.default.yellow('All tests will be executed\n'));
+        }
+    }
+    // check to see if enable-vue-style was set
+    // if not, default it to false
+    if (original.enableVueStyle === null || original.enableVueStyle === undefined) {
+        original.enableVueStyle = false;
+    }
+    // set our global parameter used by the Vue transpiler
+    // to determine if Vue Style Blocks should be enabled
+    global.enableVueStyle = original.enableVueStyle;
+    (0, validate_configuration_1.validateConfiguration)(original, logger);
+    const runnable = await (0, convert_configuration_1.convertConfiguration)(logger, original, env);
+    return {
+        useConfiguration: original,
+        runConfiguration: runnable
+    };
+};
+exports.loadConfiguration = loadConfiguration;
+//# sourceMappingURL=load-configuration.js.map

package/lib/api/load-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-configuration.js","sourceRoot":"","sources":["../../src/api/load-configuration.ts"],"names":[],"mappings":";;;;;;AACA,kFAA8E;AAC9E,sEAMoD;AACpD,wGAAoG;AACpG,4FAAwF;AACxF,oEAA4F;AAE5F,8CAAkD;AAClD,iFAAwD;AACxD,kDAA0B;AAc1B;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,KAAK,EACrC,UAAqC,EAAE,EACvC,cAA+B,EAAE,EACO,EAAE;IAC1C,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAA,uBAAe,EAAC,WAAW,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,IAAA,wBAAU,EAAC,GAAG,CAAC,CAAC;IACnD,IAAI,UAAU,EAAE,CAAC;QAChB,MAAM,CAAC,KAAK,CAAC,sCAAsC,UAAU,GAAG,CAAC,CAAC;IACnE,CAAC;SAAM,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACxD,CAAC;SAAM,CAAC;QACP,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,oBAAoB,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEzG,wDAAwD;IACxD,2DAA2D;IAC3D,+DAA+D;IAC/D,kBAAkB;IAClB,MAAM,KAAK,GAAI,OAAO,CAAC,QAAoC,CAAC,KAAK,CAAC;IAClE,IAAI,KAAK,IAAI,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,oBAAoB,CAAC,KAAK,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,2BAAmB,EACnC,6BAAqB,EACrB,oBAAoB,EACpB,IAAA,0BAAkB,EAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAChC,CAAC;IAE1B,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC7B,KAAK,OAAO;YACX,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YACnE,MAAM;QACP,KAAK,OAAO;YACX,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YACnE,MAAM;QACP,KAAK,QAAQ;YACZ,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACpE,MAAM;QACP;YACC,wBAAwB;YACxB,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACpE,MAAM;IACR,CAAC;IACD,yBAAyB;IACzB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;QAC3C,QAAQ,CAAC,aAAa,CAAC,aAAa,GAAG,mCAAmC,CAAC;IAC5E,CAAC;IACD,yBAAyB;IACzB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QACvD,IAAI,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAW,CAAC;YAClD,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBACtC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;YACzF,CAAC;QACF,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAW,CAAC;YACrD,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAC;gBAChF,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACvG,CAAC;QACF,CAAC;IACF,CAAC;IAED,8BAA8B;IAC9B,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QACvD,IAAI,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAW,CAAC;YAClD,IAAI,UAAU,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC3C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,uCAAuC,CAAC,CAAC;YACnG,CAAC;QACF,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAW,CAAC;YACrD,IAAI,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,uCAAuC,CAAC,CAAC;gBAC1F,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACvG,CAAC;QACF,CAAC;IACF,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAA,wBAAc,EAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,wDAAwD;QACxD,MAAM,OAAO,GAAG,IAAI,yBAAc,EAAE,CAAC;QACrC,MAAM,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC;YACpB,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACP,iDAAiD;YACjD,MAAM,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,2CAA2C,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAC3D,CAAC;IACF,CAAC;IAED,2CAA2C;IAC3C,8BAA8B;IAC9B,IAAI,QAAQ,CAAC,cAAc,KAAK,IAAI,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAC/E,QAAQ,CAAC,cAAc,GAAG,KAAK,CAAC;IACjC,CAAC;IACD,sDAAsD;IACtD,qDAAqD;IACrD,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC;IAEhD,IAAA,8CAAqB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,4CAAoB,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnE,OAAO;QACN,gBAAgB,EAAE,QAAQ;QAC1B,gBAAgB,EAAE,QAAQ;KAC1B,CAAC;AACH,CAAC,CAAC;AAhHW,QAAA,iBAAiB,qBAgH5B","sourcesContent":["import { ILoadConfigurationOptions, IRunConfiguration } from '@cucumber/cucumber/lib/api/types';\r\nimport { locateFile } from '@cucumber/cucumber/lib/configuration/locate_file';\r\nimport {\r\n\tDEFAULT_CONFIGURATION,\r\n\tfromFile,\r\n\tIConfiguration,\r\n\tparseConfiguration,\r\n\tmergeConfigurations\r\n} from '@cucumber/cucumber/lib/configuration/index';\r\nimport { validateConfiguration } from '@cucumber/cucumber/lib/configuration/validate_configuration';\r\nimport { convertConfiguration } from '@cucumber/cucumber/lib/api/convert_configuration';\r\nimport { IRunEnvironment, makeEnvironment } from '@cucumber/cucumber/lib/environment/index';\r\nimport { ITsflowConfiguration } from '../cli/argv-parser';\r\nimport { hasStringValue } from '../utils/helpers';\r\nimport GherkinManager from '../gherkin/gherkin-manager';\r\nimport chalk from 'ansis';\r\nimport logger from '../utils/logger';\r\n\r\nexport interface ITsflowResolvedConfiguration {\r\n\t/**\r\n\t * The final flat configuration object resolved from the configuration file/profiles plus any extra provided.\r\n\t */\r\n\tuseConfiguration: ITsflowConfiguration;\r\n\t/**\r\n\t * The format that can be passed into `runCucumber`.\r\n\t */\r\n\trunConfiguration: IRunConfiguration;\r\n}\r\n\r\n/**\r\n * Load user-authored configuration to be used in a test run.\r\n *\r\n * @public\r\n * @param options - Coordinates required to find configuration.\r\n * @param environment - Project environment.\r\n */\r\nexport const loadConfiguration = async (\r\n\toptions: ILoadConfigurationOptions = {},\r\n\tenvironment: IRunEnvironment = {}\r\n): Promise<ITsflowResolvedConfiguration> => {\r\n\tconst { cwd, env, logger } = makeEnvironment(environment);\r\n\tconst configFile = options.file ?? locateFile(cwd);\r\n\tif (configFile) {\r\n\t\tlogger.debug(`Configuration will be loaded from \"${configFile}\"`);\r\n\t} else if (configFile === false) {\r\n\t\tlogger.debug('Skipping configuration file resolution');\r\n\t} else {\r\n\t\tlogger.debug('No configuration file found');\r\n\t}\r\n\tconst profileConfiguration = configFile ? await fromFile(logger, cwd, configFile, options.profiles) : {};\r\n\r\n\t// if a feature was passed in on command line it's added\r\n\t// to the provided configuration as paths. We need to clear\r\n\t// any paths from configuration so that only the feature passed\r\n\t// in is executed.\r\n\tconst paths = (options.provided as Partial<IConfiguration>).paths;\r\n\tif (paths && paths?.length > 0) {\r\n\t\tprofileConfiguration.paths = [];\r\n\t}\r\n\r\n\tconst original = mergeConfigurations(\r\n\t\tDEFAULT_CONFIGURATION,\r\n\t\tprofileConfiguration,\r\n\t\tparseConfiguration(logger, 'Provided', options.provided)\r\n\t) as ITsflowConfiguration;\r\n\r\n\tswitch (original.transpiler) {\r\n\t\tcase 'esvue':\r\n\t\t\toriginal.requireModule.push('@lynxwall/cucumber-tsflow/lib/esvue');\r\n\t\t\tbreak;\r\n\t\tcase 'tsvue':\r\n\t\t\toriginal.requireModule.push('@lynxwall/cucumber-tsflow/lib/tsvue');\r\n\t\t\tbreak;\r\n\t\tcase 'tsnode':\r\n\t\t\toriginal.requireModule.push('@lynxwall/cucumber-tsflow/lib/tsnode');\r\n\t\t\tbreak;\r\n\t\tdefault:\r\n\t\t\t// defaulting to esbuild\r\n\t\t\toriginal.requireModule.push('@lynxwall/cucumber-tsflow/lib/esnode');\r\n\t\t\tbreak;\r\n\t}\r\n\t// set the snippet syntax\r\n\tif (!original.formatOptions.snippetSyntax) {\r\n\t\toriginal.formatOptions.snippetSyntax = '@lynxwall/cucumber-tsflow/snippet';\r\n\t}\r\n\t// look for behave format\r\n\tfor (let idx = 0; idx < original.format.length; idx++) {\r\n\t\tif (typeof original.format[idx] === 'string') {\r\n\t\t\tconst formatItem = original.format[idx] as string;\r\n\t\t\tif (formatItem.startsWith('behave:')) {\r\n\t\t\t\toriginal.format[idx] = formatItem.replace('behave', '@lynxwall/cucumber-tsflow/behave');\r\n\t\t\t}\r\n\t\t} else if (original.format[idx].length > 0) {\r\n\t\t\tconst formatItem = original.format[idx][0] as string;\r\n\t\t\tif (formatItem.startsWith('behave')) {\r\n\t\t\t\tconst newVal = formatItem.replace('behave', '@lynxwall/cucumber-tsflow/behave');\r\n\t\t\t\toriginal.format[idx] = original.format[idx].length > 1 ? [newVal, original.format[idx][1]] : [newVal];\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\r\n\t// look for junitbamboo format\r\n\tfor (let idx = 0; idx < original.format.length; idx++) {\r\n\t\tif (typeof original.format[idx] === 'string') {\r\n\t\t\tconst formatItem = original.format[idx] as string;\r\n\t\t\tif (formatItem.startsWith('junitbamboo:')) {\r\n\t\t\t\toriginal.format[idx] = formatItem.replace('junitbamboo', '@lynxwall/cucumber-tsflow/junitbamboo');\r\n\t\t\t}\r\n\t\t} else if (original.format[idx].length > 0) {\r\n\t\t\tconst formatItem = original.format[idx][0] as string;\r\n\t\t\tif (formatItem.startsWith('junitbamboo')) {\r\n\t\t\t\tconst newVal = formatItem.replace('junitbamboo', '@lynxwall/cucumber-tsflow/junitbamboo');\r\n\t\t\t\toriginal.format[idx] = original.format[idx].length > 1 ? [newVal, original.format[idx][1]] : [newVal];\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\r\n\t// check to see if a debugFile was passed in\r\n\tif (hasStringValue(original.debugFile)) {\r\n\t\t// Initialize gherkin manager with path to feature files\r\n\t\tconst gherkin = new GherkinManager();\r\n\t\tawait gherkin.loadFeatures(original.paths);\r\n\t\tconst features = gherkin.findFeaturesByStepFile(original.debugFile);\r\n\t\tif (features.length > 0) {\r\n\t\t\toriginal.paths = [];\r\n\t\t\tfeatures.forEach(x => original.paths.push(x.featureFile));\r\n\t\t} else {\r\n\t\t\t// log a message if the feature path is not found\r\n\t\t\tlogger.warn(chalk.yellow(`\\nUnable to find feature for debugFile: ${original.debugFile}`));\r\n\t\t\tlogger.warn(chalk.yellow('All tests will be executed\\n'));\r\n\t\t}\r\n\t}\r\n\r\n\t// check to see if enable-vue-style was set\r\n\t// if not, default it to false\r\n\tif (original.enableVueStyle === null || original.enableVueStyle === undefined) {\r\n\t\toriginal.enableVueStyle = false;\r\n\t}\r\n\t// set our global parameter used by the Vue transpiler\r\n\t// to determine if Vue Style Blocks should be enabled\r\n\tglobal.enableVueStyle = original.enableVueStyle;\r\n\r\n\tvalidateConfiguration(original, logger);\r\n\tconst runnable = await convertConfiguration(logger, original, env);\r\n\treturn {\r\n\t\tuseConfiguration: original,\r\n\t\trunConfiguration: runnable\r\n\t};\r\n};\r\n"]}

package/lib/api/load-support.d.ts

@@ -0,0 +1,10 @@
+import { IRunEnvironment } from '@cucumber/cucumber/lib/environment/index';
+import { ILoadSupportOptions, ISupportCodeLibrary } from '@cucumber/cucumber/lib/api/types';
+/**
+ * Load support code for use in test runs
+ *
+ * @public
+ * @param options - Options required to find the support code
+ * @param environment - Project environment
+ */
+export declare function loadSupport(options: ILoadSupportOptions, environment?: IRunEnvironment): Promise<ISupportCodeLibrary>;

package/lib/api/load-support.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSupport = loadSupport;
+const messages_1 = require("@cucumber/messages");
+const index_1 = require("@cucumber/cucumber/lib/paths/index");
+const index_2 = require("@cucumber/cucumber/lib/environment/index");
+const support_1 = require("@cucumber/cucumber/lib/api/support");
+const plugins_1 = require("@cucumber/cucumber/lib/api/plugins");
+const binding_registry_1 = require("../bindings/binding-registry");
+/**
+ * Load support code for use in test runs
+ *
+ * @public
+ * @param options - Options required to find the support code
+ * @param environment - Project environment
+ */
+async function loadSupport(options, environment = {}) {
+    const mergedEnvironment = (0, index_2.makeEnvironment)(environment);
+    const { cwd, logger } = mergedEnvironment;
+    const newId = messages_1.IdGenerator.uuid();
+    const supportCoordinates = Object.assign({
+        requireModules: [],
+        requirePaths: [],
+        loaders: [],
+        importPaths: []
+    }, options.support);
+    const pluginManager = await (0, plugins_1.initializeForLoadSupport)(mergedEnvironment);
+    const resolvedPaths = await (0, index_1.resolvePaths)(logger, cwd, options.sources, supportCoordinates);
+    pluginManager.emit('paths:resolve', resolvedPaths);
+    const { requirePaths, importPaths } = resolvedPaths;
+    let supportCodeLibrary = await (0, support_1.getSupportCodeLibrary)({
+        logger,
+        cwd,
+        newId,
+        requireModules: supportCoordinates.requireModules,
+        requirePaths,
+        loaders: supportCoordinates.loaders,
+        importPaths
+    });
+    await pluginManager.cleanup();
+    // Set support to the updated step and hook definitions
+    // in the supportCodeLibrary. We also need to initialize originalCoordinates
+    // to support parallel execution.
+    supportCodeLibrary = binding_registry_1.BindingRegistry.instance.updateSupportCodeLibrary(supportCodeLibrary);
+    supportCodeLibrary = { ...supportCodeLibrary, ...{ originalCoordinates: supportCoordinates } };
+    return supportCodeLibrary;
+}
+//# sourceMappingURL=load-support.js.map

package/lib/api/load-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-support.js","sourceRoot":"","sources":["../../src/api/load-support.ts"],"names":[],"mappings":";;AAeA,kCAsCC;AArDD,iDAAiD;AACjD,8DAAkE;AAClE,oEAA4F;AAE5F,gEAA2E;AAC3E,gEAA8E;AAC9E,mEAA+D;AAE/D;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAChC,OAA4B,EAC5B,cAA+B,EAAE;IAEjC,MAAM,iBAAiB,GAAG,IAAA,uBAAe,EAAC,WAAW,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;IAC1C,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAC;IACjC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CACvC;QACC,cAAc,EAAE,EAAE;QAClB,YAAY,EAAE,EAAE;QAChB,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,EAAE;KACf,EACD,OAAO,CAAC,OAAO,CACf,CAAC;IACF,MAAM,aAAa,GAAG,MAAM,IAAA,kCAAwB,EAAC,iBAAiB,CAAC,CAAC;IACxE,MAAM,aAAa,GAAG,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC3F,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IACnD,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;IACpD,IAAI,kBAAkB,GAAG,MAAM,IAAA,+BAAqB,EAAC;QACpD,MAAM;QACN,GAAG;QACH,KAAK;QACL,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,YAAY;QACZ,OAAO,EAAE,kBAAkB,CAAC,OAAO;QACnC,WAAW;KACX,CAAC,CAAC;IACH,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC;IAE9B,uDAAuD;IACvD,4EAA4E;IAC5E,iCAAiC;IACjC,kBAAkB,GAAG,kCAAe,CAAC,QAAQ,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAC3F,kBAAkB,GAAG,EAAE,GAAG,kBAAkB,EAAE,GAAG,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,CAAC;IAE/F,OAAO,kBAAkB,CAAC;AAC3B,CAAC","sourcesContent":["import { IdGenerator } from '@cucumber/messages';\r\nimport { resolvePaths } from '@cucumber/cucumber/lib/paths/index';\r\nimport { IRunEnvironment, makeEnvironment } from '@cucumber/cucumber/lib/environment/index';\r\nimport { ILoadSupportOptions, ISupportCodeLibrary } from '@cucumber/cucumber/lib/api/types';\r\nimport { getSupportCodeLibrary } from '@cucumber/cucumber/lib/api/support';\r\nimport { initializeForLoadSupport } from '@cucumber/cucumber/lib/api/plugins';\r\nimport { BindingRegistry } from '../bindings/binding-registry';\r\n\r\n/**\r\n * Load support code for use in test runs\r\n *\r\n * @public\r\n * @param options - Options required to find the support code\r\n * @param environment - Project environment\r\n */\r\nexport async function loadSupport(\r\n\toptions: ILoadSupportOptions,\r\n\tenvironment: IRunEnvironment = {}\r\n): Promise<ISupportCodeLibrary> {\r\n\tconst mergedEnvironment = makeEnvironment(environment);\r\n\tconst { cwd, logger } = mergedEnvironment;\r\n\tconst newId = IdGenerator.uuid();\r\n\tconst supportCoordinates = Object.assign(\r\n\t\t{\r\n\t\t\trequireModules: [],\r\n\t\t\trequirePaths: [],\r\n\t\t\tloaders: [],\r\n\t\t\timportPaths: []\r\n\t\t},\r\n\t\toptions.support\r\n\t);\r\n\tconst pluginManager = await initializeForLoadSupport(mergedEnvironment);\r\n\tconst resolvedPaths = await resolvePaths(logger, cwd, options.sources, supportCoordinates);\r\n\tpluginManager.emit('paths:resolve', resolvedPaths);\r\n\tconst { requirePaths, importPaths } = resolvedPaths;\r\n\tlet supportCodeLibrary = await getSupportCodeLibrary({\r\n\t\tlogger,\r\n\t\tcwd,\r\n\t\tnewId,\r\n\t\trequireModules: supportCoordinates.requireModules,\r\n\t\trequirePaths,\r\n\t\tloaders: supportCoordinates.loaders,\r\n\t\timportPaths\r\n\t});\r\n\tawait pluginManager.cleanup();\r\n\r\n\t// Set support to the updated step and hook definitions\r\n\t// in the supportCodeLibrary. We also need to initialize originalCoordinates\r\n\t// to support parallel execution.\r\n\tsupportCodeLibrary = BindingRegistry.instance.updateSupportCodeLibrary(supportCodeLibrary);\r\n\tsupportCodeLibrary = { ...supportCodeLibrary, ...{ originalCoordinates: supportCoordinates } };\r\n\r\n\treturn supportCodeLibrary;\r\n}\r\n"]}

package/lib/api/run-cucumber.d.ts

@@ -0,0 +1,16 @@
+import { Envelope } from '@cucumber/messages';
+import { IRunOptions, IRunResult } from '@cucumber/cucumber/lib/api/types';
+import { IRunEnvironment } from '@cucumber/cucumber/lib/environment/index';
+import 'polyfill-symbol-metadata';
+/**
+ * Execute a Cucumber test run.
+ *
+ * Extended from cucumber.js so that we can use our own implementation
+ * of makeRuntime
+ *
+ * @public
+ * @param options - Configuration loaded from `loadConfiguration`.
+ * @param environment - Project environment.
+ * @param onMessage - Callback fired each time Cucumber emits a message.
+ */
+export declare function runCucumber(options: IRunOptions, environment?: IRunEnvironment, onMessage?: (message: Envelope) => void): Promise<IRunResult>;

package/lib/api/run-cucumber.js

@@ -0,0 +1,151 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCucumber = runCucumber;
+const messages_1 = require("@cucumber/messages");
+const events_1 = require("events");
+const helpers_1 = require("@cucumber/cucumber/lib/cli/helpers");
+const index_1 = require("@cucumber/cucumber/lib/paths/index");
+const make_runtime_1 = require("../runtime/make-runtime");
+const formatters_1 = require("@cucumber/cucumber/lib/api/formatters");
+const support_1 = require("@cucumber/cucumber/lib/api/support");
+const index_2 = require("@cucumber/cucumber/lib/environment/index");
+const gherkin_1 = require("@cucumber/cucumber/lib/api/gherkin");
+const message_collector_1 = __importDefault(require("../runtime/message-collector"));
+const version_1 = require("../version");
+const plugins_1 = require("@cucumber/cucumber/lib/api/plugins");
+require("polyfill-symbol-metadata");
+const binding_registry_1 = require("../bindings/binding-registry");
+/**
+ * Execute a Cucumber test run.
+ *
+ * Extended from cucumber.js so that we can use our own implementation
+ * of makeRuntime
+ *
+ * @public
+ * @param options - Configuration loaded from `loadConfiguration`.
+ * @param environment - Project environment.
+ * @param onMessage - Callback fired each time Cucumber emits a message.
+ */
+async function runCucumber(options, environment = {}, onMessage) {
+    const mergedEnvironment = (0, index_2.makeEnvironment)(environment);
+    const { cwd, stdout, stderr, env, logger } = mergedEnvironment;
+    logger.debug(`Running cucumber-tsflow ${version_1.version}
+Working directory: ${cwd}
+Running from: ${__dirname}
+`);
+    const newId = messages_1.IdGenerator.uuid();
+    const supportCoordinates = 'originalCoordinates' in options.support
+        ? options.support.originalCoordinates
+        : Object.assign({
+            requireModules: [],
+            requirePaths: [],
+            loaders: [],
+            importPaths: []
+        }, options.support);
+    const pluginManager = await (0, plugins_1.initializeForRunCucumber)({
+        ...options,
+        support: supportCoordinates
+    }, mergedEnvironment);
+    const resolvedPaths = await (0, index_1.resolvePaths)(logger, cwd, options.sources, supportCoordinates);
+    pluginManager.emit('paths:resolve', resolvedPaths);
+    const { sourcePaths, requirePaths, importPaths } = resolvedPaths;
+    /**
+     * The support code library contains all of the hook and step definitions.
+     * These are loaded into the library when calling getSupportCodeLibrary,
+     * which loads all of the step definitions using require or import.
+     */
+    let supportCodeLibrary = 'originalCoordinates' in options.support
+        ? options.support
+        : await (0, support_1.getSupportCodeLibrary)({
+            logger,
+            cwd,
+            newId,
+            requirePaths,
+            requireModules: supportCoordinates.requireModules,
+            importPaths,
+            loaders: supportCoordinates.loaders
+        });
+    // Set support to the updated step and hook definitions
+    // in the supportCodeLibrary. We also need to initialize originalCoordinates
+    // to support parallel execution.
+    supportCodeLibrary = binding_registry_1.BindingRegistry.instance.updateSupportCodeLibrary(supportCodeLibrary);
+    supportCodeLibrary = { ...supportCodeLibrary, ...{ originalCoordinates: supportCoordinates } };
+    options.support = supportCodeLibrary;
+    const eventBroadcaster = new events_1.EventEmitter();
+    if (onMessage) {
+        eventBroadcaster.on('envelope', onMessage);
+    }
+    eventBroadcaster.on('envelope', value => pluginManager.emit('message', value));
+    // create a global instance of the message collector and bind it
+    // to the event broadcaster. This is used by cucumber and for tests
+    // that are not running in parallel.
+    global.messageCollector = new message_collector_1.default(eventBroadcaster);
+    // cast the MessageCollector to an EventDataCollector
+    const eventDataCollector = global.messageCollector;
+    let formatterStreamError = false;
+    const cleanupFormatters = await (0, formatters_1.initializeFormatters)({
+        env,
+        cwd,
+        stdout,
+        stderr,
+        logger,
+        onStreamError: () => (formatterStreamError = true),
+        eventBroadcaster,
+        eventDataCollector: eventDataCollector,
+        configuration: options.formats,
+        supportCodeLibrary,
+        pluginManager
+    });
+    await (0, helpers_1.emitMetaMessage)(eventBroadcaster, env);
+    let filteredPickles = [];
+    let parseErrors = [];
+    if (sourcePaths.length > 0) {
+        const gherkinResult = await (0, gherkin_1.getPicklesAndErrors)({
+            newId,
+            cwd,
+            sourcePaths,
+            coordinates: options.sources,
+            onEnvelope: envelope => eventBroadcaster.emit('envelope', envelope)
+        });
+        filteredPickles = await pluginManager.transform('pickles:filter', gherkinResult.filterablePickles);
+        filteredPickles = await pluginManager.transform('pickles:order', filteredPickles);
+        parseErrors = gherkinResult.parseErrors;
+    }
+    if (parseErrors.length) {
+        parseErrors.forEach(parseError => {
+            logger.error(`Parse error in "${parseError.source.uri}" ${parseError.message}`);
+        });
+        await cleanupFormatters();
+        await pluginManager.cleanup();
+        return {
+            success: false,
+            support: supportCodeLibrary
+        };
+    }
+    (0, helpers_1.emitSupportCodeMessages)({
+        eventBroadcaster,
+        supportCodeLibrary,
+        newId
+    });
+    const runtime = await (0, make_runtime_1.makeRuntime)({
+        environment,
+        logger,
+        eventBroadcaster,
+        sourcedPickles: filteredPickles,
+        newId,
+        supportCodeLibrary,
+        options: options.runtime,
+        coordinates: options.sources
+    });
+    const success = await runtime.run();
+    await pluginManager.cleanup();
+    await cleanupFormatters();
+    return {
+        success: success && !formatterStreamError,
+        support: supportCodeLibrary
+    };
+}
+//# sourceMappingURL=run-cucumber.js.map

package/lib/api/run-cucumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-cucumber.js","sourceRoot":"","sources":["../../src/api/run-cucumber.ts"],"names":[],"mappings":";;;;;AA8BA,kCAiJC;AA/KD,iDAAuE;AACvE,mCAAsC;AAEtC,gEAA8F;AAE9F,8DAAkE;AAElE,0DAAsD;AACtD,sEAA6E;AAC7E,gEAA2E;AAC3E,oEAA4F;AAC5F,gEAAyE;AACzE,qFAA4D;AAC5D,wCAAqC;AACrC,gEAA8E;AAE9E,oCAAkC;AAClC,mEAA+D;AAE/D;;;;;;;;;;GAUG;AACI,KAAK,UAAU,WAAW,CAChC,OAAoB,EACpB,cAA+B,EAAE,EACjC,SAAuC;IAEvC,MAAM,iBAAiB,GAAG,IAAA,uBAAe,EAAC,WAAW,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;IAE/D,MAAM,CAAC,KAAK,CAAC,2BAA2B,iBAAO;qBAC3B,GAAG;gBACR,SAAS;CACxB,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAC;IAEjC,MAAM,kBAAkB,GACvB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACvC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB;QACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CACb;YACC,cAAc,EAAE,EAAE;YAClB,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;SACf,EACD,OAAO,CAAC,OAAO,CACf,CAAC;IAEL,MAAM,aAAa,GAAG,MAAM,IAAA,kCAAwB,EACnD;QACC,GAAG,OAAO;QACV,OAAO,EAAE,kBAAkB;KAC3B,EACD,iBAAiB,CACjB,CAAC;IAEF,MAAM,aAAa,GAAG,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC3F,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IACnD,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;IAEjE;;;;OAIG;IACH,IAAI,kBAAkB,GACrB,qBAAqB,IAAI,OAAO,CAAC,OAAO;QACvC,CAAC,CAAE,OAAO,CAAC,OAA8B;QACzC,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC;YAC5B,MAAM;YACN,GAAG;YACH,KAAK;YACL,YAAY;YACZ,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,WAAW;YACX,OAAO,EAAE,kBAAkB,CAAC,OAAO;SACnC,CAAC,CAAC;IAEN,uDAAuD;IACvD,4EAA4E;IAC5E,iCAAiC;IACjC,kBAAkB,GAAG,kCAAe,CAAC,QAAQ,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAC3F,kBAAkB,GAAG,EAAE,GAAG,kBAAkB,EAAE,GAAG,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,EAAE,CAAC;IAC/F,OAAO,CAAC,OAAO,GAAG,kBAAkB,CAAC;IAErC,MAAM,gBAAgB,GAAG,IAAI,qBAAY,EAAE,CAAC;IAC5C,IAAI,SAAS,EAAE,CAAC;QACf,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IAE/E,gEAAgE;IAChE,mEAAmE;IACnE,oCAAoC;IACpC,MAAM,CAAC,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,gBAAgB,CAAC,CAAC;IAEjE,qDAAqD;IACrD,MAAM,kBAAkB,GAAG,MAAM,CAAC,gBAAiD,CAAC;IAEpF,IAAI,oBAAoB,GAAG,KAAK,CAAC;IACjC,MAAM,iBAAiB,GAAG,MAAM,IAAA,iCAAoB,EAAC;QACpD,GAAG;QACH,GAAG;QACH,MAAM;QACN,MAAM;QACN,MAAM;QACN,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAClD,gBAAgB;QAChB,kBAAkB,EAAE,kBAAkB;QACtC,aAAa,EAAE,OAAO,CAAC,OAAO;QAC9B,kBAAkB;QAClB,aAAa;KACb,CAAC,CAAC;IACH,MAAM,IAAA,yBAAe,EAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAE7C,IAAI,eAAe,GAAqC,EAAE,CAAC;IAC3D,IAAI,WAAW,GAAiB,EAAE,CAAC;IACnC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAmB,EAAC;YAC/C,KAAK;YACL,GAAG;YACH,WAAW;YACX,WAAW,EAAE,OAAO,CAAC,OAAO;YAC5B,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;SACnE,CAAC,CAAC;QACH,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,gBAAgB,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;QACnG,eAAe,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QAClF,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;IACzC,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACxB,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAChC,MAAM,CAAC,KAAK,CAAC,mBAAmB,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;QACH,MAAM,iBAAiB,EAAE,CAAC;QAC1B,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO;YACN,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kBAAkB;SAC3B,CAAC;IACH,CAAC;IAED,IAAA,iCAAuB,EAAC;QACvB,gBAAgB;QAChB,kBAAkB;QAClB,KAAK;KACL,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,IAAA,0BAAW,EAAC;QACjC,WAAW;QACX,MAAM;QACN,gBAAgB;QAChB,cAAc,EAAE,eAAe;QAC/B,KAAK;QACL,kBAAkB;QAClB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,WAAW,EAAE,OAAO,CAAC,OAAO;KAC5B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC;IAC9B,MAAM,iBAAiB,EAAE,CAAC;IAE1B,OAAO;QACN,OAAO,EAAE,OAAO,IAAI,CAAC,oBAAoB;QACzC,OAAO,EAAE,kBAAkB;KAC3B,CAAC;AACH,CAAC","sourcesContent":["import { Envelope, IdGenerator, ParseError } from '@cucumber/messages';\r\nimport { EventEmitter } from 'events';\r\nimport { EventDataCollector } from '@cucumber/cucumber/lib/formatter/helpers/index';\r\nimport { emitMetaMessage, emitSupportCodeMessages } from '@cucumber/cucumber/lib/cli/helpers';\r\nimport { IRunOptions, IRunResult } from '@cucumber/cucumber/lib/api/types';\r\nimport { resolvePaths } from '@cucumber/cucumber/lib/paths/index';\r\nimport { SupportCodeLibrary } from '@cucumber/cucumber/lib/support_code_library_builder/types';\r\nimport { makeRuntime } from '../runtime/make-runtime';\r\nimport { initializeFormatters } from '@cucumber/cucumber/lib/api/formatters';\r\nimport { getSupportCodeLibrary } from '@cucumber/cucumber/lib/api/support';\r\nimport { IRunEnvironment, makeEnvironment } from '@cucumber/cucumber/lib/environment/index';\r\nimport { getPicklesAndErrors } from '@cucumber/cucumber/lib/api/gherkin';\r\nimport MessageCollector from '../runtime/message-collector';\r\nimport { version } from '../version';\r\nimport { initializeForRunCucumber } from '@cucumber/cucumber/lib/api/plugins';\r\nimport { IFilterablePickle } from '@cucumber/cucumber/lib/filter/index';\r\nimport 'polyfill-symbol-metadata';\r\nimport { BindingRegistry } from '../bindings/binding-registry';\r\n\r\n/**\r\n * Execute a Cucumber test run.\r\n *\r\n * Extended from cucumber.js so that we can use our own implementation\r\n * of makeRuntime\r\n *\r\n * @public\r\n * @param options - Configuration loaded from `loadConfiguration`.\r\n * @param environment - Project environment.\r\n * @param onMessage - Callback fired each time Cucumber emits a message.\r\n */\r\nexport async function runCucumber(\r\n\toptions: IRunOptions,\r\n\tenvironment: IRunEnvironment = {},\r\n\tonMessage?: (message: Envelope) => void\r\n): Promise<IRunResult> {\r\n\tconst mergedEnvironment = makeEnvironment(environment);\r\n\tconst { cwd, stdout, stderr, env, logger } = mergedEnvironment;\r\n\r\n\tlogger.debug(`Running cucumber-tsflow ${version}\r\nWorking directory: ${cwd}\r\nRunning from: ${__dirname}\r\n`);\r\n\r\n\tconst newId = IdGenerator.uuid();\r\n\r\n\tconst supportCoordinates =\r\n\t\t'originalCoordinates' in options.support\r\n\t\t\t? options.support.originalCoordinates\r\n\t\t\t: Object.assign(\r\n\t\t\t\t\t{\r\n\t\t\t\t\t\trequireModules: [],\r\n\t\t\t\t\t\trequirePaths: [],\r\n\t\t\t\t\t\tloaders: [],\r\n\t\t\t\t\t\timportPaths: []\r\n\t\t\t\t\t},\r\n\t\t\t\t\toptions.support\r\n\t\t\t\t);\r\n\r\n\tconst pluginManager = await initializeForRunCucumber(\r\n\t\t{\r\n\t\t\t...options,\r\n\t\t\tsupport: supportCoordinates\r\n\t\t},\r\n\t\tmergedEnvironment\r\n\t);\r\n\r\n\tconst resolvedPaths = await resolvePaths(logger, cwd, options.sources, supportCoordinates);\r\n\tpluginManager.emit('paths:resolve', resolvedPaths);\r\n\tconst { sourcePaths, requirePaths, importPaths } = resolvedPaths;\r\n\r\n\t/**\r\n\t * The support code library contains all of the hook and step definitions.\r\n\t * These are loaded into the library when calling getSupportCodeLibrary,\r\n\t * which loads all of the step definitions using require or import.\r\n\t */\r\n\tlet supportCodeLibrary =\r\n\t\t'originalCoordinates' in options.support\r\n\t\t\t? (options.support as SupportCodeLibrary)\r\n\t\t\t: await getSupportCodeLibrary({\r\n\t\t\t\t\tlogger,\r\n\t\t\t\t\tcwd,\r\n\t\t\t\t\tnewId,\r\n\t\t\t\t\trequirePaths,\r\n\t\t\t\t\trequireModules: supportCoordinates.requireModules,\r\n\t\t\t\t\timportPaths,\r\n\t\t\t\t\tloaders: supportCoordinates.loaders\r\n\t\t\t\t});\r\n\r\n\t// Set support to the updated step and hook definitions\r\n\t// in the supportCodeLibrary. We also need to initialize originalCoordinates\r\n\t// to support parallel execution.\r\n\tsupportCodeLibrary = BindingRegistry.instance.updateSupportCodeLibrary(supportCodeLibrary);\r\n\tsupportCodeLibrary = { ...supportCodeLibrary, ...{ originalCoordinates: supportCoordinates } };\r\n\toptions.support = supportCodeLibrary;\r\n\r\n\tconst eventBroadcaster = new EventEmitter();\r\n\tif (onMessage) {\r\n\t\teventBroadcaster.on('envelope', onMessage);\r\n\t}\r\n\teventBroadcaster.on('envelope', value => pluginManager.emit('message', value));\r\n\r\n\t// create a global instance of the message collector and bind it\r\n\t// to the event broadcaster. This is used by cucumber and for tests\r\n\t// that are not running in parallel.\r\n\tglobal.messageCollector = new MessageCollector(eventBroadcaster);\r\n\r\n\t// cast the MessageCollector to an EventDataCollector\r\n\tconst eventDataCollector = global.messageCollector as unknown as EventDataCollector;\r\n\r\n\tlet formatterStreamError = false;\r\n\tconst cleanupFormatters = await initializeFormatters({\r\n\t\tenv,\r\n\t\tcwd,\r\n\t\tstdout,\r\n\t\tstderr,\r\n\t\tlogger,\r\n\t\tonStreamError: () => (formatterStreamError = true),\r\n\t\teventBroadcaster,\r\n\t\teventDataCollector: eventDataCollector,\r\n\t\tconfiguration: options.formats,\r\n\t\tsupportCodeLibrary,\r\n\t\tpluginManager\r\n\t});\r\n\tawait emitMetaMessage(eventBroadcaster, env);\r\n\r\n\tlet filteredPickles: ReadonlyArray<IFilterablePickle> = [];\r\n\tlet parseErrors: ParseError[] = [];\r\n\tif (sourcePaths.length > 0) {\r\n\t\tconst gherkinResult = await getPicklesAndErrors({\r\n\t\t\tnewId,\r\n\t\t\tcwd,\r\n\t\t\tsourcePaths,\r\n\t\t\tcoordinates: options.sources,\r\n\t\t\tonEnvelope: envelope => eventBroadcaster.emit('envelope', envelope)\r\n\t\t});\r\n\t\tfilteredPickles = await pluginManager.transform('pickles:filter', gherkinResult.filterablePickles);\r\n\t\tfilteredPickles = await pluginManager.transform('pickles:order', filteredPickles);\r\n\t\tparseErrors = gherkinResult.parseErrors;\r\n\t}\r\n\tif (parseErrors.length) {\r\n\t\tparseErrors.forEach(parseError => {\r\n\t\t\tlogger.error(`Parse error in \"${parseError.source.uri}\" ${parseError.message}`);\r\n\t\t});\r\n\t\tawait cleanupFormatters();\r\n\t\tawait pluginManager.cleanup();\r\n\t\treturn {\r\n\t\t\tsuccess: false,\r\n\t\t\tsupport: supportCodeLibrary\r\n\t\t};\r\n\t}\r\n\r\n\temitSupportCodeMessages({\r\n\t\teventBroadcaster,\r\n\t\tsupportCodeLibrary,\r\n\t\tnewId\r\n\t});\r\n\r\n\tconst runtime = await makeRuntime({\r\n\t\tenvironment,\r\n\t\tlogger,\r\n\t\teventBroadcaster,\r\n\t\tsourcedPickles: filteredPickles,\r\n\t\tnewId,\r\n\t\tsupportCodeLibrary,\r\n\t\toptions: options.runtime,\r\n\t\tcoordinates: options.sources\r\n\t});\r\n\tconst success = await runtime.run();\r\n\tawait pluginManager.cleanup();\r\n\tawait cleanupFormatters();\r\n\r\n\treturn {\r\n\t\tsuccess: success && !formatterStreamError,\r\n\t\tsupport: supportCodeLibrary\r\n\t};\r\n}\r\n"]}

package/lib/api/wrapper.mjs

@@ -0,0 +1,6 @@
+import api from './index.js';
+
+export const loadConfiguration = api.loadConfiguration;
+export const loadSupport = api.loadSupport;
+export const loadSources = api.loadSources;
+export const runCucumber = api.runCucumber;