メインコンテンツへスキップ

コンポーネントの追加

blocklet add コマンドは、新しいコンポーネントをブロックレットの依存関係として追加します。blocklet.yml ファイルの components セクションを必要な設定で自動的に更新します。

blocklet add コマンドは、新しいコンポーネントをブロックレットの依存関係として追加します。blocklet.yml ファイルの components セクションを必要な設定で自動的に更新します。

このコマンドは、指定されたブロックレットストアまたは直接URLからコンポーネントのメタデータを取得することで依存関係の管理を簡素化し、必要なすべての情報がプロジェクト設定に正しく追加されることを保証します。

コマンド構文

add コマンドの基本構文は次のとおりです。

bash
blocklet add <component> [options]

引数

  • string (required) — 追加したいコンポーネントの識別子です。これはいくつかの形式で指定できます。 - 名前とバージョン: component-name@1.2.3。バージョンが省略された場合(例:component-name)、デフォルトは latest になります。 - DID: z8... (ブロックレットの分散型識別子)。 - URL: コンポーネントの blocklet.json メタデータファイルへの直接URL(例:https://example.com/path/to/blocklet.json)。

オプション

コンポーネントの追加方法をカスタマイズするために、以下のオプションが利用できます。

  • --store string — コンポーネントを検索するブロックレットストアのURLを指定します。提供されない場合、コマンドはBlocklet CLIプロファイルで設定されたストアを使用し、デフォルトの公式ブロックレットストアにフォールバックします。
  • --title string — blocklet.yml 内のコンポーネントにカスタムタイトルを設定します。省略された場合、コンポーネント自身のメタデータからのタイトルが使用されます。
  • --mount-point string — コンポーネントがマウントされるURLパスを定義します。指定されない場合、コンポーネントのURLフレンドリーな名前に基づいてデフォルトのマウントポイントが生成されます(例:/component-name)。
  • --profile string — デフォルトのブロックレットストアなどの設定に使用する特定の構成プロファイルを選択します。

使用例

blocklet add コマンドの使用方法に関するいくつかの実用的な例を以下に示します。

デフォルトストアからコンポーネントを追加

デフォルトのブロックレットストアから 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からコンポーネントを追加

コンポーネントがストアにない場合、メタデータ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.yml ファイルの更新プロセスを自動化し、一貫性を確保し、手動エラーの可能性を減らします。依存関係を削除するには、対応する blocklet remove コマンドを使用できます。