跳到主要内容

开发模式

blocklet dev 命令是本地开发的关键工具。它以实时重新加载的开发模式运行您的 blocklet,并将其连接到正在运行的 Blocklet Server 实例。这通过自动处理 blocklet 作为临时组件的安装、启动和日志流,实现了快速迭代。

当您运行此命令时,它会执行以下几个关键操作:

  1. 连接到服务器

    它首先确保本地 Blocklet Server 正在运行并建立连接。

  2. 作为组件安装

    它将您当前工作目录中的 blocklet 作为“开发”模式的组件安装到 Blocklet Server 中。如果指定了父应用程序,它将安装在该应用程序内;否则,将创建一个新的容器应用程序。

  3. 启动 Blocklet

    它启动 blocklet 及任何必要的服务。

  4. 推送日志流

    它将 blocklet 的日志直接通过管道传输到您的终端,以供实时反馈。

  5. 提供访问 URL

    它输出您可以访问正在运行的 blocklet 的 URL。

  6. 自动清理

    当您终止命令(例如,使用 Ctrl+C)时,它会自动移除开发组件并清理环境。

这个集成过程简化了开发周期,让您能够专注于编码,而 CLI 会管理运行时环境。

Develop Mode

命令用法

进入开发模式的主要命令是 blocklet dev

bash
blocklet dev

此命令会安装并启动当前目录中的 blocklet。

子命令

dev 命令还包含几个子命令,用于管理开发生命周期,而无需启动完整的开发会会话。

CommandDescription
blocklet dev install以开发模式安装 blocklet,但不启动它。用于预先配置环境。
blocklet dev remove移除先前以开发模式安装的 blocklet。
blocklet dev reset重置 blocklet 的数据,清除其状态而无需完全重新安装。
blocklet dev faucet为 blocklet 的钱包从已配置的测试网水龙头领取令牌。
blocklet dev studio在浏览器中为指定的 blocklet 打开组件工作室。

选项

您可以使用以下选项自定义 dev 命令的行为:

  • --app-did string — 指定要将 blocklet 安装到的现有父应用程序的 DID。如果省略,将为 blocklet 创建一个新的应用程序容器。
  • --mount-point string — 定义 blocklet 组件将挂载到的 URL 路径(例如 /my-blocklet)。使用 --app-did 时为必需项。
  • --open boolean — 启动后,在默认 Web 浏览器中自动打开 blocklet 的访问 URL。
  • --store-url string — 指定一个组件商店 URL 以解析组件依赖。覆盖默认的商店 URL。
  • --start-all-components boolean — 在大型应用程序中开发组件时,此标志将启动该应用程序中的所有其他组件,而不仅仅是正在开发的组件。
  • --host string — 使用 faucet 子命令时,指定水龙头主机的 URL。
  • --token string — 使用 faucet 子命令时,指定要从水龙头请求的令牌地址或符号。

先决条件

在使用 blocklet dev 之前,您必须在本地运行一个 Blocklet Server 实例。如果服务器未运行,该命令将失败。

您可以使用以下命令启动服务器:

bash
blocklet server start

更多详情,请参阅启动服务器文档。

示例

基本开发

要开始开发位于当前目录中的 blocklet,只需运行:

bash
blocklet dev --open

CLI 将安装并启动 blocklet,将其日志推送到您的控制台,并在浏览器中打开其 URL。

为现有应用程序开发组件

如果您正在开发的 blocklet 旨在成为一个更大应用程序的组件,您可以指定父应用程序的 DID 和一个挂载点。

bash
blocklet dev --app-did zNKe4B62j5e9i6rWzM9adcee19s323j4s2pG --mount-point /my-component

此命令将:

  1. 找到具有指定 DID(zNKe...)的应用程序。
  2. 将您的本地 blocklet 作为组件安装到该应用程序中。
  3. 使其在该应用程序主 URL 的相对路径 /my-component 上可访问。

重置 Blocklet 数据

如果您需要清除与开发中的 blocklet 相关的所有数据和状态以测试全新的安装流程,请使用 reset 子命令。

bash
blocklet dev reset

这比移除并重新安装 blocklet 要快得多。

总结

blocklet dev 命令是本地 blocklet 开发的基石,提供了一个无缝且高效的工作流程。它弥合了您的本地源代码和实时 Blocklet Server 环境之间的差距。

在本地迭代之后,接下来的步骤是打包您的 blocklet 以进行分发。更多信息,请参阅关于打包与版本管理的文档。