插件命名惯例

概览

一致的插件名称有助于整理和搜索插件,以及在 npm 上查找已发布的插件。

本页面列出了我们的标准插件命名惯例。如果您的插件不属于任何类别,请使用页面末尾的通用插件命名格式。

建议您在 package.json 中添加建议的标记,以便在 npm 上更轻松地找到您的插件。

插件类型

字段

字段插件会发布单个自定义字段

加载字段插件会注册一种新的字段类型,该类型可用于网页上的所有 Blockly 工作区。

第一方 第三方 示例 建议的标签
@blockly/field-* blockly-field-* @blockly/field-slider blockly-pluginfield

主题

主题插件会发布单个 Blockly 主题

加载主题插件会定义一个新主题,然后该主题可用于网页上的所有 Blockly 工作区。

第一方 第三方 示例 建议的标签
@blockly/theme-* blockly-theme-* @blockly/theme-modern blockly-plugintheme

屏蔽

块插件会发布一个或多个块定义

加载块插件会为网页上的所有 Blockly 工作区定义这些块。

第一方 第三方 示例 建议的标签
@blockly/block(s)-* blockly-block(s)-* @blockly/blocks-plus-minus blockly-pluginblockblocks

屏蔽扩展程序

块扩展插件会发布一个或多个块扩展,这些扩展可用于以编程方式在块之间共享行为。

加载块扩展插件会注册扩展,以便在网页上的所有 Blockly 工作区中使用。

第一方 第三方 示例 建议的标签
@blockly/extension-* blockly-extension-* 尚无 blockly-pluginblock-extension

工作区

工作区插件可为单个工作区添加行为。

在 Blockly 工作区中初始化工作区插件之前,加载该插件不会执行任何操作。

第一方 第三方 示例 建议的标签
@blockly/workspace-* blockly-workspace-* 尚无 blockly-pluginworkspace

通用插件

这是最通用的插件类型。如果您的插件不符合任何其他插件类型的要求,请使用此命名惯例。

第一方 第三方 示例 建议的标签
@blockly/plugin-* blockly-plugin-* @blockly/plugin-modal blockly-plugin