knip-configurator

Утилита для автоматической настройки knip в проектах Next.js с pre-commit хуками.

Описание

CLI-инструмент, который автоматически настраивает knip (поиск неиспользуемых файлов, зависимостей и экспортов) в Next.js проектах. Поддерживает два режима работы:

• Базовый режим — устанавливает только knip и создает конфигурацию
• Режим с pre-commit хуками — дополнительно настраивает Husky и lint-staged для автоматической проверки при коммите

Принцип работы

Базовый режим (без флага)

1. Проверяет наличие package.json и Git репозитория
2. Определяет менеджер пакетов (npm/yarn/pnpm)
3. Устанавливает зависимость knip
4. Создает knip.json с универсальной конфигурацией для Next.js
5. Обновляет package.json: добавляет скрипты для запуска knip
6. Обновляет .gitignore для игнорирования отчетов knip

Режим с pre-commit хуками (с флагом --pre-commit)

1. Проверяет наличие package.json и Git репозитория
2. Определяет менеджер пакетов (npm/yarn/pnpm)
3. Устанавливает зависимости: knip, husky, lint-staged
4. Инициализирует Husky (если еще не инициализирован)
5. Создает knip.json с универсальной конфигурацией для Next.js
6. Обновляет package.json: добавляет скрипты и настраивает lint-staged
7. Создает или обновляет .husky/pre-commit хук (добавляет lint-staged, не перезаписывая существующие хуки)
8. Обновляет .gitignore для игнорирования отчетов knip

Важно: Если в проекте обнаружен внешний конфигурационный файл lint-staged (например, lint-staged.config.js), скрипт не будет его изменять. Вам нужно будет вручную добавить паттерн '*.{js,jsx,ts,tsx}': 'knip --reporter compact' в ваш конфигурационный файл.

Установка и использование

Вариант 1: Через npx (без установки)

Базовый режим (только knip):

npx knip-configurator

Режим с pre-commit хуками:

npx knip-configurator --pre-commit

Вариант 2: Как dev-зависимость

# Установка
npm install --save-dev knip-configurator
# или
yarn add -D knip-configurator
pnpm add -D knip-configurator

# Использование (базовый режим)
npx knip-configurator

# Использование (с pre-commit хуками)
npx knip-configurator --pre-commit

Вариант 3: Глобальная установка

# Установка
npm install -g knip-configurator
# или
yarn global add knip-configurator
pnpm add -g knip-configurator

# Использование (базовый режим)
knip-configurator

# Использование (с pre-commit хуками)
knip-configurator --pre-commit

Используемые библиотеки

• knip — инструмент для поиска неиспользуемых файлов, зависимостей и экспортов
• husky — инструмент для настройки Git хуков
• lint-staged — запуск линтеров только для измененных файлов

Требования

• Node.js >= 18.18.0
• npm, yarn или pnpm
• Проект Next.js

История изменений

См. CHANGELOG.md для списка изменений.