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

Размещение реестра

Реестр состоит из файла registry.json и набора каталогов блоков, доступных по HTTP. Специальный сервер не нужен: подойдет любой сервер, который умеет раздавать статические файлы.

Что потребуется

  1. Файл registry.json со списком блоков
  2. Каталоги блоков с файлами, указанными в манифесте
  3. Веб-сервер или хостинг, который раздает и то и другое

Структура каталогов

Типичный репозиторий реестра выглядит так:

Код
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

registry.json указывает на каталог blocks/ как на свой baseUrl:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Требования

Хостинг должен обеспечивать прямой доступ к файлам через URL. CLI загружает файлы, формируя URL из {baseUrl}/{block.name}/{file}.

У CLI нет собственного процесса входа. Для частных реестров настройте контроль доступа на уровне хостинга (e.g. частные репозитории GitHub с токенами или сервер, проверяющий учетные данные), а потребителям передавайте учетные данные в пользовательских заголовках через формат объекта в документацииblocks.json.

Проверка реестра

Перед публикацией проверьте работу локально, запустив простой сервер HTTP:

Командная оболочка
cd my-registry
npx serve .

Затем укажите blocks.json адрес http://localhost:3000/registry.json и запустите npx blockstudio list, чтобы проверить, что все данные доступны. list загружает только registry.json. Чтобы проверить add, на время проверки задайте baseUrl значение http://localhost:3000/blocks, поскольку CLI загружает файлы блоков из baseUrl.