slm-design/docs/rules/registry.md

Реестр правил SLM

Здесь собраны правила SLM. Это единственное место, где они формулируются; тематические документы объясняют архитектуру и ссылаются на коды.

Размещение кода по слоям

SLM-LAYER-R001

Назначение слоёв

Код внутри SLM root размещается в слое, нормативная роль которого соответствует ответственности этого кода.

SLM-LAYER-A002

Направление зависимостей

Внутри одного SLM root код каждого слоя может зависеть только от кода целевых слоёв, разрешённых для него нормативной матрицей слоёв.

SLM-LAYER-R003

Граница слоя app

В app размещаются только точки входа фреймворка для запуска, маршрутов, преобразования входных данных и подключения публичных API модулей разрешённых слоёв или ресурсов shared; ответственности этих модулей остаются за пределами app.

Границы модулей

SLM-MODULE-A004

Публичный API модуля

Каждый модуль предоставляет единый логический публичный API через обязательный корневой фасет index и, при необходимости, фасеты client, browser и server; код за пределами модуля импортирует его содержимое только через эти фасеты.

SLM-MODULE-A014

Папка модуля

Каждый модуль размещается в отдельной папке; его публичный API и внутренняя реализация находятся внутри этой границы, а вложенные модули образуют собственные папки.

SLM-MODULE-R006

Ответственность модуля

Одна модульная граница содержит код одной связной ответственности; части, которые изменяются по несвязанным причинам, размещаются в разных модулях.

SLM-MODULE-R011

Владелец ответственности

Каждая самостоятельная ответственность и относящийся к ней код принадлежат ровно одному модулю; вне модульной границы допускаются только точки входа app и нормативные ресурсы shared.

SLM-MODULE-R012

Состав публичного API

Публичный API модуля открывает только контракт, необходимый реальным внешним потребителям; детали реализации и изменяемые внутренние механизмы остаются закрытыми.

Зависимости между модулями

SLM-DEPENDENCY-A005

Циклические зависимости

Зависимости между модулями внутри одного SLM root, включая вложенные модули, не образуют циклов.

Назначение групп

SLM-GROUP-R007

Назначение группы

Группа содержит только модули и другие группы, не владеет файлами реализации, состоянием, жизненным циклом или публичным API и не импортируется внешним кодом.

Назначение сегментов

SLM-SEGMENT-R008

Граница сегмента

Сегмент организует код только внутри одного модуля и не имеет собственной ответственности, публичного API или границы зависимостей.

Ответственность компонентов

SLM-COMPONENT-R009

Ответственность компонента

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

Границы вложенных модулей

SLM-NESTED_MODULE-A010

Доступ к вложенному модулю

Код за пределами родительского модуля не импортирует вложенный модуль напрямую и получает его экспорты только через публичный API родителя.

Жизненный цикл

SLM-LIFECYCLE-R013

Жизненный цикл ресурсов

Для каждого ресурса жизненного цикла модуль-владелец определяет создание, область жизни, число экземпляров и очистку; ресурс активен только внутри своей области жизни.

Границы сред выполнения

SLM-ENVIRONMENT-R016

Универсальный фасет

Корневой фасет index экспортирует только публичный код, совместимый как с серверным рендерингом, включая RSC, так и с клиентским выполнением, и не импортирует или реэкспортирует код фасетов client, browser или server прямо либо транзитивно.

SLM-ENVIRONMENT-R017

Клиентский фасет

Фасет client экспортирует только клиентский код, который не может выполняться как RSC, и не импортирует или реэкспортирует код фасетов browser или server прямо либо транзитивно.

SLM-ENVIRONMENT-R018

Браузерный фасет

Фасет browser экспортирует только browser-only код, а потребители импортируют его только динамически с отключённым SSR.

SLM-ENVIRONMENT-R019

Серверный фасет

Фасет server экспортирует только server-only код и не импортируется или реэкспортируется фасетами index, client или browser прямо либо транзитивно.