Перейти к содержимому

Схема

Чтобы упростить разработку с автодополнением и проверкой в IDE, Blockstudio вводит собственную схему:

Просмотреть схему Blockstudio

Схема Blockstudio — это (всегда актуальная) копия базовой схемы WordPress для block.json с дополнительным свойством blockstudio, в котором хранятся все возможности плагина, например схемы полей, не мешая добавлению будущих свойств ядра.

Добавление в JSON

Просто добавьте ключ $schema со значением https://blockstudio.dev/schema/block в block.json, и IDE начнет подсказывать свойства, относящиеся к 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

VS Code

VS Code автоматически получает схему из свойства $schema.

Чтобы применить настройки ко всей рабочей области, добавьте их в .vscode/settings.json:

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

IDE JetBrains

PhpStorm и другие IDE JetBrains автоматически поддерживают Schema JSON через свойство $schema.

Доступные схемы

Схема URL
Схема блока https://blockstudio.dev/schema/block
Схема расширения https://blockstudio.dev/schema/extend

Преимущества

  • Автодополнение: подсказки для всех доступных свойств
  • Проверка: выявление ошибок до выполнения программы
  • Документация: встроенная документация при наведении на свойства
  • Безопасность типов: проверка соответствия типов значений