eslint-plugin-cypress-test-best-practices v0.1.5

eslint-plugin-cypress-test-best-practices

best practices for cypress tests. From my experience at Cancer Research UK.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-cypress-test-best-practices:

$ npm install eslint-plugin-cypress-test-best-practices --save-dev

Peer dependencies

$ npm install eslint-plugin-cypress --save-dev
$ npm install eslint-plugin-chai-friendly --save-dev

Usage

Add cypress-test-best-practices to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "cypress-test-best-practices"
    ]
}

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

{
    "rules": {
        "cypress-test-best-practices/at-least-one-assertion": 2
    }
}

Use the recommended configuration and you can forego configuring rules individually. See below for which rules are included.

{
  "extends": [
    "plugin:cypress-test-best-practices/recommended"
  ]
}

Supported Rules

• See docs folder