@flowio/eslint-config-flowio

A package that provides Flow Commerce's .eslintrc as an extensible shared config

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Mar 24, 2021Apr 28, 2016Minified + gzip package size for @flowio/eslint-config-flowio in KB

Readme

NPM Version Downloads Greenkeeper badge

eslint-config-flowio

A package that provides our .eslintrc as an extensible shared config.

Installation

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

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

Linux / OSX users can simply run:

npm info "@flowio/eslint-config-flowio@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "@flowio/eslint-config-flowio@latest"

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

Usage

Our default export contains all of our ESLint rules, including ECMAScript 6+ and React, which are based on eslint-config-airbnb with some rules modified.

Extend the config in a .eslintrc file:

{
  "extends": "@flowio/flowio"
}

We also export a base configuration which excludes React rules. You can extend your .eslintrc in the following way to include it:

{
  "extends": "@flowio/flowio/base"
}

Acknowledgement

A special thanks to:

  • Airbnb for sharing their extensive JavaScript style guide and ESLint rules.

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.