mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-23 06:27:57 +00:00
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
|
---
|
||
|
|
id: eslint
|
||
|
|
title: EsLint
|
||
|
|
---
|
||
|
|
|
||
|
|
# 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](https://eslint.org/docs/latest/user-guide/integrations) 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**](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson).
|
||
|
|
:::
|
||
|
|
|
||
|
|
3. Install the dependencies.
|
||
|
|
```bash
|
||
|
|
npm install
|
||
|
|
npm install --prefix server
|
||
|
|
npm install --prefix frontend
|
||
|
|
```
|
||
|
|
4. Run the linter.
|
||
|
|
```bash
|
||
|
|
npm run --prefix server lint
|
||
|
|
npm run --prefix frontend lint
|
||
|
|
```
|
||
|
|
5. Fix the ESlint errors and warnings.
|
||
|
|
```bash
|
||
|
|
npm run --prefix server format
|
||
|
|
npm run --prefix frontend format
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
1. **Node version 18.3.0**
|
||
|
|
2. **npm version 8.11.0**
|
||
|
|
|
||
|
|
:::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: {...}**.
|
||
|
|
:::
|