https://github.com/darrinholst/eslint-plugin-cucumber

https://github.com/darrinholst/eslint-plugin-cucumber

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/darrinholst/eslint-plugin-cucumber
• Owner: darrinholst
• License: mit
• Created: 2015-10-29T18:41:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-05-07T02:16:11.000Z (over 1 year ago)
• Last Synced: 2024-06-30T04:54:36.461Z (4 months ago)
• Language: JavaScript
• Size: 259 KB
• Stars: 7
• Watchers: 2
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - Cucumber - Linting rules for Cucumber. (Plugins / Testing Tools)

README

        
# eslint-plugin-cucumber

[![NPM](https://nodei.co/npm/eslint-plugin-cucumber.png)](https://nodei.co/npm/eslint-plugin-cucumber/)

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-cucumber`:

```

$ npm install eslint-plugin-cucumber --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-cucumber` globally.

## Usage

Add `cucumber` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "cucumber"

    ]

}

```

Then configure the rules you want to use under the rules section.

```json

{

    "rules": {

        "cucumber/async-then": 2,

        "cucumber/expression-type": 2,

        "cucumber/no-restricted-tags": [2, "wip", "broken", "foo"],

        "cucumber/no-arrow-functions": 2

    }

}

```

## Supported Rules

| Name               | Description                                                                                                         |

| -------------      | -------------                                                                                                       |

| [async-then](docs/rules/async-then.md)                 | If you assume asynchronous steps/hooks then your implementation should either be an async function, return a promise or provide a callback function|

| [expression-type](docs/rules/expression-type.md)       | Restrict steps to either Cucumber Expressions or Regular Expressions                                                |

| [no-restricted-tags](docs/rules/no-restricted-tags.md) | Restrict usage of specified tags                                                                                    |

| [no-arrow-functions](docs/rules/no-arrow-functions.md) | Restrict usage of arrow functions on step definitions                                                               |

## For Maintainers

#### Releasing

1. bump version

1. `npm publish`

1. tag release (`git tag vx.x.x && git push origin master --tags`)

1. build github release (`npx release`)