S.Gromov
8231356d8d
- перенесён раздел создания проекта в прикладные разделы - переработаны разделы REST-клиента и получения данных - удалена устаревшая категория работы с данными - обновлён стандартный конфиг Biome - добавлены правила для обязательного API baseUrl без fallback - обновлены сайдбар, карта документации, README и ссылки
77 lines
4.9 KiB
Markdown
77 lines
4.9 KiB
Markdown
# NextJS Style Guide
|
||
|
||
Стандарты разработки фронтенд-приложений на Next.js и TypeScript.
|
||
|
||
Сайт: https://nextjs-style-guide.gromlab.ru
|
||
|
||
## Использование
|
||
|
||
**Для AI-агентов:**
|
||
|
||
- [llms.txt](https://nextjs-style-guide.gromlab.ru/llms.txt) — Карта разделов, оглавление со ссылками на разделы.
|
||
- [llms-full.txt](https://nextjs-style-guide.gromlab.ru/llms-full.txt) — Вся документация одним файлом.
|
||
|
||
**Для проекта:**
|
||
|
||
- [nextjs-style-guide.zip](https://nextjs-style-guide.gromlab.ru/nextjs-style-guide.zip) — Набор Markdown-файлов для распаковки в `./ai/nextjs-style-guide/` или другую папку проекта.
|
||
|
||
## Структура документации
|
||
|
||
### Подсказки
|
||
|
||
[Подсказки](docs/docs/workflow.md) — короткие ответы на типовые вопросы и решения для спорных ситуаций.
|
||
|
||
### Базовые правила
|
||
|
||
**Каким должен быть код** — стандарты, не привязанные к конкретной технологии.
|
||
|
||
| Раздел | Отвечает на вопрос |
|
||
|--------|-------------------|
|
||
| Технологии и библиотеки | Какой стек используем? |
|
||
| Именование | Как называть файлы, переменные, компоненты, хуки? |
|
||
| SLM Design | Что такое SLM и зачем она нужна? |
|
||
| Архитектура: Слои | Какие слои есть и как между ними устроены зависимости? |
|
||
| Архитектура: Модули | Что такое модуль и как он устроен? |
|
||
| Архитектура: Сегменты | Какие сегменты есть внутри модуля? |
|
||
| Стиль кода | Как оформлять код: отступы, кавычки, импорты, early return? |
|
||
| Документирование | Как писать JSDoc: что документировать, а что нет? |
|
||
| Типизация | Как типизировать: type vs interface, any/unknown? |
|
||
|
||
### Настройка
|
||
|
||
**Как сконфигурировать проект** — пошаговая настройка инструментов и инфраструктуры.
|
||
|
||
| Раздел | Отвечает на вопрос |
|
||
|--------|-------------------|
|
||
| Создание проекта из шаблона | Как начать проект из готового шаблона? |
|
||
| Создание проекта вручную | Как поднять проект с нуля без шаблона? |
|
||
| Чистая установка Next.js | Как поставить голый Next.js под дальнейшую сборку? |
|
||
| Алиасы импортов | Как настроить алиасы импортов? |
|
||
| Biome | Как настроить линтер и форматтер? |
|
||
| PostCSS | Какие плагины PostCSS нужны и как их настроить? |
|
||
| Стили | Как подключить базовые стили и токены? |
|
||
| SVG-спрайты | Как подключить генерацию SVG-спрайтов? |
|
||
| Шаблоны генерации | Как подключить шаблоны для кодогенерации? |
|
||
| VS Code | Как настроить редактор для проекта? |
|
||
|
||
### Использование
|
||
|
||
**Как это устроено и как этим пользоваться** — структура, примеры и правила для конкретных областей.
|
||
|
||
| Раздел | Отвечает на вопрос |
|
||
|--------|-------------------|
|
||
| Структура проекта | Как организованы папки и файлы по SLM? |
|
||
| Компоненты | Как устроен компонент: файлы, пропсы, clsx? |
|
||
| Файлы роутинга | Как описывать layout, page, loading, error, not-found? |
|
||
| REST-клиент | Как настроить клиент внешнего REST API? |
|
||
| Получение данных | Как выбрать способ получения данных под рендер страницы? |
|
||
| Шаблоны и генерация кода | Как работают шаблоны, синтаксис и инструменты генерации? |
|
||
| Стили | Как писать CSS: вложенность, медиа, токены? |
|
||
| SVG-спрайты | Как использовать SVG-спрайты в коде? |
|
||
| Изображения | _(не заполнен)_ |
|
||
| Видео | _(не заполнен)_ |
|
||
| Stores | _(не заполнен)_ |
|
||
| Хуки | _(не заполнен)_ |
|
||
| Шрифты | _(не заполнен)_ |
|
||
| Локализация | _(не заполнен)_ |
|