eslint-config-cargurus

eslint-config-cargurus

This package provides Cargurus's .eslintrc as an extensible shared config.

Usage

We export three ESLint configurations for your usage.

eslint-config-cargurus

Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires eslint, eslint-plugin-import, eslint-plugin-react, and eslint-plugin-jsx-a11y.

1. Install the correct versions of each package, which are listed by the command:

npm info "eslint-config-cargurus@latest" peerDependencies

Linux/OSX users can run

(
  export PKG=eslint-config-cargurus;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command like:

npm install --save-dev eslint-config-cargurus eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#

Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev eslint-config-cargurus

The cli will produce and run a command like:

npm install --save-dev eslint-config-cargurus eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#

1. Add "extends": "cargurus" to your .eslintrc

eslint-config-cargurus/base

This entry point is deprecated. See eslint-config-cargurus-base.

eslint-config-cargurus/legacy

This entry point is deprecated. See eslint-config-cargurus-base.

See cargurus's Javascript styleguide and the ESlint config docs for more information.

Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.