brudi Toolbox ESLint config

brudi Toolbox `.

Base Eslint shareable config of brudi

Installation

Install the package with

yarn add -D @brudi-toolbox/eslint-config-brudi

or

npm install --save-dev @brudi-toolbox/eslint-config-brudi

eslint Setup

Now add the config to either the package.json:

{
  "eslintConfig": {
    "extends": ["@brudi-toolbox/brudi"]
  }
}

or to the .eslintrc or .eslintrc.js:

module.exports = {
  extends: ["@brudi-toolbox/brudi"],
};

ESLint and Prettier

• works together with prettier, thanks to eslint-plugin-prettier
• the ESLint rules are based on the great work of airbnb's eslint-config-airbnb
  • they also have a smaller more compact one: eslint-config-airbnb-base
• made for React environment but can be used on a eg. node-server environment as well)
• handles jest for tests as well
• env: Browser and Node environment
• globals: added some related jest variables
• parser: usage of babel (used babel-eslint parser)

Note: you can still overwrite the env, globals and parser in your local .eslintrc.js.

License

© brudi, 2019. Licensed under an Apache-2 license.