Installation

1yarn add -D @bshdo/eslint-config @rushstack/eslint-patch eslint prettier

Create .eslintrc.js file with following code:

1// This is a workaround for: https://github.com/eslint/eslint/issues/3458
2require('@rushstack/eslint-patch/modern-module-resolution');
3
4module.exports = {
5  // use @bshdo/eslint-config/react for React/NextJs projects
6  extends: ['@bshdo/eslint-config'],
7};

Create a file called .prettierrc.js

1module.exports = require('@bshdo/eslint-config/prettier-config');

Add the following script to your package.json

"lint": "eslint '*/**/*.{js,ts,tsx}'"
"lint:fix": "eslint '*/**/*.{js,ts,tsx}' --fix"

VSCode autoformat

Add the following snippet to your settings.json to autoformat your code on every save

1{
2  "editor.codeActionsOnSave": {
3    "source.fixAll.eslint": true
4  }
5}

Note

The package currently makes use of a patched version of eslint (@rushstack/eslint-patch), which eliminates the need of installing all used eslint plugins in the target repository as well. Therefore it's important to load the patched version using the .eslintrcjs snippet from above