!build status

eslint-plugin-codeceptjs

Eslint rules for CodeceptJS

Installation

You'll first need to install ESLint:

``
$ npm i eslint --save-dev
`

Next, install eslint-plugin-codeceptjs:

`
$ npm install eslint-plugin-codeceptjs --save-dev
`

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

Usage

The simplest way to use this plugin is to add the /recommended config to the extends section of your .eslintrc configuration file:

`json
{
"extends": ["plugin:codeceptjs/recommended"]
}
`

Alternatively, add codeceptjs to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

`json
{
"plugins": [
"codeceptjs"
],
"env": {
"codeceptjs/codeceptjs": true
}
}
`

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

`
{
"rules": {
"codeceptjs/no-actor-in-scenario": 2
}
}
`


Supported Rules

| Name | Description | Recommended | Fixable |
|------|-------------|-------------|---------|
| no-actor-in-scenario | Prevents the use of the actor in a Scenario and delegate to page objects | | |
| no-exclusive-tests | Prevents the use of Scenario.only or Data.only to focus tests | ![error] | ![fixable] |
| no-skipped-tests | Prevents the use of xScenario or Scenario.skip to [skip tests][1] | ![error] | ![fixable] |
| no-pause-in-scenario | Prevents the use of pause()` in a test | ![error] | ![fixable] |

[1]: https://codecept.io/basics/#skipping

[fixable]: https://img.shields.io/badge/-fixable-green.svg
[warn]: https://img.shields.io/badge/-warn-yellow.svg
[error]: https://img.shields.io/badge/-error-red.svg