@cypress-design/eslint-plugin

a plugin to help migration to @cypress-design

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-cypress-design-eslint-plugin:

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

Usage

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

{
  "plugins": ["cypress-design-eslint-plugin"]
}

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

{
  "rules": {
    "cypress-design-eslint-plugin/rule-name": 2
  }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.