Conventions de nommage des plug-ins

Présentation

Des noms de plug-ins cohérents sont utiles pour organiser et rechercher des plug-ins, et pour trouver des plug-ins publiés sur npm.

Cette page liste nos conventions standards de nommage des plug-ins. Si votre plug-in ne correspond à aucune de ces catégories, utilisez le format de nommage générique des plug-ins à la fin de la page.

Nous vous recommandons d'ajouter les tags suggérés dans votre package.json pour faciliter la recherche de votre plug-in sur npm.

Types de plug-ins

Champ

Un plug-in de champ publie un seul champ personnalisé.

Le chargement d'un plug-in de champ enregistre un nouveau type de champ qui peut être utilisé dans tous les espaces de travail Blockly de la page.

Interne Tiers Exemple Suggestions de tags
@blockly/field-* blockly-field-* @blockly/field-slider blockly-plugin, field

Thème

Un plug-in de thème publie un seul thème Blockly.

Le chargement d'un plug-in de thème définit un nouveau thème qui peut ensuite être utilisé dans tous les espaces de travail Blockly de la page.

Interne Tiers Exemple Suggestions de tags
@blockly/theme-* blockly-theme-* @blockly/theme-modern blockly-plugin, theme

Bloquer

Un plug-in de bloc publie une ou plusieurs définitions de bloc.

Le chargement d'un plug-in de bloc définit ces blocs pour tous les espaces de travail Blockly de la page.

Interne Tiers Exemple Suggestions de tags
@blockly/block(s)-* blockly-block(s)-* @blockly/blocks-plus-minus blockly-plugin, block, blocks

Bloquer une extension

Un plug-in d'extension de bloc publie une ou plusieurs extensions de bloc, qui peuvent être utilisées pour partager de manière programmatique le comportement entre les blocs.

Le chargement d'un plug-in d'extension de bloc enregistre les extensions pour une utilisation sur tous les espaces de travail Blockly de la page.

Interne Tiers Exemple Suggestions de tags
@blockly/extension-* blockly-extension-* Aucune pour l'instant blockly-plugin,block-extension

Espace de travail

Un plug-in d'espace de travail ajoute un comportement à un seul espace de travail.

Le chargement d'un plug-in d'espace de travail n'a aucun effet tant qu'il n'est pas initialisé dans un espace de travail Blockly.

Interne Tiers Exemple Suggestions de tags
@blockly/workspace-* blockly-workspace-* Aucune pour l'instant blockly-plugin,workspace

Plug-in générique

Il s'agit du type de plug-in le plus général. Utilisez cette convention de dénomination si votre plug-in ne répond aux exigences d'aucun autre type de plug-in.

Interne Tiers Exemple Suggestions de tags
@blockly/plugin-* blockly-plugin-* @blockly/plugin-modal blockly-plugin