Как добавить модуль
Порядок одинаков для базовой платформы и для продуктового слоя.
- Создайте директорию по соглашению:
для сервиса,modules/microservices/<домен>/ms-<имя>для экрана,modules/microfrontends/<домен>/mf-<имя>для процесса.modules/workflows/wf-<имя> - Опишите контракт в
и сгенерируйте клиентов:modules/types/<домен>/. Клиент появится как пакетbun run genи станет доступен из браузера, из другого процесса на шине и изнутри workflow.g-<имя> - Напишите README с разделами
и разделом о границе ответственности. Первые абзацы этих разделов попадут в реестр на сайте — пишите их для читателя, а не для себя.## Purpose - Включите модуль в решение, если он поставляется не в одиночку: добавьте короткое имя в
и объявите зависимости.modules/solutions/solutions.json - Пересоберите документацию:
вbun run docs. Модуль появится в реестре, счётчики на странице экосистемы пересчитаются сами.core/tools/docs
Чего делать не нужно: править списки модулей в данных сайта, дублировать описание в лендинге, регистрировать модуль где-то ещё. Генерация односторонняя — из исходников в данные, и никогда обратно. Всё, что лежит в , при следующей сборке будет перезаписано.data/
Требования к модулю на ревью: он не ходит в чужие хранилища, не обходит шину прямыми вызовами, объявляет только те разрешения, которыми пользуется, и не расширяет свою зону ответственности молча.