@chancedigital/eslint-config

Chance Digital ESLint Config

Shareable configuration for ESLint following Chance Digital Coding Standards.

Installation

You should install this configuration along with its peerDependencies as devDependencies in your project:

npm i -D @chancedigital/eslint-config eslint@7 eslint-plugin-import@2 @babel/eslint-parser@7

Usage

Extend the configuration from your project's ESLint configuration:

// .eslintrc
{
  "extends": ["@chancedigital"]
}

Supersets

In addition to the base ruleset, you may wish to install supersets of rules based on the project you are working on. Supersets are not mutually exclusive and can be combined (for example, if you are working on a WordPress project that uses React components, you can use both the react and wp supersets).

You can extend any superset in .eslintrc by adding the standard into an extends array.

// .eslintrc
{
  "extends": [
    "@chancedigital/eslint-config/[SUPERSET_NAME]"
  ]
}

The following is a table of available supersets along with their required devDependencies:

Superset	devDependencies
jest	eslint-plugin-jest@24 eslint-plugin-testing-library@4
mocha	eslint-plugin-mocha@8
node	eslint-plugin-node@11
react	eslint-plugin-react@7 eslint-plugin-react-hooks@4 eslint-plugin-jsx-a11y eslint-plugin-jest@24 eslint-plugin-testing-library@4 @babel/preset-react @7
typescript	@typescript-eslint/parser@4 @typescript-eslint/eslint-plugin@4 typescript@4
wp	eslint-plugin-wpcalypso@5 @wordpress/eslint-plugin@7

Test Standards

As of v5.0, we have removed the Jest rules from the standard config. This is because some projects may use other tools such as Mocha. To use rules for Jest or Mocha, install the corresponding plugin and extend the superset as follows:

# For Jest
npm i -D eslint-plugin-jest@23

# For Mocha
npm i -D eslint-plugin-mocha@7

// .eslintrc
"extends": [
  // For Jest
  "@chancedigital/eslint-config/jest"
  // For Mocha
  "@chancedigital/eslint-config/mocha"
]

More Info

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

Changelog

9.0.0 (2021-07-06)

• Updated README to use npm instead of yarn for installation instructions (our projects will almost always use npm 7 moving forward)
• Use more permissive MIT license
• Fix invalid eqeqeq option in wp superset

BREAKING CHANGES

• Drop deprecated babel-eslint in favor of @babel/eslint-parser
  • This should function mostly the same, but no guarantees!
  • This also required @babel/preset-react as a peer dependency if using the react superset
• Node superset uses plugin:node/recommended instead of plugin:node/recommended-script, which means packages that use "type": "module" won't need any rule overrides by default.
• Disable no-process-exit and node/no-process-exit in the Node superset.