Przejdź do treści

Schemat

Aby ułatwić programowanie dzięki autouzupełnianiu i walidacji w IDE, Blockstudio wprowadza własny schemat:

Wyświetl schemat Blockstudio

Schemat Blockstudio to zawsze aktualna kopia podstawowego schematu WordPress block.json z dodatkową właściwością blockstudio, która zawiera wszystkie funkcje wtyczki, takie jak schematy pól, i nie koliduje z potencjalnymi przyszłymi właściwościami podstawowymi.

Dodawanie do JSON

Po prostu dodaj klucz $schema z wartością https://blockstudio.dev/schema/block do pliku block.json, a IDE powinno zacząć podpowiadać właściwości specyficzne dla 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
}

Obsługa IDE

VS Code

VS Code automatycznie wykrywa schemat na podstawie właściwości $schema.

W przypadku ustawień całego obszaru roboczego dodaj wpis do .vscode/settings.json:

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

IDE JetBrains

PhpStorm i inne IDE JetBrains automatycznie obsługują schemat JSON za pośrednictwem właściwości $schema.

Dostępne schematy

Schemat URL
Schemat bloku https://blockstudio.dev/schema/block
Schemat rozszerzenia https://blockstudio.dev/schema/extend

Korzyści

  • Autouzupełnianie: Otrzymuj podpowiedzi dotyczące wszystkich dostępnych właściwości
  • Walidacja: Wykrywaj błędy przed uruchomieniem
  • Dokumentacja: Najedź kursorem na właściwości, aby wyświetlić dokumentację w tekście
  • Bezpieczeństwo typów: Upewnij się, że typy wartości są prawidłowe