create-nadvan-app 1.0.1 → 1.0.2

package/README.md

@@ -121,6 +121,63 @@ src/
 
 ---
 
+## Работа с FSD структурой (fsd-generator)
+
+После создания проекта используй **`fsd-generator`** для быстрого scaffolding слоёв и слайсов.
+
+```bash
+# Установка (один раз)
+npm install -g fsd-generator
+
+# Инициализировать FSD (если не запускали)
+fsd init
+```
+
+### Создание компонентов
+
+```bash
+# Простой виджет
+fsd -t widget -n header
+
+# Несколько виджетов сразу
+fsd -t widget -n header,footer,sidebar
+
+# Фича со структурой ui + model
+fsd slice -t feature -n user-auth
+
+# Сущность с ui + model + api + lib
+fsd slice -t entity -n product --full
+
+# Несколько компонентов в одной папке
+fsd -t widget -n form -c Button,Input,Select
+
+# Плоская структура (без папки ui)
+fsd -t shared -n icons --flat -c CloseIcon,ArrowIcon
+```
+
+### Что создаётся
+
+| Команда | Структура |
+|---|---|
+| `fsd -t widget -n header` | `widgets/header/ui/Header.tsx` + `index.ts` |
+| `fsd slice -t feature -n auth` | `features/auth/ui/` + `model/types.ts` + `index.ts` |
+| `fsd slice -t entity -n user --full` | `entities/user/ui/` + `model/` + `api/` + `lib/` |
+
+### Управление структурой
+
+```bash
+fsd list              # Показать весь проект
+fsd list widget       # Показать компоненты слоя widget
+fsd check             # Проверить соответствие FSD
+fsd info              # Информация о проекте
+fsd remove -t widget -n header          # Удалить компонент
+fsd rename -t widget -n header header-v2 # Переименовать
+```
+
+> Файлы не перезаписываются, экспорты добавляются в `index.ts` автоматически.
+
+---
+
 ## Автоматические проверки
 
 При каждом `git commit` автоматически запускаются:
@@ -137,14 +194,45 @@ src/
 <тип>(<область>): <описание>
 ```
 
-Примеры:
+**Типы:**
+
+| Тип | Когда использовать |
+|---|---|
+| `feat` | Новая функциональность |
+| `fix` | Исправление бага |
+| `style` | Только стили/вёрстка, без логики |
+| `refactor` | Рефакторинг без изменения поведения |
+| `perf` | Оптимизация производительности |
+| `test` | Тесты |
+| `docs` | Документация, README, Storybook |
+| `chore` | Зависимости, конфиги, инфраструктура |
+| `ci` | CI/CD пайплайны |
+| `revert` | Откат коммита |
+| `wip` | Work in progress (только в feature-ветках) |
+
+**Область (scope)** — FSD-слой или техническая зона: `app`, `pages`, `widgets`, `features`, `entities`, `shared`, `ui`, `api`, `styles`, `deps`, `config`, `ci`.
+
+Можно уточнять до конкретного модуля: `features/auth`, `widgets/header`.
+
+**Правила описания:**
+- Инфинитив: «добавить», «исправить», «обновить» — не «добавил»
+- Без точки в конце
+- Конкретно: «исправить отступ в Button» лучше «исправить баг»
+
+**Примеры:**
 ```
 feat(features): добавить авторизацию через OAuth
 fix(shared): исправить отступы в компоненте Button
 style(widgets): обновить вёрстку Header под мобайл
-chore(deps): обновить @nadvan/ui до 2.1.0
+refactor(entities): вынести логику фильтрации в хук
+perf(widgets): добавить React.memo для ProductCard
+chore(deps): обновить nadvan-ui-kit до 1.0.3
+docs: добавить раздел про fsd-generator в README
+wip(features): начать реализацию корзины
 ```
 
+Подробная документация — в [frontend-standard.md, раздел 5.4](../frontend-standard.md).
+
 ---
 
 ## Скрипты

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nadvan-app",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Официальный scaffolder для frontend-проектов Nadvan",
   "type": "module",
   "bin": {

package/src/templates/base/commitlint.config.js

@@ -52,11 +52,30 @@ export default {
 };
 
 /*
+  Формат: <тип>(<область>): <описание>
+
+  Правила описания:
+  - Инфинитив: «добавить», «исправить» — не «добавил», «исправил»
+  - Без точки в конце
+  - Конкретно и понятно
+
   Примеры правильных коммитов:
   feat(features): добавить авторизацию через OAuth
+  feat(widgets): добавить выпадающее меню в Header
   fix(shared): исправить padding в компоненте Button
+  fix(features): устранить зависание формы при быстром вводе
   style(widgets): обновить вёрстку Header под мобайл
   refactor(entities): переименовать поля в модели User
-  chore(deps): обновить nadvan-ui-kit до 1.1.0
+  refactor(features): вынести валидацию формы в отдельный хук
+  perf(widgets): добавить React.memo для ProductCard
+  test(features): покрыть тестами хук useAuth
   docs: добавить описание компонентов в Storybook
+  chore(deps): обновить nadvan-ui-kit до 1.0.3
+  chore(config): добавить алиас @icons в tsconfig
+  ci: добавить GitHub Actions workflow для деплоя
+  wip(features): начать реализацию корзины  ← только в feature-ветках!
+
+  Область (scope) — FSD-слой или техническая зона.
+  Можно уточнять: features/auth, widgets/header.
+  Подробнее: https://github.com/your-org/nadvan-specifications
 */