bb Plugin Atlas — неофициальное руководство по SDK плагинов bb. Оно поможет разобраться, из чего состоит плагин, где он выполняется, в каких поверхностях (surfaces) приложения может отрисовываться и к чему ему разрешён доступ. Руководство написано для разработчика, который знает TypeScript и React, но ещё ни разу не писал плагин.
Материал выстроен так, чтобы в голове постепенно сложилась рабочая модель. Сначала разбирается, как устроен сам bb, потом как работает плагин. Дальше идёт первый собственный плагин и только после этого справочник. Такой порядок избавит от ситуации, когда ты сразу тонешь в API и не понимаешь, куда что встраивается.
Справочник не пишется вручную. Он генерируется из репозитория bb на зафиксированном релизе, и каждый символ ведёт на ту строку исходников, где он объявлен. Если описание кажется неполным, можно за один клик открыть оригинал и проверить.
Самая практичная часть — брифы. Для каждой поверхности, слота и пространства имён атлас сформирует короткое описание, которое можно вставить в ИИ-агента для написания кода. Агент получит нужный контекст, и тебе не придётся объяснять ему устройство SDK своими словами.
Сайт открыт по адресу nobilix.github.io/bb-plugin-atlas/ и доступен на двух языках: английская версия лежит в корне, русская — по пути /ru/. Проект можно запустить и локально. Для этого выполни pnpm install и pnpm --filter site dev, после чего сервер поднимется на localhost:4321. Сборка делается через pnpm build, а pnpm verify прогонит проверку типов, сборку, тесты и Playwright. Учти, что поиск работает только в production-сборке, поэтому в dev-режиме его не будет.
Прежде чем опираться на атлас, стоит держать в голове несколько оговорок:
- текущая версия документации описывает bb 0.43.3, @get-bb/plugin-sdk 0.4.104 и тег desktop-v0.43.3 репозитория get-bb/bb, а перенос на новый релиз описан в docs-internal/HOW-IT-WORKS.md;
- проект никак не связан с командой bb, это независимая работа;
- код и авторский текст распространяются под лицензией MIT, а цитаты из репозитория bb остаются под лицензией bb и ссылаются на источник.