Общие библиотеки
Общий код ChurchApps публикуется в npm в области @churchapps/*. Все общие пакеты находятся в одном репозитории — Packages — который управляется как рабочее пространство Yarn (Berry) и версионируется с помощью changesets.
Пакеты
| Пакет | Описание | Используется в |
|---|---|---|
@churchapps/helpers | Базовый уровень: вспомогательные функции без привязки к фреймворку и общие интерфейсы TypeScript, которые формируют межприложенческий контракт данных | Все проекты |
@churchapps/apihelper | Серверные утилиты для Express: аутентификация, базовые контроллеры, доступ к базе данных, интеграции с AWS и email | Все API |
@churchapps/apphelper | Общие React-компоненты и модули функций (вход, пожертвования, формы, markdown, сайт) | Все веб-приложения |
@churchapps/content-providers | Абстракция над сторонними поставщиками контента (Lessons.church, Planning Center, Dropbox и другие) | Api, B1Admin, B1App, FreePlay |
@churchapps/integration-sdk | Инструментарий для создания интеграций B1.church: проверка webhook, типизированный REST-клиент, помощники OAuth | Внешние разработчики интеграций |
@churchapps/texting | Абстракция над провайдерами SMS (Text In Church, Clearstream, Mutual Ministry, MinistryStuff, Nalo Solutions, Twilio) | Api |
Направление зависимостей строго нисходящее: приложения зависят от apihelper и apphelper, которые объявляют @churchapps/helpers как peer dependency, чтобы каждое приложение использовало ровно одну копию пакета.
Настройка рабочего пространства
git clone https://github.com/ChurchApps/Packages.git
cd Packages
yarn install
yarn build
Репозиторий использует Yarn Berry (поле packageManager в корне является определяющим) с одним файлом блокировки. yarn build собирает все пакеты в порядке зависимостей; yarn test запускает тесты всех пакетов.
Публикация с помощью Changesets
Каждое изменение пакета поставляется вместе с changeset:
- Выполните
yarn changesetв корне рабочего пространства. Выберите затронутые пакеты, тип увеличения версии (patch — исправление, minor — новый экспорт или функция, major — несовместимое изменение) и напишите краткое описание в одну строку — оно станет записью в CHANGELOG. - Зафиксируйте сгенерированный файл
.changeset/*.mdвместе с изменением кода. Хук pre-commit блокирует коммиты, которые меняют исходный код пакета без индексированного changeset. - Когда будете готовы к публикации, выполните
yarn publish-allв корне. Команда использует ожидающие changesets (повышает версии, обновляет CHANGELOG, синхронизирует диапазоны внутренних зависимостей), собирает всё в порядке зависимостей и публикует повышенные пакеты в npm. Затем зафиксируйте и отправьте повышения версий.
Никогда не запускайте голый npm publish внутри отдельного пакета — он пропускает порядок сборки и ведение версий, которым занимается скрипт выпуска. Для публикации нужна учётная запись npm с правами публикации в область @churchapps.
Локальная разработка с подключённым приложением
Внутри рабочего пространства пакеты собираются напрямую относительно соседних пакетов — связывать ничего не нужно. Чтобы протестировать неопубликованную сборку пакета внутри приложения-потребителя (B1Admin, B1App и т. д.), добавьте во временный проект-потребитель Yarn portal:
# in the consuming project
yarn link ../Packages/helpers
# ... test ...
yarn unlink ../Packages/helpers && yarn install
Сначала соберите пакет (yarn build в корне рабочего пространства) — потребитель читает скомпилированный вывод dist/, а не исходный код.
yarn link записывает разрешение portal в package.json потребителя. Никогда не фиксируйте его — всегда выполняйте yarn unlink и переустанавливайте зависимости, когда закончите.