跳转到正文

自定义服务器

如果 GitHub 不符合你的需求,你可以使用任何 HTTP 服务器托管注册表。唯一要求是,registry.json 和区块文件都可以通过各自的 URL 访问。

静态文件服务器

最简单的方案。将 registry.json 和 blocks/ 文件夹放到任何静态托管服务上:

  • Nginx/Apache:直接提供该目录
  • Vercel/Netlify:将该目录部署为静态网站
  • S3/R2/GCS:将文件上传到可公开访问的存储桶
  • CDN:将文件置于 Cloudflare、Fastly 或任何 CDN 之后

CLI 只需通过 GET 访问文件。无需 API,无需动态路由,也无需服务器端逻辑。

动态服务器

如果你想动态生成 registry.json(例如 e.g 从数据库生成,或添加访问控制),可以构建一个简单的 API:

代码
GET /registry.json          -> returns the registry manifest
GET /blocks/{name}/{file}   -> returns the block file content

当区块清单中的文件位于子目录时,{file} 可以包含斜杠(src/script.js),因此文件路由必须匹配嵌套路径。

CLI并不关心这些端点是如何实现的。它会发出普通的 GET请求,并期望响应正文就是文件内容。

示例:Express

JavaScript
const express = require('express');
const path = require('path');

const app = express();

app.get('/registry.json', (req, res) => {
  res.sendFile(path.join(__dirname, 'registry.json'));
});

app.use('/blocks', express.static(path.join(__dirname, 'blocks')));

app.listen(3000);

示例:PHP

PHP
<?php
$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);

if ($path === '/registry.json') {
    header('Content-Type: application/json');
    readfile(__DIR__ . '/registry.json');
    exit;
}

if (preg_match('#^/blocks/([^/]+)/(.+)$#', $path, $matches)) {
    $file = __DIR__ . '/blocks/' . $matches[1] . '/' . $matches[2];
    if (file_exists($file)) {
        readfile($file);
        exit;
    }
}

http_response_code(404);

CORS

如果 CLI 运行在需要关注 CORS 的环境中(对于 Node.js CLI 来说不太可能,但未来基于 Web 的工具也可能遇到这种情况),请确保服务器发送了 适当的 Access-Control-Allow-Origin 标头。

缓存

CLI 会在单次命令运行期间将获取的 registry.json 文件缓存在内存中。缓存不会跨运行保留。如果要优化大型注册表,请在服务器响应中添加标准的 HTTP 缓存标头 (Cache-Control、ETag)。

内部/企业注册表

适合希望在团队内部共享区块的团队:

  1. 将注册表托管在内部服务器上,或托管在可通过 VPN 访问的 URL 上
  2. 每位开发者都将注册表 URL 添加到其项目的 blocks.json 中
  3. CLI 会像访问其他注册表一样,从该 URL 获取内容

无需特殊设置。只要开发者的计算机能够访问 URL,就可以正常使用。