@wdio/cucumber-framework 8.15.10 → 8.16.0

package/README.md

@@ -44,38 +44,18 @@ Type: `String[]`<br />
 Default: `[]`<br />
 Example: `['@babel/register']` or `[['@babel/register', { rootMode: 'upward', ignore: ['node_modules'] }]]`
 
-### failAmbiguousDefinitions
-**Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself**
-Treat ambiguous definitions as errors.
-
-Type: `Boolean`<br />
-Default: `false`
-
 ### failFast
 Abort the run on first failure.
 
 Type: `Boolean`<br />
 Default: `false`
 
-### ignoreUndefinedDefinitions
-**Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself**
-Treat undefined definitions as warnings.
-
-Type: `Boolean`<br />
-Default: `false`
-
 ### name
 Only execute the scenarios with name matching the expression (repeatable).
 
 Type: `REGEXP[]`<br />
 Default: `[]`
 
-### profile
-Specify the profile to use.
-
-Type: `String[]`<br />
-Default: `[]`
-
 ### require
 Require files containing your step definitions before executing features. You can also specify a glob to your step definitions.
 
@@ -83,23 +63,12 @@ Type: `String[]`<br />
 Default: `[]`<br />
 Example: `[path.join(__dirname, 'step-definitions', 'my-steps.js')]`
 
-### snippetSyntax
-Specify a custom snippet syntax.
-
-Type: `String`<br />
-Default: `undefined`
-
-### snippets
-Hide step definition snippets for pending steps.
-
-Type: `Boolean`<br />
-Default: `true`
-
-### source
-Hide source uris.
+### import
+Paths to where your support code is, for ESM.
 
-Type: `Boolean`<br />
-Default: `true`
+Type: `String[]`<br />
+Default: `[]`<br />
+Example: `[path.join(__dirname, 'step-definitions', 'my-steps.js')]`
 
 ### strict
 Fail if there are any undefined or pending steps
@@ -107,23 +76,17 @@ Fail if there are any undefined or pending steps
 Type: `Boolean`<br />
 Default: `false`
 
