@leemillward/eslint-config

This package extends the eslint-config-airbnb-base ruleset with our own set of JS linting rules. The structure is based on that package and also @justeat/eslint-config/fozzie-config-fozzle.

Many thanks to the work that the Airbnb team have put in on creating their template for extension rules – we have liberally borrowed from their structure and documentation in creating this ruleset.

Usage

@leemillward/eslint-config

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

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

npm info "@leemillward/eslint-config@latest" peerDependencies

Linux/OSX users can simply run

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

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 @leemillward/eslint-config

The cli will produce and run a command like:

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

2. Add "extends": "@leemillward/eslint-config" to your .eslintrc

Testing

You can run tests on this ruleset with npm test.

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