ESLint config

ESLint configuration. Currently based on eslint-config-airbnb.

Installation

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

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

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

Linux/OSX users can run

(
  export PKG=@auxilin/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 @auxilin/eslint-config eslint@#.#.# babel-eslint@#.#.# eslint-plugin-import@#.#.# eslint-plugin-react@#.#.# eslint-plugin-jsx-a11y@#.#.#

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

The cli will produce and run a command like:

npm install --save-dev @auxilin/eslint-config eslint@#.#.# babel-eslint@#.#.# eslint-plugin-import@#.#.# eslint-plugin-react@#.#.# eslint-plugin-jsx-a11y@#.#.#

Quick example

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

module.exports = {
  "extends": "@auxilin/eslint-config"
}

This configuration of the ESLint can be changed. See how to configure ESLint on the official site.

Change Log

This project adheres to Semantic Versioning. Every release is documented on the Github Releases page.

License

ESlint-config is released under the MIT License.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contributors

Thanks goes to these wonderful people (emoji key):

Evgeny Zhivitsa 💻 📖 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!