Preskočiť na obsah

Schéma

Na zlepšenie vývoja pomocou automatického dopĺňania a validácie v IDE zavádza Blockstudio vlastnú schému:

Zobrazenie Blockstudioschémy

Schéma Blockstudio je (vždy aktuálnou) kópiou základnej schémy WordPress block.json s dodatočnou vlastnosťou blockstudio, v ktorej sú uložené všetky funkcie pluginu, napríklad schémy polí, bez zasahovania do prípadných budúcich základných vlastností.

Pridať do JSON

Jednoducho pridajte kľúč $schema s hodnotou https://blockstudio.dev/schema/block do súboru block.json a vaše IDE by malo začať zobrazovať návrhy pre vlastnosti špecifické pre Blockstudio.

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/native",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio block.",
  "blockstudio": true
}

Podpora IDE

VS Code

VS Code automaticky načíta schému z vlastnosti $schema.

Ak chcete nastavenia pre celý pracovný priestor, pridajte ich do .vscode/settings.json:

JSON
{
  "json.schemas": [
    {
      "fileMatch": ["**/block.json"],
      "url": "https://blockstudio.dev/schema/block"
    }
  ]
}

IDE JetBrains

PhpStorm a ďalšie IDE JetBrains podporujú JSON Schema automaticky prostredníctvom vlastnosti $schema.

Dostupné schémy

Schéma URL
Schéma bloku https://blockstudio.dev/schema/block
Schéma rozšírenia https://blockstudio.dev/schema/extend

Výhody

  • Automatické dopĺňanie: Získajte návrhy všetkých dostupných vlastností
  • Validácia: Zachyťte chyby ešte pred spustením
  • Dokumentácia: Umiestnením kurzora nad vlastnosť zobrazíte jej dokumentáciu priamo v editore
  • Typová bezpečnosť: Zaistite správne typy hodnôt