@rgorai/eslint-config

Ron Gorai's Configuration for ESLint, Stylelint, and Prettier

Use my ESLint, Stylelint, and Prettier settings in your project and lint your codebase on demand with a simple CLI command.

Prerequisites

This configuration is designed to be used for TypeScript, React, SCSS, and Node.js, but could work for other configurations as well.

Demo

Please visit my NPM platform to view a demo of this package.

Steps to use:

1. yarn add -D @rgorai/eslint-config

Install the package as a dev dependency.

2. yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks prettier stylelint stylelint-config-standard stylelint-config-standard-scss stylelint-prettier typescript

Install peer dependencies.

3. Add the following to your package.json.

Feel free to add your own config options here as well. It is recommended to reload the window in VS Code after this step in order for the ESLint and Stylelint extensions (if you have them) to properly utilize the installed config files.

"eslintConfig": {
  "extends": "@rgorai/eslint-config/.eslintrc"
},
"prettier": "@rgorai/eslint-config/.prettierrc.js",
"stylelint": {
  "extends": "@rgorai/eslint-config/.stylelintrc"
},

// if you use lint-staged
"lint-staged": {
  "*": "yarn lint"
}

4. If you are using VS Code and the ESLint extension, it is recommended to add the following to your settings.json to disable highlighting for Prettier.

"eslint.rules.customizations": [
  {
    "rule": "prettier/prettier",
    "severity": "off"
  }
]

5. yarn lint

Lint all .tsx, .ts, .jsx, .js, .css, and .scss files in your NPM project at once.