eslint-config-bdc

business.com engineering team's eslint setup via reusable NPM package.

This eslint config extends this create react app one and adds prettier formatting to it with some additional rules we standardized around at business.com.

Install:

Step 1: Install the config and all of it's peer deps:

yarn add -D @bizdotcom/eslint-config-bdc eslint-config-react-app @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] prettier eslint-plugin-prettier

or

npm install -D @bizdotcom/eslint-config-bdc eslint-config-react-app @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] prettier eslint-plugin-prettier

Step 2: Create a file named .eslintrc.json with following contents in the root folder of your project:

{
  "extends": "@bizdotcom/eslint-config-bdc"
}

Use:

There are many ways you can run eslint. Here are a few suggestions:

1. Run eslint in your code editor of choice via eslint extension.

   • vscode eslint extension
     • (Recommended) eslint can do more than just lint, especially the way we have it configured. To automate some of the fixable errors/warnings and the prettier code formatting we recommend that you enable this setting to make eslint run as soon as you hit save. Add this to your settings.json:

       "editor.codeActionsOnSave": {
       	"source.fixAll.eslint": true
       }

   • sublime eslint extension
   • and many more can be found here

2. An NPM script in your package.json: "lint": "eslint --ext .js,.jsx ./src"

   • optionally you could also add a script which runs the fix command for you: "lint-fix": "yarn run lint --fix"
   • you could have these script run on commit-hooks with help from tools like husky or watch your files and run on save via build tools like webpack, gulp, or eslint-watch etc.

3. Like we said, these are just our suggested methods, we know there are others, you're welcome to use whichever method works best for you!