https://github.com/poenneby/eslint-plugin-codeceptjs
Eslint rules for CodeceptJS
https://github.com/poenneby/eslint-plugin-codeceptjs
codeceptjs eslint eslint-plugin-codeceptjs eslint-rules
Last synced: 6 months ago
JSON representation
Eslint rules for CodeceptJS
- Host: GitHub
- URL: https://github.com/poenneby/eslint-plugin-codeceptjs
- Owner: poenneby
- Created: 2016-12-16T16:39:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T20:31:18.000Z (over 1 year ago)
- Last Synced: 2025-05-28T13:11:42.080Z (7 months ago)
- Topics: codeceptjs, eslint, eslint-plugin-codeceptjs, eslint-rules
- Language: JavaScript
- Size: 102 KB
- Stars: 15
- Watchers: 2
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-plugin-codeceptjs
Eslint rules for CodeceptJS
## Installation
You'll first need to install [ESLint](http://eslint.org):
```
$ 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