Plugin Naming Conventions

🚧 ⚠️ Under construction ⚠️ 🚧

Fields: @blockly/field-*

• blockly-field-
• This naming convention is used for publishing a custom Blockly field. A field plugin publishes a single Blockly field.
• Example: @blockly/field-slider
• Loading a field plugin registers a new field type that can be used in all Blockly workspaces on the page.

Themes: @blockly/theme-*

• blockly-theme-
• This naming convention is used for Blockly themes, which are a type of plugin. A theme plugin publishes a single Blockly theme.
• Example: @blockly/theme-dark
• Loading a theme plugin registers a new theme that can be used in all Blockly workspaces on the page.

Blocks: @blockly/block(s)-*

• blockly-blocks-
• This naming convention is used for publishing a set of Blockly blocks. A block plugin publishes a number of - Blocks to be added to someone’s toolbox.
• Example: @blockly/blocks-stocks
• Loading a block plugin defines those blocks for all Blockly workspaces on the page.

Block Extensions.

• @blockly/block-extension-*??

Workspace: @blockly/workspace-*

• Example: @blockly/workspace-search

Generic Plugin: @blockly/plugin-

• This is the most general plugin type. Use this naming convention if your plugin doesn’t meet the requirements of any other plugin type.
• Example: @blockly/plugin-workspace-search, @blockly/plugin-modal

---

Talk

🐙 Needs cleanup: standardizing all descriptions into the same format. 🐙 Needs addition: links for examples 🐙 Needs addition: links to searches on npm for each category