@chancedigital/eslint-config

Chance Digital ESLint Config

ESLint configuration following Chance Digital Coding Standards. WIP.

Usage

You should install this configuration and peer dependencies as devDependencies in your project:

yarn add -D @chancedigital/eslint-config eslint eslint-plugin-import eslint-plugin-jest babel-eslint

If you're planning to use the React superset of rules, you should also install eslint-plugin-react and eslint-plugin-react-hooks:

yarn add -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y

If you're planning to use the WordPress superset of rules, you should also install eslint-plugin-wpcalypso:

yarn add -D eslint-plugin-wpcalypso

Next, extend the configuration from your project's ESLint configuration:

"extends": "@chancedigital"

Or, if your project uses React and you want to opt in to additional React-specific rules, extend the React superset:

"extends": "@chancedigital/eslint-config/react"

...or for WordPress projects:

"extends": "@chancedigital/eslint-config/wp"

Refer to the ESLint documentation on Shareable Configs for more information.