@candidpartners/eslint-config-base

@candidpartners/eslint-config-base

This package provides Candid's base JS .eslintrc (without React plugins) as an extensible shared config.

This is based primarily off of AirBnB's JavaScript Style Guide

Usage

We export two ESLint configurations for your usage.

@candidpartners/eslint-config-base

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

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

npm info "@candidpartners/eslint-config-base@latest" peerDependencies

If using npm 5+, use this shortcut

npx install-peerdeps --dev @candidpartners/eslint-config-base

If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. Otherwise, run npm info "@candidpartners/eslint-config-base@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency.

If using npm < 5, Linux/OSX users can run

(
  export PKG=@candidpartners/eslint-config-base;
  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 @candidpartners/eslint-config-base eslint@^#.#.# eslint-plugin-import@^#.#.#

If using npm < 5, 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 @candidpartners/eslint-config-base

The cli will produce and run a command like:

npm install --save-dev @candidpartners/eslint-config-base eslint@^#.#.# eslint-plugin-import@^#.#.#

1. Add "extends": "candid-base" to your .eslintrc.

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.