ESLint Plugin Perfectionist

VersionGitHub starsDownloads per weekLicense

Эстетическая и структурная целостность кода — важная вещь при разработке. Тщательно организованная кодовая база повышает её читабельность и увеличивает эффективность совместной работы. ESLint Plugin Perfectionist — это инструмент для решения таких задач.

Этот плагин ESLint предназначен для сортировки различных данных в коде: импортов, объектов, типов и интерфейсов Typescript, свойств JSX, классов и многого другого.

Кроме того, плагин обеспечивает безопасность и целостность в процессе модификации кода. Он разработан таким образом, чтобы такие вещи как комментарии, аннотации JSDoc и спред операторы в объектах учитывались, чтобы суть и функциональность кода остались нетронутыми.

Как начать его использовать?

Прежде всего, необходимо установить на проект сам ESLint:

Bash
npm install --save-dev eslint

Затем установите плагин:

Bash
npm install --save-dev eslint-plugin-perfectionist

Самый простой способ начать использовать плагин — импортировать один из трех готовых конфигов в ваш конфиг .eslintrc. Например, конфиг с сортировкой по алфавиту:

JSON
{
  "extends": ["plugin:perfectionist/recommended-alphabetical"]
}

После установки линтер покажет множество ошибок в коде. Однако не пугайтесь, потому что все правила плагина можно исправить автоматически. Это значит, что вам не нужно ничего исправлять вручную. Просто запустите ESLint с флагом --fix, и плагин исправит всё сам