# wdio-cucumber-framework
> A WebdriverIO plugin. Adapter for Cucumber testing framework.
Latest version **2.2.8** (published 2018-10-31) · MIT license · 0 weekly downloads
## Install
```sh
npm install wdio-cucumber-framework
pnpm add wdio-cucumber-framework
yarn add wdio-cucumber-framework
bun add wdio-cucumber-framework
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.2.8 |
| Published | 2018-10-31 |
| First published | 2015-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 81.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 75 |
| Author | Christian Bromann |
| Maintainers | christian-bromann |
| Keywords | cucumber, BDD, webdriverio, wdio, wdio-plugin, wdio-framework |
## Links
- npm: https://www.npmjs.com/package/wdio-cucumber-framework
- Repository: https://github.com/webdriverio/wdio-cucumber-framework
- Homepage: https://github.com/webdriverio/wdio-cucumber-framework#readme
- Issues: https://github.com/webdriverio/wdio-cucumber-framework/issues
- npm.io page: https://npm.io/package/wdio-cucumber-framework
## Dependencies (6)
- [glob](https://npm.io/package/glob.md) ^7.1.2
- [is-glob](https://npm.io/package/is-glob.md) ^4.0.0
- [mockery](https://npm.io/package/mockery.md) ~2.1.0
- [cucumber](https://npm.io/package/cucumber.md) ^4.1.0
- [wdio-sync](https://npm.io/package/wdio-sync.md) 0.7.3
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
## Recent versions
- 2.2.8 (latest) — 2018-10-31
- 2.2.7 — 2018-09-03
- 2.2.6 — 2018-08-25
- 2.2.5 — 2018-08-24
- 2.2.4 — 2018-08-24
- 2.2.3 — 2018-08-13
- 2.2.2 — 2018-07-30
- 2.2.1 — 2018-07-26
- 2.2.0 — 2018-07-17
- 2.1.0 — 2018-04-17
- 2.0.1 — 2018-04-03
- 2.0.0 — 2018-03-28
- 1.1.1 — 2018-03-27
- 1.1.0 — 2018-01-27
- 1.0.4 — 2018-01-26
- … 30 more at https://npm.io/package/wdio-cucumber-framework/versions
## README
WDIO Cucumber Framework Adapter
===============================
[](https://travis-ci.org/webdriverio/wdio-cucumber-framework) [](https://codeclimate.com/github/webdriverio/wdio-cucumber-framework/coverage) [](https://david-dm.org/webdriverio/wdio-cucumber-framework)
***
> A WebdriverIO plugin. Adapter for CucumberJS v4 testing framework. To use v2 install this package with v1.1.1 and to use v1 with v0.3.1.
## Installation
The easiest way is to keep `wdio-cucumber-framework` as a devDependency in your `package.json`.
```json
{
"devDependencies": {
"wdio-cucumber-framework": "~2.0.0"
}
}
```
You can simple do it by:
```bash
npm install wdio-cucumber-framework --save-dev
```
Instructions on how to install `WebdriverIO` can be found [here.](http://webdriver.io/guide/getstarted/install.html)
## Configuration
Following code shows the default wdio test runner configuration...
```js
// wdio.conf.js
module.exports = {
// ...
framework: 'cucumber',
cucumberOpts: {
timeout: 10000
}
// ...
};
```
## `cucumberOpts` Options
### backtrace
Show full backtrace for errors.
Type: `Boolean`
Default: `false`
### compiler
Require files with the given EXTENSION after requiring MODULE.
Type: `String[]`
Default: `*[]*`
Example: `['js:babel-core/register']`
### 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`
Default: `false`
### failFast
Abort the run on first failure.
Type: `Boolean`
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`
Default: `false`
### name
Only execute the scenarios with name matching the expression (repeatable).
Type: `REGEXP[]`
Default: `[]`
### profile
Specify the profile to use.
Type: `String[]`
Default: `[]`
### require
Require files containing your step definitions before executing features. You can also specify a glob to your step definitions.
Type: `String[]`
Default: `[]`
Example: `[path.join(__dirname, 'step-definitions', 'my-steps.js')]`
### snippetSyntax
Specify a custom snippet syntax.
Type: `String`
Default: `undefined`
### snippets
Hide step definition snippets for pending steps.
Type: `Boolean`
Default: `true`
### source
Hide source uris.
Type: `Boolean`
Default: `true`
### strict
Fail if there are any undefined or pending steps
Type: `Boolean`
Default: `false`
### 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.
Type: `String`
Default: ``
### tagsInTitle
Add cucumber tags to feature or scenario name
Type: `Boolean[]`
Default: `false`
### timeout
Timeout in milliseconds for step definitions.
Type: `Number`
Default: `30000`
## Development
All commands can be found in the package.json. The most important are:
Watch changes:
```sh
$ npm run watch
```
Run tests:
```sh
$ npm test
# run test with coverage report:
$ npm run test:cover
```
Build package:
```sh
$ npm build
```
----
For more information on WebdriverIO see the [homepage](http://webdriver.io).
---
_Source: https://npm.io/package/wdio-cucumber-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._