docs/nextjs-style-guide

Fork 0

Files

S.Gromov b104ca6581

CI/CD Pipeline / docker (push) Successful in 45s

Details

CI/CD Pipeline / deploy (push) Successful in 7s

Details

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

3.8 KiB

Raw Permalink Blame History

NextJS Style Guide

Правила и стандарты разработки на NextJS и TypeScript: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы.

Для ассистентов

Полная документация в одном MD файле: https://gromlab.ru/docs/nextjs-style-guide/raw/branch/main/generated/ru/RULES.md

Структура документации

Workflow

Что делать и в каком порядке — пошаговые инструкции.

Раздел	Отвечает на вопрос
Начало работы	Что нужно знать перед началом разработки?
Создание проекта	Как начать новый проект?
Генерация кода	Какие модули должны генерироваться из шаблонов?
Добавление страницы	Как добавить новую страницу в проект?
Добавление UI-модуля	Как создать компонент, фичу, виджет, сущность или layout?
Стилизация	Как стилизовать компоненты в проекте?
Получение данных	Как получать данные с сервера?
Управление состоянием	Как работать с состоянием?
Локализация	Как добавлять переводы и подключать локализацию?

Базовые правила

Каким должен быть код — стандарты, не привязанные к конкретной технологии.

Раздел	Отвечает на вопрос
Технологии и библиотеки	Какой стек используем?
Архитектура	Как устроены слои FSD, зависимости, публичный API?
Стиль кода	Как оформлять код: отступы, кавычки, импорты, early return?
Именование	Как называть файлы, переменные, компоненты, хуки?
Документирование	Как писать JSDoc: что документировать, а что нет?
Типизация	Как типизировать: type vs interface, any/unknown, FC?

Прикладные разделы

Как это настроить и использовать — конфигурация, структура и примеры кода для конкретных областей.

Раздел	Отвечает на вопрос
Настройка VS Code	Как настроить редактор для проекта?
Структура проекта	Как организованы папки и файлы по FSD?
Компоненты	Как устроен компонент: файлы, пропсы, clsx, FC?
Page-level компоненты	Как описывать layout, page, loading, error, not-found?
Шаблоны и генерация кода	Как работают шаблоны, синтаксис и инструменты генерации?
Стили	Как писать CSS: PostCSS Modules, вложенность, медиа, токены?
Изображения	(не заполнен)
SVG-спрайты	(не заполнен)
Видео	(не заполнен)
API	(не заполнен)
Stores	(не заполнен)
Хуки	(не заполнен)
Шрифты	(не заполнен)
Локализация	(не заполнен)

3.8 KiB Raw Permalink Blame History Unescape Escape