Соглашения об именовании плагинов

Обзор

Единообразные названия плагинов полезны для организации и поиска плагинов, а также для поиска опубликованных плагинов в npm.

На этой странице представлены наши стандартные правила именования плагинов. Если ваш плагин не подходит ни под одну из категорий, используйте общий формат именования плагинов, указанный в конце страницы.

Мы рекомендуем вам добавить предлагаемые теги в ваш package.json , чтобы упростить поиск вашего плагина в npm.

Типы плагинов

Поле

Плагин поля публикует одно пользовательское поле .

Загрузка плагина поля регистрирует новый тип поля, который можно использовать во всех рабочих областях Blockly на странице.

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/field-* blockly-field-* @blockly/field-slider blockly-plugin , field

Тема

Плагин темы публикует одну тему Blockly.

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

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/theme-* blockly-theme-* @blockly/theme-modern blockly-plugin , theme

Блокировать

Плагин блока публикует одно или несколько определений блока .

Загрузка плагина блока определяет эти блоки для всех рабочих пространств Blockly на странице.

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/block(s)-* blockly-block(s)-* @blockly/blocks-plus-minus blockly-plugin , block , blocks

Расширение блока

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

Загрузка плагина расширения блока регистрирует расширения для использования во всех рабочих пространствах Blockly на странице.

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/extension-* blockly-extension-* Пока нет blockly-plugin , block-extension

Рабочее пространство

Плагин рабочего пространства добавляет поведение к одному рабочему пространству.

Загрузка плагина рабочего пространства не приводит ни к чему, пока он не будет инициализирован в рабочем пространстве Blockly.

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/workspace-* blockly-workspace-* Пока нет blockly-plugin , workspace

Универсальный плагин

Это наиболее распространённый тип плагинов. Используйте это правило именования, если ваш плагин не соответствует требованиям ни одного другого типа плагинов.

Первая партия Третья сторона Пример Предлагаемые теги
@blockly/plugin-* blockly-plugin-* @blockly/plugin-modal blockly-plugin