prettier-plugin-import-sections weekly downloads statistics

prettier-plugin-import-sections

Prettier-плагин для автоматической сортировки импортов по секциям.

Плагин переиспользуемый — не содержит проект-специфичных хардкодов. Все настройки проекта задаются через .prettierrc или внешний конфиг-файл.

Быстрый старт

1. Установка

2. Подключение в .prettierrc

2. Использование

Секции импортов

Импорты сортируются в следующем порядке:

Пример

Конфигурация (importSectionsConfig)

Все проект-специфичные настройки задаются через importSectionsConfig в .prettierrc:

| Ключ | Тип | Описание |

| sectionOrder | string[] | Порядок секций (переупорядочивает дефолт) | | sectionAliases | object | Переименование секций ({"Api": "Backend"}) | | extraSections | object | Дополнительные секции с path-based правилами | | defaultSection | string | Дефолтная секция если ничего не совпало | | componentHocs | string[] | HOC-обёртки компонентов (typedMemo, styled, observer...) | | constantPrefixes | string[] | Префиксы констант (INITIAL_, DEFAULT_, TIME_...) | | constantSuffixes | string[] | Суффиксы констант (_ROLES, _COLUMNS, _CONSTANTS...) | | componentSuffixes | string[] | Суффиксы компонентов (Page, Modal, Table, Form...) | | helperFilenames | string[] | Имена файлов-утилит (utils, helpers, config...) | | knownTypeNames | string[] | Дополнительные имена типов (merges с автодетектом) | | projectAliases | object | Алиасы проекта (перезаписывает автодетект из tsconfig) | | apiPaths | string[] | Пути для секции Api | | helperPaths | string[] | Пути для секции Helpers | | componentPaths | string[] | Пути для секции Components | | constantsPaths | string[] | Пути для секции Constants | | uiLibraries | string[] | npm UI-библиотеки | | helperLibraries | string[] | npm утилиты |

Автодетект

Плагин автоматически определяет:

• PROJECT_ALIASES — из tsconfig.json compilerOptions.paths + сканирование src/ • API_PATHS, HELPER_PATHS, COMPONENT_PATHS, CONSTANTS_PATHS — по структуре src/ директорий • UI_LIBRARIES, HELPER_LIBRARIES — из package.json dependencies (react-* → UI, остальные → helpers) • KNOWN_TYPE_NAMES — из @types/react, react-query, react-hook-form

Если значение задано в importSectionsConfig, оно merges с автодетектом (для knownTypeNames) или перезаписывает его (для остальных).

Конфигурируемые секции

Переименование секций

Результат:

Порядок секций

Дополнительные секции

Можно добавить свои секции с path-based правилами:

Импорты из указанных путей попадут в новую секцию.

Дефолтная секция

Импорты, которые не совпали ни с одним правилом, попадут в указанную секцию.

Внешний конфиг-файл

Можно вынести конфиг в отдельный файл:

Определение секции

Скрипт определяет секцию импорта по правилам (приоритет сверху вниз):

1. Явные указатели

| Паттерн | Секция |

| import type { ... } | Types | | import 'foo.css' / import 'foo.scss' | Styles | | import cn from 'classnames/bind' | Styles | | const cx = cn.bind(styles) | Styles |

2. Пути файлов

| Путь | Секция |

| api/points/*, api/instances | Api | | shared/contexts/* (Provider/Context) | Components | | shared/contexts/* (use*) | Hooks | | shared/helpers/* | Helpers | | shared/constants/* | Constants | | uikit/*, features/*, pages/* | Components | | */libs/* (внутри uikit/features/pages) | Helpers | | Путь заканчивается на /types | Types |

3. Имена импортов

| Паттерн | Секция |

| Имя начинается с use* (кроме api/points) | Hooks | | Все имена в KNOWN_TYPE_NAMES | Types | | IXxx / TXxx (кроме компонентов/констант) | Types | | ALL_CAPS, суффиксы/префиксы из конфига | Constants |

4. npm-пакеты

| Пакет | Секция |

| react (use*) | Hooks | | react (компоненты) | Components | | react-router-dom (use*) | Hooks | | react-hook-form | Hooks | | react-query (use*) | Hooks | | UI-библиотеки из конфига | Components | | Helper-библиотеки из конфига | Helpers |

5. Content-based проверка

Если ни одно правило не подошло, скрипт читает файл-источник:

• Компоненты: export function Name(): JSX.Element, export const Name = (...) => , export const Name = forwardRef(...), export const Name = memo(...), export const Name = (...), export const Name: FC, export default Name • Типы: export interface Name, export type Name (без экспорта как значение)

Исправление import type

Если import type { Name } импортирует компонент или значение (enum/const):

1. Убирает type из импорта 2. Классифицирует по обычным правилам

Структура модулей

Зависимости модулей

Исключения

• .d.ts файлы — пропускаются • .test. / .spec. файлы — пропускаются • declare module блоки — импорты внутри не трогаются • Только .ts и .tsx — другие расширения не обрабатываются • Markdown — содержит markdown-синтаксис → пропускается

Добавление в новый проект

1. Установите пакет: 2. Добавьте в .prettierrc: 3. Плагин автоматически определит алиасы из tsconfig.json и структуру src/

Description from the npm listing.