-### tagExpression
+### tags
 Only execute the features or scenarios with tags matching the expression. Note that untagged
 features will still spawn a Selenium session (see issue [webdriverio/webdriverio#1247](https://github.com/webdriverio/webdriverio/issues/1247)).
 Please see the [Cucumber documentation](https://docs.cucumber.io/cucumber/api/#tag-expressions) for more details.
 If passing as a command-line argument, compound expressions may need to be enclosed in three sets of double quotes if WebdriverIO is invoked using `npx` on Windows.
 
-E.g.: `npx wdio wdio.config.js --cucumberOpts.tagExpression """@Smoke and not @Pending"""`
+E.g.: `npx wdio wdio.config.js --cucumberOpts.tags """@Smoke and not @Pending"""`
 
 Type: `String`<br />
 Default: ``
 
-### tagsInTitle
-Add cucumber tags to feature or scenario name
-
-Type: `Boolean`<br />
-Default: `false`
-
 ### timeout
 Timeout in milliseconds for step definitions.
 
@@ -141,6 +104,50 @@ Only retries the features or scenarios with tags matching the expression (repeat
 
 Type: `RegExp`
 
+### tagsInTitle
+Add cucumber tags to feature or scenario name
+
+Type: `Boolean`<br />
+Default: `false`
+
+***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself***<br/>
+
+### ignoreUndefinedDefinitions
+Treat undefined definitions as warnings.
+
+Type: `Boolean`<br />
+Default: `false`
+
+***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself***<br/>
+
+### failAmbiguousDefinitions
+Treat ambiguous definitions as errors.
+
+Type: `Boolean`<br />
+Default: `false`
+
+***Please note that this is a @wdio/cucumber-framework specific option and not recognized by cucumber-js itself***<br/>
+
+### tagExpression
+Only execute the features or scenarios with tags matching the expression. Note that untagged
+features will still spawn a Selenium session (see issue [webdriverio/webdriverio#1247](https://github.com/webdriverio/webdriverio/issues/1247)).
+Please see the [Cucumber documentation](https://docs.cucumber.io/cucumber/api/#tag-expressions) for more details.
+If passing as a command-line argument, compound expressions may need to be enclosed in three sets of double quotes if WebdriverIO is invoked using `npx` on Windows.
+
+E.g.: `npx wdio wdio.config.js --cucumberOpts.tagExpression """@Smoke and not @Pending"""`
+
+Type: `String`<br />
+Default: ``
+
+***Please note that this option would be deprecated in future. Use [`tags`](#tags) config property instead***
+
+#### profile
+Specify the profile to use.
+
+Type: `string[]`<br />
+Default: `[]`
+
+***Kindly take note that only specific values (worldParameters, name, retryTagFilter) are supported within profiles, as `cucumberOpts` takes precedence. Additionally, when using a profile, make sure that the mentioned values are not declared within `cucumberOpts`.***
 ----
 
 For more information on WebdriverIO see the [homepage](http://webdriver.io).

package/build/cjs/index.d.ts

@@ -1,4 +1,4 @@
-declare const After: any, AfterAll: any, AfterStep: any, Before: any, BeforeAll: any, BeforeStep: any, Given: any, Then: any, When: any, defineParameterType: any, defineStep: any, setDefaultTimeout: any, setDefinitionFunctionWrapper: any, setWorldConstructor: any, DataTable: any, World: any;
+declare const After: any, AfterAll: any, AfterStep: any, Before: any, BeforeAll: any, BeforeStep: any, Given: any, When: any, Then: any, DataTable: any, World: any, setDefaultTimeout: any, setDefinitionFunctionWrapper: any, setWorldConstructor: any, defineParameterType: any, defineStep: any;
 declare const adapterFactory: {
     init: (...args: any[]) => Promise<import("../index.js").CucumberAdapter>;
     After: any;
@@ -8,14 +8,14 @@ declare const adapterFactory: {
     BeforeAll: any;
     BeforeStep: any;
     Given: any;
-    Then: any;
     When: any;
-    defineParameterType: any;
-    defineStep: any;
+    Then: any;
+    DataTable: any;
+    World: any;
     setDefaultTimeout: any;
     setDefinitionFunctionWrapper: any;
     setWorldConstructor: any;
-    DataTable: any;
-    World: any;
+    defineParameterType: any;
+    defineStep: any;
 };
 //# sourceMappingURL=index.d.ts.map

package/build/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":"AAAA,QAAA,MACI,KAAK,OACL,QAAQ,OACR,SAAS,OACT,MAAM,OACN,SAAS,OACT,UAAU,OAEV,KAAK,OACL,IAAI,OACJ,IAAI,OAEJ,mBAAmB,OACnB,UAAU,OACV,iBAAiB,OACjB,4BAA4B,OAC5B,mBAAmB,OAEnB,SAAS,OACT,KAAK,KACwB,CAAA;AAEjC,QAAA,MAAM,cAAc;oBACqC,GAAG,EAAE;;;;;;;;;;;;;;;;;CA0B7D,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":"AAAA,QAAA,MACI,KAAK,OACL,QAAQ,OACR,SAAS,OAET,MAAM,OACN,SAAS,OACT,UAAU,OAEV,KAAK,OACL,IAAI,OACJ,IAAI,OAEJ,SAAS,OAET,KAAK,OAEL,iBAAiB,OACjB,4BAA4B,OAC5B,mBAAmB,OACnB,mBAAmB,OACnB,UAAU,KAEmB,CAAA;AAEjC,QAAA,MAAM,cAAc;oBACqC,GAAG,EAAE;;;;;;;;;;;;;;;;;CA4B7D,CAAA"}

package/build/cjs/index.js

@@ -1,5 +1,5 @@
 "use strict";
-const { After, AfterAll, AfterStep, Before, BeforeAll, BeforeStep, Given, Then, When, defineParameterType, defineStep, setDefaultTimeout, setDefinitionFunctionWrapper, setWorldConstructor, DataTable, World, } = require('@cucumber/cucumber');
+const { After, AfterAll, AfterStep, Before, BeforeAll, BeforeStep, Given, When, Then, DataTable, World, setDefaultTimeout, setDefinitionFunctionWrapper, setWorldConstructor, defineParameterType, defineStep } = require('@cucumber/cucumber');
 const adapterFactory = {
     init: async function initCucumberFramework(...args) {
         const { CucumberAdapter } = await import('../index.js');
@@ -15,14 +15,14 @@ const adapterFactory = {
     BeforeAll,
     BeforeStep,
     Given,
-    Then,
     When,
-    defineParameterType,
-    defineStep,
+    Then,
+    DataTable,
+    World,
     setDefaultTimeout,
     setDefinitionFunctionWrapper,
     setWorldConstructor,
-    DataTable,
-    World,
+    defineParameterType,
+    defineStep
 };
 module.exports = adapterFactory;

package/build/constants.d.ts

@@ -1,21 +1,5 @@
-import type { Pickle, PickleStep } from '@cucumber/messages';
 import type { CucumberOptions } from './types.js';
 export declare const DEFAULT_TIMEOUT = 60000;
+export declare const FILE_PROTOCOL = "file://";
 export declare const DEFAULT_OPTS: CucumberOptions;
-export declare const NOOP: () => void;
-export declare const CUCUMBER_HOOK_DEFINITION_TYPES: readonly ["beforeTestRunHookDefinitionConfigs", "beforeTestCaseHookDefinitionConfigs", "afterTestCaseHookDefinitionConfigs", "afterTestRunHookDefinitionConfigs"];
-/**
- * The pickle step needs to have a keyword for the reporters, otherwise reporters like
- * the allure or spec reporter won't show the `Given|When|Then` words
- */
-export interface ReporterStep extends PickleStep {
-    keyword?: string;
-}
-/**
- * The pickle scenario needs to have a rule for the reporters, otherwise reporters like
- * the allure or spec reporter won't show the rule
- */
-export interface ReporterScenario extends Pickle {
-    rule?: string;
-}
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,eAAO,MAAM,eAAe,QAAQ,CAAA;AAEpC,eAAO,MAAM,YAAY,EAAE,eAkB1B,CAAA;AAGD,eAAO,MAAM,IAAI,YAAiB,CAAA;AAElC,eAAO,MAAM,8BAA8B,mKAKjC,CAAA;AAEV;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,eAAO,MAAM,eAAe,QAAQ,CAAA;AAEpC,eAAO,MAAM,aAAa,YAAY,CAAA;AAMtC,eAAO,MAAM,YAAY,EAAE,eA2B1B,CAAA"}

package/build/constants.js

@@ -1,28 +1,34 @@
+import url from 'node:url';
+import path from 'node:path';
 export const DEFAULT_TIMEOUT = 60000;
+export const FILE_PROTOCOL = 'file://';
+const cucumberFormatter = path.resolve(url.fileURLToPath(import.meta.url), '../cucumberFormatter.js');
+const isWindows = process.platform === 'win32';
 export const DEFAULT_OPTS = {
+    paths: [],
     backtrace: false,
-    requireModule: [],
-    failAmbiguousDefinitions: false,
+    dryRun: false,
+    forceExit: false,
     failFast: false,
-    ignoreUndefinedDefinitions: false,
-    names: [],
-    require: [],
+    format: [isWindows ? `file://${cucumberFormatter}` : cucumberFormatter],
+    formatOptions: {},
+    import: [],
+    language: 'en',
+    name: [],
     order: 'defined',
-    snippets: true,
-    source: true,
+    parallel: 0,
+    publish: false,
+    require: [],
+    requireModule: [],
+    retry: 0,
     strict: false,
-    tagExpression: '',
-    tagsInTitle: false,
+    tags: '',
+    worldParameters: {},
     timeout: DEFAULT_TIMEOUT,
-    retry: 0,
     scenarioLevelReporter: false,
-    featureDefaultLanguage: 'en'
+    tagsInTitle: false,
+    ignoreUndefinedDefinitions: false,
+    failAmbiguousDefinitions: false,
+    tagExpression: '',
+    profiles: []
 };
-/* istanbul ignore next */
-export const NOOP = function () { };
-export const CUCUMBER_HOOK_DEFINITION_TYPES = [
-    'beforeTestRunHookDefinitionConfigs',
-    'beforeTestCaseHookDefinitionConfigs',
-    'afterTestCaseHookDefinitionConfigs',
-    'afterTestRunHookDefinitionConfigs',
-];

package/build/cucumberFormatter.d.ts

@@ -0,0 +1,43 @@
+import type { IFormatterOptions } from '@cucumber/cucumber';
+import { Formatter } from '@cucumber/cucumber';
+import type { GherkinDocument, Feature, Pickle, PickleStep, TestCase, TestCaseStarted, TestStep, TestStepStarted, TestStepFinished, TestStepResult } from '@cucumber/messages';
+export default class CucumberFormatter extends Formatter {
+    private _gherkinDocEvents;
+    private _scenarios;
+    private _testCases;
+    private _currentTestCase?;
+    private _currentPickle?;
+    private _suiteMap;
+    private _pickleMap;
+    private _currentDoc;
+    private _startedFeatures;
+    private reporter;
+    private cid;
+    private specs;
+    private eventEmitter;
+    private scenarioLevelReporter;
+    private tagsInTitle;
+    private ignoreUndefinedDefinitions;
+    private failAmbiguousDefinitions;
+    private failedCount;
+    private _featureStart?;
+    private _scenarioStart?;
+    private _testStart?;
+    constructor(options: IFormatterOptions);
+    emit(event: string, payload: any): void;
+    usesSpecGrouping(): boolean;
+    featureIsStarted(feature: string): boolean;
+    getTitle(featureOrScenario: Feature | Pickle): string;
+    afterHook(uri: string, feature: Feature, scenario: Pickle, step: TestStep, result: TestStepResult): void;
+    afterTest(uri: string, feature: Feature, scenario: Pickle, step: PickleStep, result: TestStepResult): void;
+    onGherkinDocument(gherkinDocEvent: GherkinDocument): void;
+    onTestRunStarted(): void;
+    onPickleAccepted(pickleEvent: Pickle): void;
+    onTestCasePrepared(testCase: TestCase): void;
+    onTestCaseStarted(testcase: TestCaseStarted): void;
+    onTestStepStarted(testStepStartedEvent: TestStepStarted): void;
+    onTestStepFinished(testStepFinishedEvent: TestStepFinished): void;
+    onTestCaseFinished(results: TestStepResult[]): void;
+    onTestRunFinished(): void;
+}
+//# sourceMappingURL=cucumberFormatter.d.ts.map

package/build/cucumberFormatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cucumberFormatter.d.ts","sourceRoot":"","sources":["../src/cucumberFormatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAU,MAAM,oBAAoB,CAAA;AAOtD,OAAO,KAAK,EAER,eAAe,EAEf,OAAO,EACP,MAAM,EAEN,UAAU,EACV,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,cAAc,EAEjB,MAAM,oBAAoB,CAAA;AAa3B,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,SAAS;IACpD,OAAO,CAAC,iBAAiB,CAAwB;IACjD,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAC1C,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,SAAS,CAAiC;IAClD,OAAO,CAAC,UAAU,CAAiC;IACnD,OAAO,CAAC,WAAW,CAAoC;IACvD,OAAO,CAAC,gBAAgB,CAAe;IAEvC,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,GAAG,CAAQ;IACnB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,0BAA0B,CAAS;IAC3C,OAAO,CAAC,wBAAwB,CAAS;IAEzC,OAAO,CAAC,WAAW,CAAI;IAEvB,OAAO,CAAC,aAAa,CAAC,CAAM;IAC5B,OAAO,CAAC,cAAc,CAAC,CAAM;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAM;gBAEb,OAAO,EAAE,iBAAiB;IA+CtC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAUhC,gBAAgB;IAIhB,gBAAgB,CAAC,OAAO,EAAE,MAAM;IAIhC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM;IAS5C,SAAS,CACL,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,cAAc;IAsB1B,SAAS,CACL,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,cAAc;IA6F1B,iBAAiB,CAAC,eAAe,EAAE,eAAe;IASlD,gBAAgB;IAsBhB,gBAAgB,CAAC,WAAW,EAAE,MAAM;IAQpC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ;IAIrC,iBAAiB,CAAC,QAAQ,EAAE,eAAe;IA+F3C,iBAAiB,CAAC,oBAAoB,EAAE,eAAe;IA4CvD,kBAAkB,CAAC,qBAAqB,EAAE,gBAAgB;IAkD1D,kBAAkB,CAAC,OAAO,EAAE,cAAc,EAAE;IAyC5C,iBAAiB;CA2CpB"}