Compare commits
17 Commits
v0.1.0
...
5553ece16d
| Author | SHA1 | Date | |
|---|---|---|---|
| 5553ece16d | |||
| db34c20981 | |||
| 6ed8fd09cd | |||
| 9eef2cc472 | |||
| dfc56f918a | |||
| d3a152e177 | |||
| 515506e01e | |||
| 35763617b5 | |||
| 979df1205a | |||
|
|
d9b9748691 | ||
| 32892fb799 | |||
|
|
c6803710c6 | ||
| 2dfdc78c79 | |||
|
|
9d0ac66cdc | ||
| 42703b107b | |||
|
|
0e2380dc3f | ||
| 6c82d9d747 |
@@ -9,7 +9,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
if: "!contains(github.event.head_commit.message, '[skip ci]')"
|
||||
outputs:
|
||||
new_tag: ${{ steps.tag.outputs.new_tag }}
|
||||
version: ${{ steps.version.outputs.version }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
@@ -21,7 +21,14 @@ jobs:
|
||||
with:
|
||||
node-version: 24
|
||||
|
||||
- name: Генерация ARCHITECTURE.md
|
||||
- name: Версия из package.json
|
||||
id: version
|
||||
run: |
|
||||
VERSION="v$(node -p "require('./package.json').version")"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
echo "Версия: $VERSION"
|
||||
|
||||
- name: Генерация docs
|
||||
run: |
|
||||
npm ci
|
||||
npm run docs
|
||||
@@ -30,30 +37,24 @@ jobs:
|
||||
run: |
|
||||
git config user.name "CI Bot"
|
||||
git config user.email "ci@gromlab.ru"
|
||||
git add generated/
|
||||
git add generated/ README_RU.md
|
||||
if git diff --cached --quiet; then
|
||||
echo "ARCHITECTURE.md не изменился, пропуск"
|
||||
echo "Нет изменений, пропуск"
|
||||
else
|
||||
git commit -m "docs: обновить ARCHITECTURE.md [skip ci]"
|
||||
git commit -m "docs: обновить generated (${{ steps.version.outputs.version }}) [skip ci]"
|
||||
git push origin main
|
||||
fi
|
||||
|
||||
- name: Автоматический тег (semver patch)
|
||||
id: tag
|
||||
- name: Создать тег
|
||||
run: |
|
||||
LAST_TAG=$(git tag -l 'v*' --sort=-v:refname | head -1)
|
||||
if [ -z "$LAST_TAG" ]; then
|
||||
NEW_TAG="v0.1.0"
|
||||
VERSION=${{ steps.version.outputs.version }}
|
||||
if git tag -l "$VERSION" | grep -q "$VERSION"; then
|
||||
echo "Тег $VERSION уже существует, пропуск"
|
||||
else
|
||||
MAJOR=$(echo "$LAST_TAG" | cut -d. -f1)
|
||||
MINOR=$(echo "$LAST_TAG" | cut -d. -f2)
|
||||
PATCH=$(echo "$LAST_TAG" | cut -d. -f3)
|
||||
NEW_TAG="${MAJOR}.${MINOR}.$((PATCH + 1))"
|
||||
git tag "$VERSION"
|
||||
git push origin "$VERSION"
|
||||
echo "Создан тег: $VERSION"
|
||||
fi
|
||||
git tag "$NEW_TAG"
|
||||
git push origin "$NEW_TAG"
|
||||
echo "new_tag=$NEW_TAG" >> $GITHUB_OUTPUT
|
||||
echo "Создан тег: $NEW_TAG"
|
||||
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -91,7 +92,7 @@ jobs:
|
||||
type=ref,event=branch
|
||||
type=sha,prefix=
|
||||
type=raw,value=latest,enable={{is_default_branch}}
|
||||
type=raw,value=${{ needs.docs.outputs.new_tag }}
|
||||
type=raw,value=${{ needs.docs.outputs.version }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v5
|
||||
@@ -103,7 +104,7 @@ jobs:
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
build-args: |
|
||||
VERSION_TAG=${{ needs.docs.outputs.new_tag }}
|
||||
VERSION_TAG=${{ needs.docs.outputs.version }}
|
||||
provenance: false
|
||||
sbom: false
|
||||
|
||||
@@ -132,31 +133,23 @@ jobs:
|
||||
IMAGE="${{ env.REGISTRY_IMAGE }}:latest"
|
||||
CONTAINER="slm-design"
|
||||
|
||||
# Логин в реестр
|
||||
echo '${{ secrets.CR_TOKEN }}' | docker login ${{ env.DOCKER_REGISTRY }} -u '${{ secrets.CR_USER }}' --password-stdin
|
||||
|
||||
# Сохранить ID текущего образа до pull
|
||||
OLD_IMAGE_ID=$(docker images -q "$IMAGE" 2>/dev/null || true)
|
||||
|
||||
# Скачать новый образ
|
||||
docker pull "$IMAGE"
|
||||
|
||||
# Перезапустить контейнер
|
||||
docker stop "$CONTAINER" 2>/dev/null || true
|
||||
docker rm "$CONTAINER" 2>/dev/null || true
|
||||
docker run -d --name "$CONTAINER" --network web --restart unless-stopped "$IMAGE"
|
||||
|
||||
# Удалить старый образ если он отличается от нового
|
||||
NEW_IMAGE_ID=$(docker images -q "$IMAGE")
|
||||
if [ -n "$OLD_IMAGE_ID" ] && [ "$OLD_IMAGE_ID" != "$NEW_IMAGE_ID" ]; then
|
||||
docker rmi "$OLD_IMAGE_ID" 2>/dev/null || true
|
||||
fi
|
||||
|
||||
# Очистка
|
||||
docker image prune -af --filter "label=org.opencontainers.image.title=$CONTAINER"
|
||||
docker image prune -f
|
||||
docker builder prune -f 2>/dev/null || true
|
||||
|
||||
# Статус
|
||||
docker ps --filter "name=$CONTAINER"
|
||||
SCRIPT
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -140,5 +140,3 @@ docs/.vitepress
|
||||
notes
|
||||
|
||||
|
||||
# Генерируемые файлы
|
||||
README_RU.md
|
||||
@@ -4,7 +4,7 @@ WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm ci
|
||||
COPY . .
|
||||
RUN sed -i "s|raw/branch/main/generated|raw/tag/${VERSION_TAG}/generated|" docs/ru/index.md \
|
||||
RUN sed -i "s|raw/branch/main|raw/tag/${VERSION_TAG}|g" docs/ru/index.md \
|
||||
&& npm run build
|
||||
|
||||
FROM caddy:2-alpine
|
||||
|
||||
101
README_RU.md
Normal file
101
README_RU.md
Normal file
@@ -0,0 +1,101 @@
|
||||
<!-- rules-link -->
|
||||
<br>
|
||||
|
||||
> 🤖 **Единый файл для AI-ассистентов**:
|
||||
> [https://gromlab.ru/gromov/slm-design/raw/tag/v0.1.5/generated/ru/ARCHITECTURE.md](https://gromlab.ru/gromov/slm-design/raw/tag/v0.1.5/generated/ru/ARCHITECTURE.md)
|
||||
<!-- /rules-link -->
|
||||
|
||||
# SLM Design
|
||||
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
|
||||
|
||||
## Преимущества
|
||||
|
||||
### Вертикальная организация домена
|
||||
|
||||
Бизнес-домен не разбивается по техническим слоям — сценарии, сущности, типы и UI живут в одном модуле. Это сокращает время навигации и упрощает сопровождение: все изменения домена локализованы.
|
||||
|
||||
### Dependency Injection без фреймворков
|
||||
|
||||
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||
|
||||
### Разделение ответственности без перегрузки слоёв
|
||||
|
||||
Сервисы приложения (`infrastructure/`), UI-кит (`ui/`) и общие ресурсы (`shared/`) — три разных слоя с разной природой. Ни один слой не превращается в свалку разнородного кода.
|
||||
|
||||
### Горизонтальная инкапсуляция
|
||||
|
||||
Вложенные модули (`parts/`) и направление зависимостей позволяют нескольким разработчикам работать над одной областью приложения параллельно, не затрагивая код друг друга.
|
||||
|
||||
### Колокация по умолчанию
|
||||
|
||||
Код начинает жизнь рядом с местом использования и поднимается в общие слои только при реальной потребности. Глобальные слои не засоряются преждевременными абстракциями.
|
||||
|
||||
### Явное разделение каркаса и контента
|
||||
|
||||
Каркас группы маршрутов (`layouts/`) и контент конкретной страницы (`screens/`) — независимые слои с собственной ответственностью.
|
||||
|
||||
### Масштабирование через группировку
|
||||
|
||||
При росте проекта слои не теряют структуру — модули группируются по естественным признакам: бизнес-домены по субдоменам, страницы по разделам, UI-компоненты по уровню абстракции (примитивы и композиции).
|
||||
|
||||
## Происхождение
|
||||
|
||||
SLM Design вырос на основе:
|
||||
|
||||
- **Feature-Sliced Design** — слоистая структура, публичный API модуля, направление зависимостей
|
||||
- **Vertical Slice Architecture** — модуль как вертикальный срез, содержащий всё необходимое
|
||||
- **Screaming Architecture** — структура проекта «кричит» о назначении: открыл `business/auth` — видишь авторизацию
|
||||
- **Colocation Principle** — код живёт рядом с местом использования
|
||||
|
||||
## Пример структуры проекта
|
||||
|
||||
```text
|
||||
src/
|
||||
├── app/
|
||||
│
|
||||
├── layouts/
|
||||
│ ├── main/
|
||||
│ └── dashboard/
|
||||
│
|
||||
├── screens/
|
||||
│ ├── home/
|
||||
│ ├── products/
|
||||
│ ├── product-detail/
|
||||
│ └── about/
|
||||
│
|
||||
├── widgets/
|
||||
│ ├── page-heading/
|
||||
│ ├── hero-section/
|
||||
│ └── promo-banner/
|
||||
│
|
||||
├── business/
|
||||
│ ├── auth/
|
||||
│ ├── catalog/
|
||||
│ ├── orders/
|
||||
│ └── chat/
|
||||
│
|
||||
├── infrastructure/
|
||||
│ ├── theme/
|
||||
│ ├── i18n/
|
||||
│ ├── backend-api/
|
||||
│ └── logger/
|
||||
│
|
||||
├── ui/
|
||||
│ ├── button/
|
||||
│ ├── input/
|
||||
│ ├── modal/
|
||||
│ ├── toast/
|
||||
│ └── dropdown/
|
||||
│
|
||||
└── shared/
|
||||
├── lib/
|
||||
├── types/
|
||||
└── styles/
|
||||
```
|
||||
|
||||
## Принципы
|
||||
|
||||
- **Домен — единое целое.** Всё, что относится к домену, живёт в одном модуле.
|
||||
- **Колокация.** Код рождается рядом с местом использования и поднимается только при необходимости.
|
||||
- **Зависимости однонаправлены.** Импорты только сверху вниз, только через публичный API.
|
||||
- **Архитектура — каркас, не клетка.** Правила фиксируют направление зависимостей и структуру модуля, остальное определяет команда.
|
||||
31
concat-md.js
31
concat-md.js
@@ -73,4 +73,35 @@ const buildRules = (lang) => {
|
||||
buildRules("ru");
|
||||
buildRules("en");
|
||||
|
||||
// Версия из package.json
|
||||
const pkg = JSON.parse(fs.readFileSync("./package.json", "utf8"));
|
||||
const version = `v${pkg.version}`;
|
||||
|
||||
// Подставить версию в ссылки
|
||||
const replaceVersion = (content) =>
|
||||
content.replace(/raw\/branch\/main/g, `raw/tag/${version}`);
|
||||
|
||||
|
||||
|
||||
// Генерируем README из index.md
|
||||
const buildReadme = (lang, outFile) => {
|
||||
const indexPath = `./docs/${lang}/index.md`;
|
||||
|
||||
if (!fs.existsSync(indexPath)) {
|
||||
console.log(`Пропуск README (${lang}): ${indexPath} не найден`);
|
||||
return;
|
||||
}
|
||||
|
||||
let content = replaceVersion(stripFrontmatter(fs.readFileSync(indexPath, "utf8")));
|
||||
// В README <br> нужен вверху блока, а не внизу
|
||||
content = content.replace(
|
||||
/<!-- rules-link -->\n(> .+\n> .+)\n\n<br>\n<!-- \/rules-link -->/,
|
||||
"<!-- rules-link -->\n<br>\n\n$1\n<!-- /rules-link -->"
|
||||
);
|
||||
fs.writeFileSync(outFile, content, "utf8");
|
||||
console.log(`${outFile} создан из ${indexPath} (${version})`);
|
||||
};
|
||||
|
||||
buildReadme("ru", "./README_RU.md");
|
||||
|
||||
|
||||
|
||||
@@ -2,19 +2,26 @@
|
||||
title: SLM Design
|
||||
---
|
||||
|
||||
<!-- rules-link -->
|
||||
> 🤖 **Единый файл для AI-ассистентов**:
|
||||
> [https://gromlab.ru/gromov/slm-design/raw/branch/main/generated/ru/ARCHITECTURE.md](https://gromlab.ru/gromov/slm-design/raw/branch/main/generated/ru/ARCHITECTURE.md)
|
||||
|
||||
<br>
|
||||
<!-- /rules-link -->
|
||||
|
||||
# SLM Design
|
||||
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
|
||||
|
||||
<!-- rules-link -->
|
||||
Для AI-ассистентов доступен [единый файл правил](https://gromlab.ru/gromov/slm-design/raw/branch/main/generated/ru/ARCHITECTURE.md).
|
||||
<!-- /rules-link -->
|
||||
|
||||
## Преимущества
|
||||
|
||||
### Вертикальная организация домена
|
||||
|
||||
Бизнес-домен не разбивается по техническим слоям — сценарии, сущности, типы и UI живут в одном модуле. Это сокращает время навигации и упрощает сопровождение: все изменения домена локализованы.
|
||||
|
||||
### Dependency Injection без фреймворков
|
||||
|
||||
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||
|
||||
### Разделение ответственности без перегрузки слоёв
|
||||
|
||||
Сервисы приложения (`infrastructure/`), UI-кит (`ui/`) и общие ресурсы (`shared/`) — три разных слоя с разной природой. Ни один слой не превращается в свалку разнородного кода.
|
||||
@@ -35,10 +42,6 @@ Scoped Layered Module Design — модульная архитектура фр
|
||||
|
||||
При росте проекта слои не теряют структуру — модули группируются по естественным признакам: бизнес-домены по субдоменам, страницы по разделам, UI-компоненты по уровню абстракции (примитивы и композиции).
|
||||
|
||||
### Dependency Injection без фреймворков
|
||||
|
||||
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||
|
||||
## Происхождение
|
||||
|
||||
SLM Design вырос на основе:
|
||||
|
||||
@@ -8,6 +8,10 @@ Scoped Layered Module Design — модульная архитектура фр
|
||||
|
||||
Бизнес-домен не разбивается по техническим слоям — сценарии, сущности, типы и UI живут в одном модуле. Это сокращает время навигации и упрощает сопровождение: все изменения домена локализованы.
|
||||
|
||||
### Dependency Injection без фреймворков
|
||||
|
||||
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||
|
||||
### Разделение ответственности без перегрузки слоёв
|
||||
|
||||
Сервисы приложения (`infrastructure/`), UI-кит (`ui/`) и общие ресурсы (`shared/`) — три разных слоя с разной природой. Ни один слой не превращается в свалку разнородного кода.
|
||||
@@ -28,10 +32,6 @@ Scoped Layered Module Design — модульная архитектура фр
|
||||
|
||||
При росте проекта слои не теряют структуру — модули группируются по естественным признакам: бизнес-домены по субдоменам, страницы по разделам, UI-компоненты по уровню абстракции (примитивы и композиции).
|
||||
|
||||
### Dependency Injection без фреймворков
|
||||
|
||||
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||
|
||||
## Происхождение
|
||||
|
||||
SLM Design вырос на основе:
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "nextjs-style-guide",
|
||||
"name": "slm-design",
|
||||
"version": "0.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "nextjs-style-guide",
|
||||
"name": "slm-design",
|
||||
"version": "0.0.0",
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.6.3"
|
||||
|
||||
@@ -2,14 +2,13 @@
|
||||
"name": "slm-design",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"version": "0.0.0",
|
||||
"version": "0.1.5",
|
||||
"scripts": {
|
||||
"docs": "node ./concat-md.js",
|
||||
"dev": "vitepress dev .",
|
||||
"build": "vitepress build .",
|
||||
"build": "node ./concat-md.js && vitepress build .",
|
||||
"serve": "vitepress serve ."
|
||||
},
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.6.3"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user