eslint-plugin-cucumber
v2.0.0
Published
eslint rules for cucumber steps
Downloads
118,754
Maintainers
Readme
eslint-plugin-cucumber
Installation
You'll first need to install ESLint:
$ 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:
{
"plugins": [
"cucumber"
]
}
Then configure the rules you want to use under the rules section.
{
"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 | 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 | Restrict steps to either Cucumber Expressions or Regular Expressions | | no-restricted-tags | Restrict usage of specified tags | | no-arrow-functions | Restrict usage of arrow functions on step definitions |
For Maintainers
Releasing
- bump version
npm publish
- tag release (
git tag vx.x.x && git push origin master --tags
) - build github release (
npx release
)