コンテンツへスキップ

レジストリのホスティング

レジストリは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は{baseUrl}/{block.name}/{file}からURLを組み立ててファイルを取得します。

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からブロックファイルをダウンロードするためです。