Ga naar de inhoud

Schema

Om ontwikkeling met automatisch aanvullen en validatie in je IDE te verbeteren, introduceert Blockstudio een eigen schema:

Schema van Blockstudio bekijken

Het schema van Blockstudio is een (altijd actuele) kopie van het core-schema voor WordPress block.json, met een extra eigenschap blockstudio voor alle pluginfuncties, zoals veldschema’s. Zo staan deze los van mogelijke toekomstige core-eigenschappen.

Toevoegen aan JSON

Voeg eenvoudig een sleutel $schema met de waarde https://blockstudio.dev/schema/block toe aan je block.json, waarna je IDE suggesties zou moeten geven voor eigenschappen die specifiek zijn voor 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
}

IDE-ondersteuning

VS Code

VS Code haalt het schema automatisch op uit de eigenschap $schema.

Voeg voor instellingen voor de hele werkruimte het volgende toe aan .vscode/settings.json:

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

IDE’s van JetBrains

PhpStorm en andere IDE’s van JetBrains ondersteunen JSON Schema automatisch via de eigenschap $schema.

Beschikbare schema’s

Schema URL
Blokschema https://blockstudio.dev/schema/block
Uitbreidingsschema https://blockstudio.dev/schema/extend

Voordelen

  • Automatisch aanvullen: Krijg suggesties voor alle beschikbare eigenschappen
  • Validatie: Spoor fouten op voordat de code wordt uitgevoerd
  • Documentatie: Beweeg de muis over eigenschappen voor documentatie in de editor
  • Typeveiligheid: Zorg voor de juiste waardetypen