@grapes-agency/eslint-config

Grapes ESLint Config

Best practice eslint config.

Installation

Install using npm as dev dependency:

npm i -D @grapes-agency/eslint-config

Usage

The eslint rules are splitted to fit most use cases

Basic (without React and Prettier)

package.json:

{
  "eslintConfig": {
    "extends": "@grapes-agency/eslint-config"
  }
}

with Prettier

this package comes with a prettier configuration. Simply add the following line to your package.json:

{
  "prettier": "@grapes-agency/eslint-config/prettier"
}

If you want eslint to lint prettier rules, also add

{
  "eslintConfig": {
    "extends": [
        "@grapes-agency/eslint-config",
        "@grapes-agency/eslint-config/rules/prettier"
    ]
  }
}

Note: Keep in mind that prettier linting can make a significant performance impact. If you expirience slow linting, remove the eslint rule and refer to vscode.md.

with React

package.json:

{
  "eslintConfig": {
    "extends": [
      "@grapes-agency/eslint-config",
      "@grapes-agency/eslint-config/rules/react",
    ]
  }

Lint Script (CI)

package.json:

{
  "scripts": {
    "lint": "eslint --max-warnings 0 --ext js,jsx,ts,tsx --cache src"
  }

--max-warnings 0 ensures that CI pipelines will fail on any warning

git

Add .eslintcache to your .gitignore