eslint-plugin-curology

Custom ESLint rules and sharable config used at Curology.

Installation

You'll first need to install ESLint:

$ yarn add eslint eslint-plugin-curology  --dev

Usage (Config)

To enable this configuration use the extends property in your .eslintrc config file:

{
  "extends": [...otherConfig, "plugin:curology/recommended"]
}

"plugin:curology/recommended" must be the last entry in "extends" for best eslint-plugin-prettier compatibility.

There is also a "plugin:curology/cypress" for Cypress rules and configuration.

Usage (Plugin)

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

{
  "plugins": ["curology"]
}

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

{
  "rules": {
    "curology/rule-name": 2
  }
}

Supported Rules

• no-single-letter-variable: prevent a single letter variable declaration (included in recommended config)
• prefer-named-import: prefer named imports