Files
methodologies/eslint/README.md
Максим Бучнев 26a3b73da6 docs(prettier): add eslint docs
add README.md
add config and ignore files
2025-05-31 15:00:46 +03:00

42 lines
2.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 🛠️ ESLint
**ESLint** — это инструмент для анализа и автоматической проверки JavaScript/TypeScript-кода. Он помогает находить и устранять ошибки, несоответствия стилю и потенциальные баги **до запуска программы**.
**В данном примере ESLint используется в связке с prettier.**
---
## ⚙️ Конфигурация
`.eslintignore` - игнорирование форматирования
`.eslintrc.json` - файл конфигурации
| Правило | Описание |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `@typescript-eslint/no-explicit-any: "off"` | Разрешает использовать `any` (не запрещает явно указанный тип `any`) |
| `prettier/prettier: "error"` | Ошибки форматирования от Prettier будут отображаться как ESLint-ошибки |
| `@typescript-eslint/no-unused-vars: "error"` | Показывает ошибку, если переменная объявлена, но не используется |
| `@typescript-eslint/consistent-type-definitions: ["error", "type"]` | Требует использовать `type`, а не `interface` для описания типов объектов |
---
## 📦 Установка зависимостей
Установи необходимые пакеты:
```bash
npm install --save-dev \
eslint \
@typescript-eslint/parser \
@typescript-eslint/eslint-plugin \
prettier \
eslint-plugin-prettier \
eslint-config-prettier
```
---
## 🚀 Использование
Проверить весь проект:
```bash
npx eslint . --ext .ts
```
Автоматически исправить:
```bash
npx eslint . --ext .ts --fix
```
Плагин ESLint для `VSCode`: [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)