docs/nextjs-style-guide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
v3
nextjs-style-guide/README_RU.md

62 lines
3.9 KiB
Markdown
Raw Permalink Normal View History

sync
2026-03-28 21:15:15 +03:00
# NextJS Style Guide
Правила и стандарты разработки на NextJS и TypeScript: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы.
## Для ассистентов
feat: генерация llms.txt, лендинг с выбором языка и ZIP-архивов - удалён concat-md.js: вместо единого RULES.md теперь llms.txt - добавлен generate-llms.ts: собирает llms.txt из sidebar config, копирует .md-файлы для отдачи LLM и упаковывает ZIP-архивы по локалям - добавлен корневой /llms.txt как роутер на /ru/llms.txt и /en/llms.txt - добавлен манифест /manifest.json со ссылками и версией сборки - добавлен лендинг docs/index.md (layout: false) с автоопределением языка, переключателями языка и темы - английская локаль временно заблокирована: карточки как заглушки, ссылка на /en/ в роутере без href - добавлены поля llmsBlockquote и llmsContext в локали для технодокументационного описания в llms.txt - разделены VitePress-локали: root (только лендинг), ru (/ru/), en (/en/) - добавлен srcExclude: ['public/**'] чтобы VitePress не рендерил сгенерированные .md как страницы - добавлен Vite-плагин для отдачи .txt и .md с charset=utf-8 - добавлена секция в Caddyfile для текстовых файлов - BUILD_VERSION пробрасывается из Gitea CI через docker --build-arg и подставляется в лендинг через Vite define - Dockerfile: установка zip, npm run llms перед npm run build - обновлены внутренние ссылки в docs/ru/**/*.md на префикс /ru/ - обновлены AGENTS.md и CONTRIBUTING.md под новый процесс - README/README_RU генерируются из docs/{lang}/index.md, остаются в репо
2026-04-25 18:06:27 +03:00
Карта документации со ссылками на все разделы (формат [llmstxt.org](https://llmstxt.org)):
https://gromlab.ru/docs/nextjs-style-guide/raw/branch/main/generated/ru/llms.txt
sync
2026-03-28 21:15:15 +03:00
## Структура документации
### Workflow
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
**Что делать и в каком порядке** — пошаговые инструкции.
sync
2026-03-28 21:15:15 +03:00
| Раздел | Отвечает на вопрос |
|--------|-------------------|
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
| Начало работы | Что нужно знать перед началом разработки? |
| Создание проекта | Как начать новый проект? |
| Генерация кода | Какие модули должны генерироваться из шаблонов? |
| Добавление страницы | Как добавить новую страницу в проект? |
docs: обновить разделы на архитектуру SLM Design - заменены все упоминания FSD на SLM Design в 10 файлах документации - обновлены слои features/ и entities/ на business/, infrastructure/, ui/ - обновлены таблицы генерации кода и CLI-примеры - обновлены примеры путей и деревья файлов (naming, project-structure) - исправлен YAML frontmatter в architecture.md (двоеточие без кавычек) - перегенерированы RULES.md и README
2026-04-20 10:40:52 +03:00
| Добавление UI-модуля | Как создать компонент, бизнес-модуль, виджет или layout? |
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
| Стилизация | Как стилизовать компоненты в проекте? |
| Получение данных | Как получать данные с сервера? |
| Управление состоянием | Как работать с состоянием? |
| Локализация | Как добавлять переводы и подключать локализацию? |
sync
2026-03-28 21:15:15 +03:00
### Базовые правила
**Каким должен быть код** — стандарты, не привязанные к конкретной технологии.
| Раздел | Отвечает на вопрос |
|--------|-------------------|
| Технологии и библиотеки | Какой стек используем? |
docs: обновить разделы на архитектуру SLM Design - заменены все упоминания FSD на SLM Design в 10 файлах документации - обновлены слои features/ и entities/ на business/, infrastructure/, ui/ - обновлены таблицы генерации кода и CLI-примеры - обновлены примеры путей и деревья файлов (naming, project-structure) - исправлен YAML frontmatter в architecture.md (двоеточие без кавычек) - перегенерированы RULES.md и README
2026-04-20 10:40:52 +03:00
| Архитектура | Как устроены слои SLM, зависимости, публичный API? |
sync
2026-03-28 21:15:15 +03:00
| Стиль кода | Как оформлять код: отступы, кавычки, импорты, early return? |
| Именование | Как называть файлы, переменные, компоненты, хуки? |
| Документирование | Как писать JSDoc: что документировать, а что нет? |
docs: отказаться от FC и interface в пропсах компонентов - переписана типизация: type вместо interface, убран FC - введена система типов: Params + RootAttrs + Props - добавлены обоснования: почему type, почему не FC, почему types/ - обновлены примеры в components, page-level, templates, documentation - убраны упоминания FC из таблиц index.md и README - перегенерированы RULES.md
2026-04-02 16:01:29 +03:00
| Типизация | Как типизировать: type vs interface, any/unknown? |
sync
2026-03-28 21:15:15 +03:00
### Прикладные разделы
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
**Как это настроить и использовать** — конфигурация, структура и примеры кода для конкретных областей.
sync
2026-03-28 21:15:15 +03:00
| Раздел | Отвечает на вопрос |
|--------|-------------------|
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
| Настройка VS Code | Как настроить редактор для проекта? |
docs: обновить разделы на архитектуру SLM Design - заменены все упоминания FSD на SLM Design в 10 файлах документации - обновлены слои features/ и entities/ на business/, infrastructure/, ui/ - обновлены таблицы генерации кода и CLI-примеры - обновлены примеры путей и деревья файлов (naming, project-structure) - исправлен YAML frontmatter в architecture.md (двоеточие без кавычек) - перегенерированы RULES.md и README
2026-04-20 10:40:52 +03:00
| Структура проекта | Как организованы папки и файлы по SLM? |
docs: отказаться от FC и interface в пропсах компонентов - переписана типизация: type вместо interface, убран FC - введена система типов: Params + RootAttrs + Props - добавлены обоснования: почему type, почему не FC, почему types/ - обновлены примеры в components, page-level, templates, documentation - убраны упоминания FC из таблиц index.md и README - перегенерированы RULES.md
2026-04-02 16:01:29 +03:00
| Компоненты | Как устроен компонент: файлы, пропсы, clsx? |
docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md - Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
| Page-level компоненты | Как описывать layout, page, loading, error, not-found? |
| Шаблоны и генерация кода | Как работают шаблоны, синтаксис и инструменты генерации? |
sync
2026-03-28 21:15:15 +03:00
| Стили | Как писать CSS: PostCSS Modules, вложенность, медиа, токены? |
| Изображения | _(не заполнен)_ |
| SVG-спрайты | _(не заполнен)_ |
| Видео | _(не заполнен)_ |
| API | _(не заполнен)_ |
| Stores | _(не заполнен)_ |
| Хуки | _(не заполнен)_ |
| Шрифты | _(не заполнен)_ |
| Локализация | _(не заполнен)_ |
Reference in New Issue Copy Permalink