Gå til indhold

Schema

For at forbedre udviklingen med autofuldførelse og validering i dit IDE introducerer Blockstudio sit eget schema:

Se Blockstudio-schema

Blockstudio-schemaet er en (altid opdateret) kopi af WordPresss kerne-block.json-schema med en ekstra blockstudio-egenskab, der indeholder alle pluginfunktioner, såsom feltschemaer, uden at påvirke potentielle fremtidige kerneegenskaber.

Føj til JSON

Føj blot en nøgle af typen $schema med værdien https://blockstudio.dev/schema/block til din block.json, så burde dit IDE begynde at foreslå egenskaber, der er specifikke for 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-understøttelse

VS Code

VS Code finder automatisk schemaet via egenskaben $schema.

Føj det til .vscode/settings.json for indstillinger, der gælder hele arbejdsområdet:

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

IDE’er fra JetBrains

PhpStorm og andre IDE’er fra JetBrains understøtter JSON Schema automatisk via egenskaben $schema.

Tilgængelige schemaer

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

Fordele

  • Autofuldførelse: Få forslag til alle tilgængelige egenskaber
  • Validering: Find fejl før kørsel
  • Dokumentation: Hold markøren over egenskaber for at se dokumentation direkte
  • Typesikkerhed: Sørg for, at værdierne har de rigtige typer