跳转到正文

托管注册表

注册表由一个 registry.json 文件和一组通过 HTTP 提供的区块文件夹组成。无需专用服务器,任何能够提供静态文件的服务都可以使用。

所需内容

  1. 一个列出区块的 registry.json 文件
  2. 包含清单中所引用文件的区块文件夹
  3. 一个能够提供这两者的 Web 服务器或托管服务

目录结构

典型的注册表代码库结构如下:

代码
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 下载区块文件。