Простая настройка TypeScript с помощью ESLint и Prettier: Руководство разработчика

Настройка надежной среды разработки имеет решающее значение для любого проекта TypeScript. В этой статье мы рассмотрим плавную интеграцию TypeScript, ESLint и Prettier для повышения качества и читаемости вашего кода. Мы углубимся в различные методы и предоставим примеры кода, чтобы вы могли легко следовать им.

Метод 1. Ручная настройка

Процесс ручной настройки позволяет вам полностью контролировать файлы конфигурации. Начните с установки необходимых пакетов:

npm install --save-dev typescript eslint prettier

Далее создайте файл конфигурации TypeScript:

npx tsc --init

Эта команда создает файл tsconfig.json, который вы можете настроить в соответствии с потребностями вашего проекта.

Чтобы инициализировать ESLint, выполните:

npx eslint --init

Эта команда поможет вам ответить на ряд вопросов, чтобы создать файл .eslintrc.json. Вы можете выбрать одно из популярных руководств по стилю или настроить собственное.

Наконец, создайте файл .prettierrcдля Prettier:

{
  "printWidth": 80,
  "tabWidth": 2,
  "singleQuote": true,
  "trailingComma": "all",
  "semi": true
}

Метод 2: использование приложения Create React

Если вы работаете над проектом React, функция Create React App (CRA) делает процесс установки еще более простым. Просто создайте новый проект с помощью CRA:

npx create-react-app my-app --template typescript

CRA автоматически настраивает для вас TypeScript, ESLint и Prettier, включая их соответствующие конфигурации.

Метод 3: использование плагинов ESLint и Prettier

Чтобы еще больше упростить процесс установки, вы можете использовать плагины ESLint и Prettier, которые предоставляют предварительно настроенные параметры. Установите следующие пакеты:

npm install --save-dev eslint-config-prettier eslint-plugin-prettier

Далее создайте файл .eslintrc.jsonсо следующим содержимым:

{
  "extends": ["prettier"],
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error"
  }
}

Эта конфигурация гарантирует гармоничную совместную работу ESLint и Prettier.

Метод 4: настройка без настройки с помощью TypeScript ESLint

Проект TypeScript ESLint упрощает процесс установки, предоставляя подход без необходимости настройки. Установите необходимые пакеты:

npm install --save-dev typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

Создайте файл .eslintrc.jsonсо следующим содержимым:

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended",
    "prettier/@typescript-eslint",
    "plugin:prettier/recommended"
  ]
}

Этот файл конфигурации сочетает в себе рекомендуемые правила ESLint и TypeScript с форматированием Prettier.

В этой статье мы рассмотрели несколько способов настройки TypeScript с помощью ESLint и Prettier. Предпочитаете ли вы ручную настройку, использование Create React App, использование плагинов ESLint и Prettier или использование подхода без настройки с помощью TypeScript ESLint, у вас есть варианты, соответствующие требованиям вашего проекта. Внедрив эти инструменты, вы повысите качество своего кода и обеспечите единообразие всей базы кода TypeScript.