README.md

@westrem/eslint-config

Shareable config for ESLint

How to use

Install

yarn add --dev @westrem/eslint-config eslint @typescript-eslint/eslint-plugin eslint-plugin-compat eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-security typescript

Usage

// eslintrc.json
{
  "extends": [
    ...,
    "@westrem/eslint-config"
  ]
}

// package.json
{
  "scripts": {
    ...,
    "lint:eslint": "./node_modules/.bin/eslint src --ignore-path .gitignore --ext .ts,.tsx --cache --cache-location .cache/eslint/ --max-warnings 0",
    "fix:eslint": "eslint src/** --ignore-path .gitignore --ext .ts,.tsx --cache --cache-location .cache/eslint/ --fix",
  }
}

---

Sources

• How to write shareable ESLint configs
• Config files
• ESLint rules
• Typescript ESLint rules
• React plugin