Cypress Developer ESLint Plugin

Common ESLint rules shared by Cypress packages.

Note that this is meant for packages that are part of Cypress and not necessarily for a project that uses Cypress.

Installation

npm install --save-dev eslint-plugin-cypress-dev

Usage

Extend one or more of the presets depending on the nature of the package:

1// .eslintrc.json
2{
3  "extends": [
4    "plugin:cypress-dev/general",
5    "plugin:cypress-dev/tests",
6    "plugin:cypress-dev/react"
7  ]
8}

You can relax rules

1// .eslintrc.json
2{
3  "extends": [
4    "plugin:cypress-dev/general"
5  ],
6  "rules": {
7    "comma-dangle": "off",
8    "no-debugger": "warn"
9  },
10  "env": {
11    "node": true
12  }
13}

Presets

general

The majority of the rules concerning JavaScript. Should usually be used at the root of the package.

tests

Test-specific configuration and rules. Should be used within the test directory.

react

React and JSX-specific configuration and rules.

Dependencies

Due to a limitation in how ESLint plugins work, your package needs to install the ESLint plugins that this plugin depends on:

If using the tests preset:

1npm install --save-dev eslint-plugin-mocha

If using the react preset:

1npm install --save-dev babel-eslint eslint-plugin-react

Editors

VSCode

Use plugin ESLint by Dirk Baeumer to lint and auto fix JS files using ESLint. This repository includes example .vscode/settings.json file.

Atom

Install package linter-eslint (and its dependencies) to enable linting. Go into the settings for this package and enable "Fix on save" option to auto-fix white space issues and other things.

Sublime Text

Install ESLint-Formatter, then set the following settings:

1{
2  "format_on_save": true,
3  "debug": true
4}

License

This project is licensed under the terms of the MIT license.