プラグインの命名規則

概要

一貫性のあるプラグイン名は、プラグインの整理と検索、npm での公開プラグインの検出に役立ちます。

このページでは、標準のプラグイン命名規則について説明します。プラグインがいずれのカテゴリにも当てはまらない場合は、ページの最後にある汎用的なプラグイン命名形式を使用します。

npm でプラグインを簡単に見つけられるように、package.json に推奨タグを追加することをおすすめします。

フィールドプラグインは、単一のカスタムフィールドをパブリッシュします。

フィールドプラグインを読み込むと、ページ上のすべての Blockly ワークスペースで使用できる新しいフィールドタイプが登録されます。

詳しくは、カスタムフィールドの作成をご覧ください。

Google	サードパーティ	例	タグの候補
`@blockly/field-*`	`blockly-field-*`	`@blockly/field-slider`	`blockly-plugin`、`field`

テーマプラグインは、単一の Blockly テーマを公開します。

テーマプラグインを読み込むと、ページ上のすべての Blockly ワークスペースで使用できる新しいテーマが定義されます。

詳しくは、テーマをご覧ください。

Google	サードパーティ	例	タグの候補
`@blockly/theme-*`	`blockly-theme-*`	`@blockly/theme-modern`	`blockly-plugin`、`theme`

ブロックプラグインは、1 つ以上のブロック定義をパブリッシュします。

ブロックプラグインを読み込むと、ページ上のすべての Blockly ワークスペースにこれらのブロックが定義されます。

詳しくは、カスタムブロックの作成をご覧ください。

Google	サードパーティ	例	タグの候補
`@blockly/block(s)-*`	`blockly-block(s)-*`	`@blockly/blocks-plus-minus`	`blockly-plugin`、`block`、`blocks`

ブロック拡張プラグインは、1 つ以上のブロック拡張機能を公開します。これを使用して、ブロック間で動作をプログラムで共有できます。

ブロック拡張プラグインを読み込むと、ページ上のすべての Blockly ワークスペースで使用する拡張機能が登録されます。

拡張機能の詳細をご覧ください。

Google	サードパーティ	例	タグの候補
`@blockly/extension-*`	`blockly-extension-*`	None yet	`blockly-plugin`,`block-extension`

ワークスペースプラグインを使用すると、1 つのワークスペースに動作が追加されます。

ワークスペースプラグインの読み込みは、Blockly ワークスペースで初期化されるまで何も行いません。

Google	サードパーティ	例	タグの候補
`@blockly/workspace-*`	`blockly-workspace-*`	None yet	`blockly-plugin`,`workspace`

これは最も一般的なプラグインタイプです。この命名規則は、プラグインが他の種類のプラグインの要件を満たしていない場合に使用します。

Google	サードパーティ	例	タグの候補
`@blockly/plugin-*`	`blockly-plugin-*`	`@blockly/plugin-modal`	`blockly-plugin`