Compare commits
12 Commits
v0.1.0
...
d3a152e177
| Author | SHA1 | Date | |
|---|---|---|---|
| d3a152e177 | |||
| 515506e01e | |||
| 35763617b5 | |||
| 979df1205a | |||
|
|
d9b9748691 | ||
| 32892fb799 | |||
|
|
c6803710c6 | ||
| 2dfdc78c79 | |||
|
|
9d0ac66cdc | ||
| 42703b107b | |||
|
|
0e2380dc3f | ||
| 6c82d9d747 |
@@ -9,7 +9,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: "!contains(github.event.head_commit.message, '[skip ci]')"
|
if: "!contains(github.event.head_commit.message, '[skip ci]')"
|
||||||
outputs:
|
outputs:
|
||||||
new_tag: ${{ steps.tag.outputs.new_tag }}
|
version: ${{ steps.version.outputs.version }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
@@ -21,7 +21,14 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: 24
|
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: |
|
run: |
|
||||||
npm ci
|
npm ci
|
||||||
npm run docs
|
npm run docs
|
||||||
@@ -30,30 +37,24 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
git config user.name "CI Bot"
|
git config user.name "CI Bot"
|
||||||
git config user.email "ci@gromlab.ru"
|
git config user.email "ci@gromlab.ru"
|
||||||
git add generated/
|
git add generated/ README_RU.md
|
||||||
if git diff --cached --quiet; then
|
if git diff --cached --quiet; then
|
||||||
echo "ARCHITECTURE.md не изменился, пропуск"
|
echo "Нет изменений, пропуск"
|
||||||
else
|
else
|
||||||
git commit -m "docs: обновить ARCHITECTURE.md [skip ci]"
|
git commit -m "docs: обновить generated (${{ steps.version.outputs.version }}) [skip ci]"
|
||||||
git push origin main
|
git push origin main
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Автоматический тег (semver patch)
|
- name: Создать тег
|
||||||
id: tag
|
|
||||||
run: |
|
run: |
|
||||||
LAST_TAG=$(git tag -l 'v*' --sort=-v:refname | head -1)
|
VERSION=${{ steps.version.outputs.version }}
|
||||||
if [ -z "$LAST_TAG" ]; then
|
if git tag -l "$VERSION" | grep -q "$VERSION"; then
|
||||||
NEW_TAG="v0.1.0"
|
echo "Тег $VERSION уже существует, пропуск"
|
||||||
else
|
else
|
||||||
MAJOR=$(echo "$LAST_TAG" | cut -d. -f1)
|
git tag "$VERSION"
|
||||||
MINOR=$(echo "$LAST_TAG" | cut -d. -f2)
|
git push origin "$VERSION"
|
||||||
PATCH=$(echo "$LAST_TAG" | cut -d. -f3)
|
echo "Создан тег: $VERSION"
|
||||||
NEW_TAG="${MAJOR}.${MINOR}.$((PATCH + 1))"
|
|
||||||
fi
|
fi
|
||||||
git tag "$NEW_TAG"
|
|
||||||
git push origin "$NEW_TAG"
|
|
||||||
echo "new_tag=$NEW_TAG" >> $GITHUB_OUTPUT
|
|
||||||
echo "Создан тег: $NEW_TAG"
|
|
||||||
|
|
||||||
docker:
|
docker:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -91,7 +92,7 @@ jobs:
|
|||||||
type=ref,event=branch
|
type=ref,event=branch
|
||||||
type=sha,prefix=
|
type=sha,prefix=
|
||||||
type=raw,value=latest,enable={{is_default_branch}}
|
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
|
- name: Build and push
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v5
|
||||||
@@ -103,7 +104,7 @@ jobs:
|
|||||||
tags: ${{ steps.meta.outputs.tags }}
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
build-args: |
|
build-args: |
|
||||||
VERSION_TAG=${{ needs.docs.outputs.new_tag }}
|
VERSION_TAG=${{ needs.docs.outputs.version }}
|
||||||
provenance: false
|
provenance: false
|
||||||
sbom: false
|
sbom: false
|
||||||
|
|
||||||
@@ -132,31 +133,23 @@ jobs:
|
|||||||
IMAGE="${{ env.REGISTRY_IMAGE }}:latest"
|
IMAGE="${{ env.REGISTRY_IMAGE }}:latest"
|
||||||
CONTAINER="slm-design"
|
CONTAINER="slm-design"
|
||||||
|
|
||||||
# Логин в реестр
|
|
||||||
echo '${{ secrets.CR_TOKEN }}' | docker login ${{ env.DOCKER_REGISTRY }} -u '${{ secrets.CR_USER }}' --password-stdin
|
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)
|
OLD_IMAGE_ID=$(docker images -q "$IMAGE" 2>/dev/null || true)
|
||||||
|
|
||||||
# Скачать новый образ
|
|
||||||
docker pull "$IMAGE"
|
docker pull "$IMAGE"
|
||||||
|
|
||||||
# Перезапустить контейнер
|
|
||||||
docker stop "$CONTAINER" 2>/dev/null || true
|
docker stop "$CONTAINER" 2>/dev/null || true
|
||||||
docker rm "$CONTAINER" 2>/dev/null || true
|
docker rm "$CONTAINER" 2>/dev/null || true
|
||||||
docker run -d --name "$CONTAINER" --network web --restart unless-stopped "$IMAGE"
|
docker run -d --name "$CONTAINER" --network web --restart unless-stopped "$IMAGE"
|
||||||
|
|
||||||
# Удалить старый образ если он отличается от нового
|
|
||||||
NEW_IMAGE_ID=$(docker images -q "$IMAGE")
|
NEW_IMAGE_ID=$(docker images -q "$IMAGE")
|
||||||
if [ -n "$OLD_IMAGE_ID" ] && [ "$OLD_IMAGE_ID" != "$NEW_IMAGE_ID" ]; then
|
if [ -n "$OLD_IMAGE_ID" ] && [ "$OLD_IMAGE_ID" != "$NEW_IMAGE_ID" ]; then
|
||||||
docker rmi "$OLD_IMAGE_ID" 2>/dev/null || true
|
docker rmi "$OLD_IMAGE_ID" 2>/dev/null || true
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Очистка
|
|
||||||
docker image prune -af --filter "label=org.opencontainers.image.title=$CONTAINER"
|
docker image prune -af --filter "label=org.opencontainers.image.title=$CONTAINER"
|
||||||
docker image prune -f
|
docker image prune -f
|
||||||
docker builder prune -f 2>/dev/null || true
|
docker builder prune -f 2>/dev/null || true
|
||||||
|
|
||||||
# Статус
|
|
||||||
docker ps --filter "name=$CONTAINER"
|
docker ps --filter "name=$CONTAINER"
|
||||||
SCRIPT
|
SCRIPT
|
||||||
|
|||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -140,5 +140,3 @@ docs/.vitepress
|
|||||||
notes
|
notes
|
||||||
|
|
||||||
|
|
||||||
# Генерируемые файлы
|
|
||||||
README_RU.md
|
|
||||||
@@ -4,7 +4,7 @@ WORKDIR /app
|
|||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
RUN npm ci
|
RUN npm ci
|
||||||
COPY . .
|
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
|
&& npm run build
|
||||||
|
|
||||||
FROM caddy:2-alpine
|
FROM caddy:2-alpine
|
||||||
|
|||||||
98
README_RU.md
Normal file
98
README_RU.md
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
# SLM Design
|
||||||
|
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
|
||||||
|
|
||||||
|
<!-- rules-link -->
|
||||||
|
🤖 Для AI-ассистентов доступен единый файл правил:<br>[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 -->
|
||||||
|
|
||||||
|
## Преимущества
|
||||||
|
|
||||||
|
### Вертикальная организация домена
|
||||||
|
|
||||||
|
Бизнес-домен не разбивается по техническим слоям — сценарии, сущности, типы и UI живут в одном модуле. Это сокращает время навигации и упрощает сопровождение: все изменения домена локализованы.
|
||||||
|
|
||||||
|
### Разделение ответственности без перегрузки слоёв
|
||||||
|
|
||||||
|
Сервисы приложения (`infrastructure/`), UI-кит (`ui/`) и общие ресурсы (`shared/`) — три разных слоя с разной природой. Ни один слой не превращается в свалку разнородного кода.
|
||||||
|
|
||||||
|
### Горизонтальная инкапсуляция
|
||||||
|
|
||||||
|
Вложенные модули (`parts/`) и направление зависимостей позволяют нескольким разработчикам работать над одной областью приложения параллельно, не затрагивая код друг друга.
|
||||||
|
|
||||||
|
### Колокация по умолчанию
|
||||||
|
|
||||||
|
Код начинает жизнь рядом с местом использования и поднимается в общие слои только при реальной потребности. Глобальные слои не засоряются преждевременными абстракциями.
|
||||||
|
|
||||||
|
### Явное разделение каркаса и контента
|
||||||
|
|
||||||
|
Каркас группы маршрутов (`layouts/`) и контент конкретной страницы (`screens/`) — независимые слои с собственной ответственностью.
|
||||||
|
|
||||||
|
### Масштабирование через группировку
|
||||||
|
|
||||||
|
При росте проекта слои не теряют структуру — модули группируются по естественным признакам: бизнес-домены по субдоменам, страницы по разделам, UI-компоненты по уровню абстракции (примитивы и композиции).
|
||||||
|
|
||||||
|
### Dependency Injection без фреймворков
|
||||||
|
|
||||||
|
Cross-domain зависимости в бизнес-слое реализуются через фабрики — модуль декларирует что ему нужно, а точка использования предоставляет зависимости. Домены изолированы без DI-контейнеров, провайдеров и шин событий.
|
||||||
|
|
||||||
|
## Происхождение
|
||||||
|
|
||||||
|
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.
|
||||||
|
- **Архитектура — каркас, не клетка.** Правила фиксируют направление зависимостей и структуру модуля, остальное определяет команда.
|
||||||
24
concat-md.js
24
concat-md.js
@@ -73,4 +73,28 @@ const buildRules = (lang) => {
|
|||||||
buildRules("ru");
|
buildRules("ru");
|
||||||
buildRules("en");
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = replaceVersion(stripFrontmatter(fs.readFileSync(indexPath, "utf8")));
|
||||||
|
fs.writeFileSync(outFile, content, "utf8");
|
||||||
|
console.log(`${outFile} создан из ${indexPath} (${version})`);
|
||||||
|
};
|
||||||
|
|
||||||
|
buildReadme("ru", "./README_RU.md");
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ title: SLM Design
|
|||||||
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
|
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
|
||||||
|
|
||||||
<!-- rules-link -->
|
<!-- rules-link -->
|
||||||
Для AI-ассистентов доступен [единый файл правил](https://gromlab.ru/gromov/slm-design/raw/branch/main/generated/ru/ARCHITECTURE.md).
|
🤖 Для AI-ассистентов доступен единый файл правил:<br>[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)
|
||||||
<!-- /rules-link -->
|
<!-- /rules-link -->
|
||||||
|
|
||||||
## Преимущества
|
## Преимущества
|
||||||
|
|||||||
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",
|
"version": "0.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "nextjs-style-guide",
|
"name": "slm-design",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vitepress": "^1.6.3"
|
"vitepress": "^1.6.3"
|
||||||
|
|||||||
@@ -2,14 +2,13 @@
|
|||||||
"name": "slm-design",
|
"name": "slm-design",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"version": "0.0.0",
|
"version": "0.1.5",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"docs": "node ./concat-md.js",
|
"docs": "node ./concat-md.js",
|
||||||
"dev": "vitepress dev .",
|
"dev": "vitepress dev .",
|
||||||
"build": "vitepress build .",
|
"build": "vitepress build .",
|
||||||
"serve": "vitepress serve ."
|
"serve": "vitepress serve ."
|
||||||
},
|
},
|
||||||
"dependencies": {},
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vitepress": "^1.6.3"
|
"vitepress": "^1.6.3"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user