eslint-config-kensho

eslint-config-kensho

This ESLint config extends Airbnb's config (based on their style guide) to work with TypeScript.

Since the upstream config is well-maintained and justified, we try to stick as close to it as possible. All divergences are annotated, and tend towards increased ES2019 support, Prettier adoption, and TypeScript compatibility, rather than stylistic preferences.

Usage

To add linting to a project, first install ESLint, Prettier, TypeScript, and this config as development dependencies:

$ npm i -D eslint prettier typescript eslint-config-kensho

Add an ESLint config which extends the config, e.g.:

extends: kensho

Add a script in package.json to run the linter, e.g.:

{
  "scripts": {
    "lint": "eslint src --ext=tsx"
  }
}

JavaScript

A JavaScript config is also provided, for projects which do not use TypeScript. To use it, extend kensho/javascript instead of kensho, e.g.:

extends: kensho/javascript

Caveat

The ESLint plugin dependencies specified in package.json should actually be peer dependencies (see this issue), and installed alongside ESLint and this config. In practice, this is quite tedious, so we have instead specified them as dependencies and rely on npm's dependency flattening to install them alongside the linter.

Note that this approach is technically incorrect, and if any plugin cannot be flattened this way (e.g. due to a conflicting version somewhere else in your dependency tree), this config will break. Since our projects use only this config, we feel that practicality outweighs absolute correctness in this case.