ESLint

ESLint as a code quality tool is a tool that checks your code for errors and helps you to fix them and enforces a coding style.

Setup

1. Install the ESLint extension for your code editor.
2. Set your editor's default formatter to ESLint.

:::tip For VSCode users, you can set the formatter to ESLint in the settings.json. :::

3. Install the dependencies.
   bashCopy

   npm install
   npm install --prefix server
   npm install --prefix frontend
   

4. Run the linter.
   bashCopy

   npm run --prefix server lint
   npm run --prefix frontend lint
   

5. Fix the ESlint errors and warnings.
   bashCopy

   npm run --prefix server format
   npm run --prefix frontend format
   

Requirements

1. Node version 18.18.2
2. npm version 9.8.1

:::tip It is recommended to check the VSCode Setting.json(Press ctrl/cmnd + P and search >Settings (JSON)) file to ensure there are no overrides to the eslint config rules. Comment the following rules for eslint: eslint.options: {...}. :::