Files
nextjs-style-guide/parts/7-project-structure.md

119 lines
6.1 KiB
Markdown
Raw Normal View History

2026-01-30 02:02:32 +03:00
---
title: Структура проекта
---
# Структура проекта
Раздел описывает базовую структуру проекта и принципы организации модулей на уровне папок и файлов.
## Базовая структура проекта
2026-03-23 21:48:54 +03:00
Слои FSD не зависят от фреймворка. Различается только содержимое `app/` — в React SPA это конфигурация роутинга, в Next.js — системные файлы фреймворка (`layout.tsx`, `page.tsx`, route-сегменты).
2026-01-30 02:02:32 +03:00
```text
src/
2026-03-23 21:48:54 +03:00
├── app/ # Инициализация приложения (см. «Слой app/»)
├── screens/ # UI-компоненты страниц
│ └── profile/
2026-03-18 09:22:03 +03:00
│ ├── profile.screen.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
├── layouts/ # Общие шаблоны и каркасы страниц
2026-03-23 21:48:54 +03:00
│ └── main-layout/
2026-03-18 09:22:03 +03:00
│ ├── main-layout.layout.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
├── widgets/ # Крупные блоки интерфейса
2026-03-23 21:48:54 +03:00
│ └── header/
2026-03-18 09:22:03 +03:00
│ ├── header.widget.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
├── features/ # Пользовательские сценарии
2026-03-23 21:48:54 +03:00
│ └── auth-by-email/
2026-03-18 09:22:03 +03:00
│ ├── ui/
│ │ └── login-form.ui.tsx
│ ├── model/
│ │ └── auth-by-email.store.ts
│ ├── auth-by-email.feature.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
├── entities/ # Бизнес-сущности
2026-03-23 21:48:54 +03:00
│ └── user/
2026-03-18 09:22:03 +03:00
│ ├── model/
│ │ └── user.store.ts
│ ├── user.entity.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
└── shared/ # Общие ресурсы проекта
2026-03-18 09:22:03 +03:00
├── ui/ # Повторно используемые UI-элементы
│ └── icon/
│ ├── styles/
│ │ └── icon.module.css
│ ├── types/
│ │ └── icon.interface.ts
│ ├── icon.ui.tsx
│ └── index.ts
2026-01-30 02:02:32 +03:00
├── lib/ # Утилиты и хелперы
├── services/ # Общие сервисы и клиенты
2026-03-23 21:48:54 +03:00
├── config/ # Общие конфигурации и константы
2026-01-30 02:02:32 +03:00
└── assets/ # Ресурсы
2026-03-23 21:48:54 +03:00
├── images/
├── icons/
├── fonts/
└── video/
```
## Слой app/
Общее для обоих вариантов: провайдеры и глобальные стили. Различается только способ организации роутинга.
### React SPA
```text
src/app/
├── providers/ # Провайдеры и обёртки приложения
├── routing/ # Конфигурация маршрутов (React Router)
├── styles/ # Глобальные стили, CSS-переменные, custom media
└── index.ts # Entry point приложения
```
### Next.js (App Router)
```text
src/app/
├── providers/ # Провайдеры и обёртки приложения
├── styles/ # Глобальные стили, CSS-переменные, custom media
├── layout.tsx # Корневой layout (подключает providers, styles)
├── page.tsx # Главная страница
└── profile/
└── page.tsx # Рендерит ProfileScreen
```
В Next.js файлы `page.tsx` остаются тонкими — они только импортируют экран из `screens/` и рендерят его. Вся логика, зависимости и стили страницы живут в компоненте экрана, а не в `app/`.
```tsx
// src/app/profile/page.tsx
import { ProfileScreen } from '@/screens/profile';
export default function ProfilePage() {
return <ProfileScreen />;
}
2026-01-30 02:02:32 +03:00
```
**Плохо**
```text
// Плохо: слои смешаны, нет понятных границ и публичного API.
src/
├── components/
├── api/
├── styles/
└── user.ts
```
## Правила организации
2026-03-18 09:22:03 +03:00
- В слоях FSD (`features`, `entities`, `widgets`, `screens` и т.д.) `ui/` используется только для дочерних элементов, которые относятся к модулю и не экспортируются отдельно. Главные компоненты, которые составляют сам слой, держат собственные `*.feature.tsx`, `*.widget.tsx` и т. п., а `ui/` служит для вспомогательных мелких компонентов.
- В `shared/ui/` хранятся базовые UI-элементы/компоненты, которыми пользуются сразу несколько модулей; в этом случае они экспортируются наружу и не считаются «дочерними» для слоя.
- Если модуль строится вокруг «главного» компонента (`*.feature.tsx`, `*.screen.tsx`, `*.widget.tsx`), помещайте его в корень модуля и экспортируйте через `index.ts`. Проверяйте, что `ui/` не используется просто как «контейнер» слоя.
2026-01-30 02:02:32 +03:00
- Каждый слой и модуль хранится в собственной папке.
2026-03-18 09:22:03 +03:00
- Внутренние реализации разделяются на `ui/`, `model/`, `styles/`, `helpers/`, `lib/`, `api/`.
2026-01-30 02:02:32 +03:00
- Публичный API модуля объявляется в `index.ts`.
- Внутренние файлы не импортируются напрямую извне.
- Не смешивать ответственность разных слоёв в одном модуле.