Vai al contenuto

Schema

Per migliorare lo sviluppo con il completamento automatico e la convalida nell’IDE, Blockstudio introduce un proprio schema:

Visualizza lo schema Blockstudio

Lo schema Blockstudio è una copia (sempre aggiornata) dello schema WordPress core block.json, con una proprietà aggiuntiva blockstudio che contiene tutte le funzionalità del plugin, come gli schemi dei campi, senza interferire con eventuali proprietà core future.

Aggiungere a JSON

Aggiungete semplicemente una chiave $schema con valore https://blockstudio.dev/schema/block al vostro block.json e l’IDE dovrebbe iniziare a suggerirvi le proprietà specifiche di 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
}

Supporto IDE

VS Code

VS Code rileva automaticamente lo schema dalla proprietà $schema.

Per le impostazioni dell’intero spazio di lavoro, aggiungete a .vscode/settings.json:

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

IDE JetBrains

PhpStorm e altri IDE JetBrains supportano automaticamente lo schema JSON tramite la proprietà $schema.

Schemi disponibili

Schema URL
Schema del blocco https://blockstudio.dev/schema/block
Schema dell’estensione https://blockstudio.dev/schema/extend

Vantaggi

  • Completamento automatico: ricevete suggerimenti per tutte le proprietà disponibili
  • Convalida: individuate gli errori prima dell’esecuzione
  • Documentazione: passate il puntatore sulle proprietà per visualizzare la documentazione in linea
  • Sicurezza dei tipi: assicuratevi che i valori abbiano il tipo corretto