Zum Inhalt springen

Schema

Um die Entwicklung mit Autovervollständigung und Validierung in deiner IDE zu verbessern, führt Blockstudio ein eigenes Schema ein:

Blockstudio-Schema ansehen

Das Blockstudio-Schema ist eine (stets aktuelle) Kopie des WordPress-Kernschemas für block.json, ergänzt um eine Eigenschaft blockstudio, die alle Plugin-Funktionen wie Feldschemas enthält, ohne potenzielle zukünftige Kerneigenschaften zu beeinträchtigen.

Zu JSON hinzufügen

Füge einfach einen Schlüssel $schema mit dem Wert https://blockstudio.dev/schema/block zu deiner Datei block.json hinzu. Deine IDE sollte dir dann Hinweise zu Blockstudio-spezifischen Eigenschaften geben.

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-Unterstützung

VS Code

VS Code übernimmt das Schema automatisch aus der Eigenschaft $schema.

Füge für arbeitsbereichsweite Einstellungen Folgendes zu .vscode/settings.json hinzu:

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

JetBrains-IDEs

PhpStorm und andere JetBrains-IDEs unterstützen JSON Schema automatisch über die Eigenschaft $schema.

Verfügbare Schemas

Schema URL
Blockschema https://blockstudio.dev/schema/block
Erweiterungsschema https://blockstudio.dev/schema/extend

Vorteile

  • Autovervollständigung: Erhalte Vorschläge für alle verfügbaren Eigenschaften
  • Validierung: Erkenne Fehler vor der Laufzeit
  • Dokumentation: Bewege den Mauszeiger über Eigenschaften, um eine Dokumentation direkt im Editor anzuzeigen
  • Typsicherheit: Stelle sicher, dass die Werte den richtigen Typ haben