跳到主要内容

添加组件

blocklet add 命令用于将一个新组件作为依赖项添加到你的 blocklet 中。它会自动更新你的 blocklet.yml 文件中的 components 部分，并添加必要的配置。

该命令通过从指定的 blocklet store 或直接的 URL 获取组件的元数据来简化依赖管理，确保所有必需信息都正确添加到你的项目配置中。

命令语法

add 命令的基本语法如下：

bash
blocklet add <component> [options]

参数

  • string (required) — 要添加的组件的标识符。可以通过以下几种格式指定： - 按名称和版本：component-name@1.2.3。如果省略版本（例如 component-name），则默认为 latest。 - 按 DID：z8...（blocklet 的去中心化标识符）。 - 按 URL：指向组件 blocklet.json 元数据文件的直接 URL（例如 https://example.com/path/to/blocklet.json）。

选项

以下选项可用于自定义组件的添加方式：

  • --store string — 指定用于搜索组件的 blocklet store 的 URL。如果未提供，该命令将使用 Blocklet CLI 配置文件中配置的 store，若无则回退到默认的官方 blocklet store。
  • --title string — 在 blocklet.yml 中为组件设置自定义标题。如果省略，将使用组件自身元数据中的标题。
  • --mount-point string — 定义组件将被挂载的 URL 路径。如果未指定，将根据组件名称的 URL 友好版本生成一个默认挂载点（例如 /component-name）。
  • --profile string — 选择一个特定的配置 profile，用于设置（如默认 blocklet store）等。

使用示例

以下是一些如何使用 blocklet add 命令的实际示例。

从默认 Store 添加组件

要从默认的 blocklet store 中添加名为 did-wallet 的组件的最新版本：

bash
blocklet add did-wallet

要添加组件的特定版本：

bash
blocklet add did-wallet@1.6.0

运行该命令后，你的 blocklet.yml 将被更新，并添加一条类似这样的新条目：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: DID Wallet
    mountPoint: /did-wallet
    source:
      store: 'https://store.blocklet.dev'
      name: did-wallet
      version: 1.6.0

从 URL 添加组件

如果组件不在 store 中，你可以直接从其元数据 URL 添加。

bash
blocklet add https://github.com/arcblock/did-wallet/releases/download/v1.6.25/blocklet.json

这将在你的 blocklet.yml 中添加一个直接指向该 URL 的条目：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: DID Wallet
    mountPoint: /did-wallet
    source:
      url: 'https://github.com/arcblock/did-wallet/releases/download/v1.6.25/blocklet.json'

使用自定义选项添加组件

你可以覆盖组件的默认标题和挂载点。

bash
blocklet add did-wallet --title "My Custom Wallet" --mount-point "/my-wallet"

blocklet.yml 中生成的配置将反映这些自定义值：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: My Custom Wallet
    mountPoint: /my-wallet
    source:
      store: 'https://store.blocklet.dev'
      name: did-wallet
      version: latest

总结

blocklet add 命令是管理 blocklet 项目中依赖关系的关键工具。它能自动更新 blocklet.yml 文件，确保一致性并减少手动出错的机会。要移除依赖项，你可以使用相应的 blocklet remove 命令。