@lynxwall/cucumber-tsflow 6.5.7 → 7.1.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.
 
@@ -10,9 +10,25 @@ Supports Vue3 files in cucumber tests.
 
 This is a detached fork of <https://github.com/timjroberts/cucumber-js-tsflow>. It has had the <https://github.com/wudong/cucumber-js-tsflow/tree/before_after_all_hooks> branch merged into it, which adds support for beforeAll and afterAll hooks.
 
-In addition, the following features have been added:
+This fork has been drastically modified from the original and will eventually be moved to a new project. In addition, the SpecFlow project has reached [end of life](https://reqnroll.net/news/2025/01/specflow-end-of-life-has-been-announced/), and this project will be rebranded. Further details will be provided in future updates. However, the new project will support the same functionality as cucumber-tsflow while providing additional tools and extensions.
+
+## Release Updates (7.1.0)
+
+With this latest release, cucumber-tsflow has been refactored to support cucumber-js version 11.2.0 along with other updates that include:
+
+- **Switch to package exports** with both cucumber-tsflow and most of cucumber-js Public types and functions exported. This allows developers to use cucumber-tsflow as a replacement for cucumber-js without requiring a peer installation. Most of the functionality is still executed in cucumber-js, cucumber-tsflow just extends cucumber-js to switch from support functions to support decorators with scoped context. This change is what allows you to use a SpecFlow type of structure for defining code that will execute BDD tests.
+- **API support** that implements and extends the cucumber-js API.
+- Support for Node 22 and Typescript 5.8.
+  - Switched to **official Typescript Decorators** with metadata support implemented in [Typescript 5.2](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#decorator-metadata).
+- Transpiler configuration updates to support node and Typescript changes.
+  - Added a new section to this readme that describes [Transpilers and TypeScript](#transpilers-and-typescript) in more detail.
+
+## Features
+
+This fork of cucumber-tsflow provides the following features that extend the original version:
 
 - Test runner using the cucumber-tsflow command.
+
   - Uses underlying cucumber api to run tests.
   - Returns **four** exit codes:
     - **0** - All scenarios passing.
@@ -20,7 +36,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.
 
@@ -38,13 +54,14 @@ In addition, the following features have been added:
 
 - A behave-json-formatter that fixes json so it can be used with Behave Pro.
 
+- A junit-bamboo formatter that generates xml compatible with the Bamboo JUnit plugin.
+
 - tsflow-snippet-syntax used to format snippet examples.
+
   - snippets use the [Cucumber Expressions](https://github.com/cucumber/cucumber-expressions#readme) Syntax for parameters.
 
 - [Context Injection](#context-injection) updates with support to initialize the context before each scenario test run and dispose the context after a scenario has finished executing.
 
-  
-
 <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> With recent updates you must use the <strong><span style="color: #000">cucumber-tsflow</span></strong> command to execute tests. This command executes the same API calls that cucumber-js does and supports all of the options and features as cucumber-js along with new features listed above.
 </div>
@@ -61,6 +78,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
@@ -129,6 +152,75 @@ Running the cucumber-tsflow command will execute your features along with the su
 
 In this quick example test state is encapsulated directly in the class. As your test suite grows larger and step definitions get shared between multiple classes, you can begin using '[Context Injection](#context-injection)' to share state between running step definitions.
 
+## Transpilers and TypeScript
+
+Cucumber-tsflow provides several [transpilers](#transpiler-and-vue3-supported) that can be used in your configuration. However, you are not required to use them. If a different configuration or transpiler is needed you can copy code from one of the provided transpilers.
+
+This section focuses on the Typescript configuration used to transpile your test code, and any dependencies, into JavaScript that is executed within the cucumber-js test runner.
+
+### CommonJS and ESM
+
+The transpilers included with cucumber-tsflow transpile to **CommonJS** and do not support projects with `"type": "module"` in your `package.json`. However, [esModuleinterop](https://www.typescriptlang.org/tsconfig/#esModuleInterop) is enabled by default, which allows you to write code using ECMAScript (ESM) standards and import ESM modules in your test code.
+
+### TypeScript Configuration
+
+All of the transpilers included with cucumber-tsflow use the same TypeScript configuration, which take precedence when running your tests using one of these transpilers. In other words, while each transpiler is different, they all use the same tsconfig settings, which are shown below:
+
+```json
+	compilerOptions: {
+		module: 'nodeNext',
+		target: 'es2022',
+		strict: true,
+		resolveJsonModule: true,
+		esModuleInterop: true,
+		skipLibCheck: true,
+		lib: ['es2022', 'esnext.decorators']
+	},
+```
+
+When test runs are started, the settings from your local tsconfig.json are loaded first and then the settings from the transpiler will override the specific settings shown above. As a result, you should use these transpilers in projects that will support these settings.
+
+For example, the settings from the cucumber-tsflow vue test project is shown below:
+
+```json
+	"compilerOptions": {
+		"baseUrl": ".",
+		"target": "es2022",
+		"module": "Node18",
+		"strict": true,
+		"importHelpers": true,
+		"skipLibCheck": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"useDefineForClassFields": true,
+		"inlineSourceMap": true,
+		"allowJs": true,
+		"removeComments": false,
+		"lib": ["es2022", "esnext.decorators"],
+		"typeRoots": ["../../node_modules/@types"]
+	},
+```
+
+These settings are similar to the default transpiler settings, which will not cause an issue. The only change will be the module from Node18 to nodeNext. Any other settings that are not included in the transpiler default will also be applied when the transpiler is executed.
+
+### esbuild Transpilers
+
+Cucumber-tsflow provides two esbuild transpilers: one with esbuild and support for Vue using the vue-sfc transpiler, and another that only uses the esbuild transpiler. Both cucumber-tsflow transpilers use the same esbuild transpiler, which is configured to generate CommonJS, as shown below:
+
+```typescript
+const commonOptions: CommonOptions = {
+	format: 'cjs',
+	logLevel: 'info',
+	target: [`es2020`],
+	minify: false,
+	sourcemap: 'external'
+};
+```
+
+As you can see, this also uses the same target as the typescript configuration. In addition, minify is set to false, which makes it easy to debug and step into code when running tests.
+
+As mentioned at the beginning of this section, there are several transpilers provided, which can be used with your test project. The [transpilers](#transpiler-and-vue3-supported) section below provides information on how to configure your project to use one of these transpilers.
+
 ## Cucumber-tsflow Test Runner
 
 As mentioned previously, with recent updates cucumber-tsflow must be used to execute tests. The reason for this update was to replace before and after hooks previously used to manage context with a message handler. Executing tests with cucumber-tsflow uses the same API calls that cucumber-js does. The only differences are updates to support new configuration parameters along with updates to step definitions that set the correct location.
@@ -220,19 +312,19 @@ echo $?
 
 ## New Configuration options
 
-As mentioned, when using cucumber-tsflow to execute tests all of the configuration options documented here are supported: <https://github.com/cucumber/cucumber-js/blob/v8.0.0/docs/configuration.md>
+As mentioned, when using cucumber-tsflow to execute tests all of the configuration options documented here are supported: <https://github.com/cucumber/cucumber-js/blob/v11.2.0/docs/configuration.md>
 
 In addition to cucumber configuration options the following two options have been added:
 
-| Name             | Type      | Repeatable | CLI Option           | Description                                                  | Default |
-| ---------------- | --------- | ---------- | -------------------- | ------------------------------------------------------------ | ------- |
+| Name             | Type      | Repeatable | CLI Option           | Description                                                   | Default |
+| ---------------- | --------- | ---------- | -------------------- | ------------------------------------------------------------- | ------- |
 | `transpiler`     | `string`  | No         | `--transpiler`       | Name of the transpiler to use: esnode, esvue, tsnode or tsvue | esnode  |
-| `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   |
+| `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 cucumber-js requires setting tsconfig.json parameters as described here: [cucumber-js 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 cucumber-js.
 
 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 +339,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 +362,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 +380,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 +401,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"],
@@ -416,7 +512,7 @@ public givenAValueBasedSearch(searchValue: string): void {
 }
 ```
 
-**Note**: Tags added to steps work the same as "Tagged Hooks" documented here: <https://github.com/cucumber/cucumber-js/blob/v8.0.0/docs/support_files/hooks.md>
+**Note**: Tags added to steps work the same as "Tagged Hooks" documented here: <https://github.com/cucumber/cucumber-js/blob/v11.2.0/docs/support_files/hooks.md>
 
 ## Hooks
 
@@ -517,7 +613,7 @@ If it doesn't already exist, create a file named cucumber.json at the root of yo
 
 #### Using the behave json formatter
 
-The following example shows how to configure the behave formatter in cucumber.json. The tsflow-snippet-syntax module is configured as the default snippet syntax and does not require configuration. However, you can override the snippet syntax as documented here: <https://github.com/cucumber/cucumber-js/blob/v8.0.0/docs/custom_snippet_syntaxes.md>
+The following example shows how to configure the behave formatter in cucumber.json. The tsflow-snippet-syntax module is configured as the default snippet syntax and does not require configuration. However, you can override the snippet syntax as documented here: <https://github.com/cucumber/cucumber-js/blob/v11.2.0/docs/custom_snippet_syntaxes.md>
 
 ```typescript
 {
@@ -549,32 +645,32 @@ Like 'specflow', cucumber-tsflow supports a simple dependency injection framewor
 
 ### Sharing Data between Steps and Bindings
 
-Each scenario in a feature will get a new instance of the *Context* object when the steps associated with a scenario are executed. Hooks and steps used by the scenario will have access to the same instance of a "Scenario Context" during execution of the test steps. In addition, if steps of a scenario are implemented in separate bindings, those steps will still have access to the same instance of the *Context* object created for the scenario.
+Each scenario in a feature will get a new instance of the _Context_ object when the steps associated with a scenario are executed. Hooks and steps used by the scenario will have access to the same instance of a "Scenario Context" during execution of the test steps. In addition, if steps of a scenario are implemented in separate bindings, those steps will still have access to the same instance of the _Context_ object created for the scenario.
 
 **Recent Updates:**
 
 - versions >= 6.5.2
+
   - Updated execution of the `initialize()` function to pass in argument that is an object with information about the Test Case (Scenario).
     - The object passed in will be in the form:
       `{ pickle, gherkinDocument, testCaseStartedId } : StartTestCaseInfo`
   - Updated execution of the `dispose()` function to pass in argument that is an object with information about the Test Case (Scenario).
     - The object passed in will be in the form:
       `{ pickle, gherkinDocument, result, willBeRetried, testCaseStartedId } : EndTestCaseInfo`
-  
+
 - versions >= 6.5.0
   - Context classes now support an `initialize()` function that can be defined synchronous or asynchronous. The `initialize()` function is called after the `BeforeAll` hook and before any other hooks or steps. This provides the ability to initialize a scenario context before any tests are executed with support for async operations.
   - Context classes have always supported a `dispose()` function for cleanup. However, with latest updates the `dispose()` function can be defined synchronously or asynchronously.
 - versions >= 6.4.0
   - The current Cucumber World object is now available as a constructor parameter on all classes defined for Context Injection. For more information on the World object see: [Access to Cucumber.js World object](#access-to-cucumber.js-world-object).
 
-
 ### Using Context Injection
 
 With Context Injection you first need to define one or more classes that will be injected into a binding instance. Next, you'll need to add the context types to the `@binding` decorator and implement a constructor that passes initialized instances of the context type into the binding instance.
 
 **Defining a Context class:**
 
-- Create a simple *Context* class representing the shared data. The class can have no constructor or a default empty constructor. However, to access the Cucumber World object you should define a constructor as shown in the example below.
+- Create a simple _Context_ class representing the shared data. The class can have no constructor or a default empty constructor. However, to access the Cucumber World object you should define a constructor as shown in the example below.
 
 **Synchronous example:**
 
@@ -593,7 +689,7 @@ export class ScenarioContext {
 	public initialize({ pickle, gherkinDocument }: StartTestCaseInfo): void {
 		this.id = this.makeid(5);
 		console.log(`Sync init: ${this.id}`);
-		console.log(`Start Test Case: ${this.getFeatureAndScenario(gherkinDocument.uri!, pickle.name)}`);       
+		console.log(`Start Test Case: ${this.getFeatureAndScenario(gherkinDocument.uri!, pickle.name)}`);
 	}
 	public dispose({ pickle, gherkinDocument }: EndTestCaseInfo): void {
 		console.log(`Sync dispose: ${this.id}`);
@@ -647,11 +743,9 @@ export class ScenarioContext {
 }
 ```
 
-
-
 **Initialize Binding in Step class:**
 
-- Update the `@binding()` decorator to indicate the types of context objects that are required by the 'binding' class. You can include up to nine separate *Context* objects.
+- Update the `@binding()` decorator to indicate the types of context objects that are required by the 'binding' class. You can include up to nine separate _Context_ objects.
 - Define a constructor on the `@binding` class with steps that need access to the shared data that accepts one or more context objects as parameters based on initialization of the `@binding` decorator.
 
 **Single Context class example:**
@@ -688,7 +782,10 @@ import { expect } from 'chai';
 
 @binding([ScenarioContext, SyncContext])
 export default class InjectionTestSteps1 {
-	constructor(private context: ScenarioContext, private syncContext: SyncContext) {}
+	constructor(
+		private context: ScenarioContext,
+		private syncContext: SyncContext
+	) {}
 
 	@given('The Workspace is available and valid')
 	theWorkspaceIsAvailableAndValid() {
@@ -706,8 +803,6 @@ export default class InjectionTestSteps1 {
 }
 ```
 
-
-
 ### Access to Cucumber.js World object
 
 The context object that you inject can also be configured to access the [World](https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/world.md) object from Cucumber.js, which provides the following:
@@ -716,7 +811,7 @@ The context object that you inject can also be configured to access the [World](
 - `log`: a method for [logging](https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/attachments.md#logging) information from hooks/steps
 - `parameters`: an object of parameters passed in via configuration
 
-Starting with version **6.4.0** the Cucumber World object is now passed into a *Context* class as a constructor parameter as shown below:
+Starting with version **6.4.0** the Cucumber World object is now passed into a _Context_ class as a constructor parameter as shown below:
 
 ```typescript
 import { World } from '@cucumber/cucumber';
@@ -739,15 +834,15 @@ In the example shown above, the world object instance passed in to the construct
 
 **NOTE:** `BeforeAll` and `AfterAll` hooks do not have access to the scenario context.
 
-*Context* classes, as demonstrated by the `ScenarioContext` example above, also support a `dispose()` function that is called when the execution of a test scenario is complete. 
+_Context_ classes, as demonstrated by the `ScenarioContext` example above, also support a `dispose()` function that is called when the execution of a test scenario is complete.
 
 With instance initialization, and dispose functionality, you have the ability to initialize common support operations and data needed for scenario test runs, and cleanup any resources when scenario test runs are complete.
 
 ### Access to the World object without using a constructor
 
-**NOTE:** This approach of accessing the Cucumber World object is still supported. However, the ability to access the world object during *Context* initialization provides much better control over when context data is initialized versus relying on execution of a hook. As a result, using a `@before` hook as shown below is not recommended.
+**NOTE:** This approach of accessing the Cucumber World object is still supported. However, the ability to access the world object during _Context_ initialization provides much better control over when context data is initialized versus relying on execution of a hook. As a result, using a `@before` hook as shown below is not recommended.
 
-With this approach, you would define a world property on simple *Context* class that you're injecting:
+With this approach, you would define a world property on simple _Context_ class that you're injecting:
 
 ```typescript
 import { World } from '@cucumber/cucumber';

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>;