Публикация и версии

Публикация состоит из создания карточки плагина и отправки его версии на модерацию. Карточка появляется в публичном каталоге после одобрения первой версии. Для работы с публикацией нужен аккаунт Block Display и подготовленный файл плагина.

Идентичность пакета

Перед публикацией различайте четыре значения:

Значение	Где используется
@name в JS	Имя плагина при установке локального файла.
@namespace в JS	Идентификатор, по которому локальный файл сохраняется и заменяет предыдущую установку.
Slug карточки	Неизменяемый идентификатор в каталоге и адресе страницы. При установке из каталога используется как namespace.
Версия	@version читается из локального файла; при установке из каталога берётся номер выбранной опубликованной версии.

Для одного выпуска указывайте одинаковую версию в шапке и форме каталога, а namespace согласуйте со slug. Иначе локальная и каталожная установки с разными идентификаторами будут отдельными плагинами. Метаданные каталога при установке имеют приоритет над шапкой файла, включая имя, описание, автора и иконку.

Проверьте структуру файла и метаданные. Поле @version необязательно для локального загрузчика и без него равно 1.0.0, но в форме отправки версии номер обязателен.

Подготовить материал

Для карточки понадобятся:

Поле	Требования
Название плагина	Обязательно, до 70 символов.
Иконка	Обязательное изображение JPG, PNG или WebP до 10 МБ и 24 млн пикселей. Оно обрезается по центру до квадрата и преобразуется в WebP 256 × 256.
Slug плагина	Уникальное значение длиной 4-64 символа: строчные латинские буквы, цифры и дефисы. Дефис не может быть первым или последним символом. После создания slug изменить нельзя.
Описание	Необязательный текст до 1000 символов, без HTML-оформления.

Пример slug: my-useful-plugin. В описании кратко объясните назначение инструмента, основные действия и существенные ограничения, включая зависимость от внутренних возможностей редактора, если она есть.

Для версии подготовьте:

Поле	Требования
Версия	Три числовые части через точку, например 1.0.0. Суффиксы вроде -beta не поддерживаются.
JavaScript файл	Один непустой .js в UTF-8, до 512 КБ. Загружайте сам файл, не ZIP-архив.
Список изменений	Необязательный текст до 1000 символов. Для первого выпуска можно перечислить основные возможности.

Формат номера - требование формы каталога. Дополнительных правил о значении каждой числовой части здесь не устанавливается. Для собственной поддержки используйте понятную последовательность номеров и описывайте изменения поведения.

До отправки установите именно подготовленный файл в Release, проверьте основной сценарий, закрытие и повторное открытие окон, сохранность проекта и работу после перезапуска. Подробный список: контрольные сценарии.

Публикация через Dev Studio

1. Войдите в аккаунт на сайте Block Display. Нажмите на аватар в верхнем меню и выберите Dev Studio, либо откройте Dev Studio по прямой ссылке.
2. Нажмите Опубликовать или выберите Новый плагин в боковом меню.
3. Заполните название, иконку, slug и при желании описание. Нажмите Опубликовать плагин.
4. Откроется список версий созданной карточки. В публичном каталоге плагина пока нет.
5. Нажмите Добавить новую версию плагина, укажите номер, выберите .js и при желании заполните список изменений.
6. Нажмите Отправить версию. В списке версий появится статус На модерации.

Скриншоты необязательны. После создания карточки нажмите Редактировать плагин. В блоке Скриншоты нажмите Добавить скриншоты. Можно добавить до 5 изображений JPG, PNG или WebP. Для каждого нужны ширина не менее 1280 px, высота не менее 720 px, размер до 10 МБ и разрешение до 24 млн пикселей.

Первый скриншот основной. Порядок меняется перетаскиванием или стрелками. Скриншоты сохраняются сразу после загрузки, их можно заменять и удалять.

Проверяйте результат модерации в Dev Studio > Версии нужного плагина:

• После одобрения версия получает статус Одобрено и отметку Текущая. После первого одобрения плагин становится доступен всем в каталоге.
• Если версия отклонена, исправьте файл и отправьте повторно. Для отклонённой версии разрешён тот же номер.
• Версию, которая ещё находится на модерации, можно удалить и загрузить заново.

Проверка установки и обновления

Найдите плагин через Обзор > BDE Плагины, раздел плагинов или ссылку Плагины сообщества в Dev Studio. Адрес страницы формируется из slug: https://www.block-display.com/plg/my-useful-plugin/.

На странице доступны описание, скриншоты, комментарии, история одобренных версий, Установить для веб-редактора и Открыть в BDEngine App. В редакторе пользователь выбирает версию и подтверждает установку. Затем в разделе Мои плагины появляется предложение перезапустить BDEngine. Новая версия начнёт работать после перезапуска.

Проверьте установку именно со страницы каталога, даже если локальный .js уже работал: сверьте выбранную версию и отображаемые метаданные, исключите вторую тестовую копию с другим namespace и повторите основной сценарий. Пользовательский маршрут описан в статье плагины редактора.

Для обновления не создавайте новую карточку. Откройте Dev Studio > Версии > Добавить новую версию плагина, укажите новый номер, загрузите изменённый .js и отправьте его на модерацию. Пока идёт проверка, пользователям доступна предыдущая одобренная версия. После одобрения новая становится текущей. Номер уже одобренной версии повторно использовать нельзя.

Одобрение новой версии не заменяет код внутри уже открытого редактора. Пользователь устанавливает обновление и перезапускает BDEngine. Проверку перехода со старой версии на новую включайте в подготовку каждого выпуска.