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

配布とリンク

このセクションでは、blocklet.yml内のフィールドについて説明します。これらのフィールドは、blockletが配布用にパッケージ化される方法を定義し、ソースコード、ホームページ、ドキュメント、その他のリソースへの重要なリンクを提供します。これらのフィールドを適切に設定することは、発見可能性、

このセクションでは、blocklet.yml内のフィールドについて説明します。これらのフィールドは、blockletが配布用にパッケージ化される方法を定義し、ソースコード、ホームページ、ドキュメント、その他のリソースへの重要なリンクを提供します。これらのフィールドを適切に設定することは、発見可能性、ユーザーの信頼、Blockletエコシステムへの統合にとって非常に重要です。

配布パッケージ (dist)

dist オブジェクトには、blockletのバンドルされたパッケージに関する情報が含まれています。このデータは通常、blocklet publish コマンドによって自動的に生成および追加され、Blocklet Storeがblockletをダウンロードして検証するために使用します。

これにより、ユーザーがインストールするblockletパッケージの完全性と信頼性が保証されます。

スキーマ

  • dist object — blockletのバンドルされたパッケージに関する情報を含みます。
    • tarball string (required) — 圧縮されたblockletバンドル(.tar.gz)をダウンロードできるURL。
    • integrity string (required) — ダウンロードされたパッケージの内容を検証するためのサブリソース完全性文字列（例：SHA-512ハッシュ）。
    • size number — tarballのサイズ（バイト単位）。

例

blocklet.yml

yaml
# このフィールドは通常、公開プロセス中に自動生成されます
dist:
  tarball: https://store.blocklet.dev/uploads/z123abc.tar.gz
  integrity: sha512-Vbf...Q==
  size: 1234567

ソースコードリポジトリ (repository)

repository フィールドは、blockletのソースコードの場所を指定します。これにより、ユーザーや貢献者がコードを確認し、問題を報告し、貢献できるようになるため、強く推奨されます。

単純なURL文字列またはより詳細なオブジェクトを提供できます。

スキーマ

  • repository string | object — blockletのソースコードの場所を指定します。
    • type string (required) — バージョン管理システムのタイプ（例：「git」、「https」、「svn」）。
    • url string (required) — リポジトリのURL。
    • directory string — モノレポ内のblockletパッケージへのパス。

例：単純なURL

文字列を提供すると、リポジトリのタイプを決定するために自動的に解析されます。

blocklet.yml

yaml
repository: https://github.com/arcblock/blocklet-spec.git

例：オブジェクト形式

オブジェクト形式を使用すると、モノレポの場合や、より明示的にする必要がある場合に便利です。

blocklet.yml

yaml
repository:
  type: git
  url: https://github.com/arcblock/blocklet-framework.git
  directory: packages/blocklet-spec

Webリンクとサポート

これらのフィールドは、重要な外部リソースへの直接リンクを提供し、ユーザーサポートとコミュニティエンゲージメントを強化します。

  • homepage string — blockletの公式ホームページまたはマーケティングページ。
  • documentation string — blockletの詳細なドキュメントサイトへのリンク。
  • community string — コミュニティフォーラム、Discordサーバー、またはその他のディスカッションプラットフォームへのリンク。
  • support string — ユーザーがヘルプを得るためのURLまたはメールアドレス。

例

blocklet.yml

yaml
homepage: https://www.arcblock.io/
documentation: https://docs.arcblock.io/
community: https://community.arcblock.io/
support: support@arcblock.io

プロモーションアセット

これらのフィールドは、Blocklet Storeでblockletを紹介するために使用され、ユーザーにその機能や機能の視覚的なプレビューを提供します。

  • screenshots string[] — blockletのUIや機能を紹介する画像へのURLの配列。
  • videos string[] — プロモーションビデオ用の最大3つのURLの配列。YouTubeとVimeoのリンクのみがサポートされています。
  • logoUrl string — blockletのロゴへの直接URL。これは通常、公開プロセスによって生成およびアップロードされます。

例

blocklet.yml

yaml
screenshots:
  - https://meta.blocklet.dev/screenshots/1.png
  - https://meta.blocklet.dev/screenshots/2.png
videos:
  - https://www.youtube.com/watch?v=xxxxxxxx
logoUrl: https://meta.blocklet.dev/logo.png

使用統計 (stats)

stats オブジェクトには、blockletの使用状況メトリクスが含まれています。dist フィールドと同様に、これは通常Blocklet Storeによって管理され、手動で設定するべきではありません。

スキーマ

  • stats object — Blocklet Storeによって管理される、blockletの使用状況メトリクスを含みます。
    • downloads number — blockletがダウンロードされた総回数。
    • star number (default: 0) — blockletが受け取ったスターまたは賛成票の数。
    • purchases number (default: 0) — blockletが購入された回数。

例

blocklet.yml

yaml
# このフィールドはBlocklet Storeによって管理されます
stats:
  downloads: 10500
  star: 250
  purchases: 120

これらのフィールドを設定すると、blockletは配布の準備が整います。次のステップは、その実行方法を定義することです。

次へ：実行と環境

blockletのエンジン、ランタイム要件、環境変数、および起動スクリプトの設定方法を学びます。

続きを読む