@foray1010/eslint-config

@foray1010/eslint-config

It aims at providing a general eslint config for:

1. assisting developer to obtain better code quality

2. no opinion on coding styles, leave it to @foray1010/prettier-config

Versioning

X.Y.Z

X for requiring newer eslint or node (breaking changes)

Y for stricter rules

Z for looser rules

Installation

1. yarn add -DE eslint prettier @foray1010/eslint-config

2. Create an .eslintrc.yml in the project root

   # for general purpose, support TypeScript
   extends:
     - '@foray1010/eslint-config'
   
   # for frontend React project, support TypeScript
   extends:
     - '@foray1010/eslint-config/react'
   

3. Use default eslintignore via npm script

   {
     "scripts": {
       "eslint": "eslint --ext=cjs,cts,js,mjs,mts,ts,tsx --ignore-path=node_modules/@foray1010/eslint-config/eslintignore"
     }
   }
   

   then use npm run eslint or yarn eslint to replace eslint