Android Studio の render-compose-preview

Android Studio で Compose プレビューをレンダリングします。

使用方法

android studio render-compose-preview [-h] [--output-image-file=PARAM] [--pid=PARAM] [--print-semantics] [--project=PARAM] <path> <composable>

オプション

  • -h,--help - 指定されたコマンドのヘルプ メッセージを表示します。
  • --output-image-file=PARAM - 結果の画像を書き込むファイル名。
  • --pid=PARAM - 接続する Android Studio インスタンスの PID。
  • --print-semantics - true の場合、セマンティクス ツリーを出力します。
  • --project=PARAM - クエリする Android Studio で開いているプロジェクトの名前またはパス。android studio check を使用して、使用可能なプロジェクトの名前を取得します。

android 個のオプション:

  • --sdk=PARAM - Android SDK へのパス。
  • -v,--verbose - トラブルシューティングの詳細出力を有効にします。
  • -V,--version - バージョン情報を出力して終了します。

位置引数

  • <path> - 現在のディレクトリを基準とする相対パスまたは絶対パスで指定された、Compose プレビューを含むファイルのパス。
  • <composable> - コンポーザブルの名前。

説明

android studio render-compose-preview は、Android Studio のレイアウト レンダリング エンジンを使用して Jetpack Compose の @Preview 関数をレンダリングし、必要に応じてアクセシビリティ セマンティクス ツリーを出力します。

Android Studio Quail 2 以降が必要です。

プレビュー出力(--output-image-file と --print-semantics)を設定する

  • --output-image-file: レンダリングされた PNG プレビューを指定されたファイルパスに保存します。省略すると、一時的な PNG ファイルが作成されます。
  • --print-semantics: Compose プレビューのアクセシビリティ セマンティクス ツリーを JSON 形式で出力します。これにより、AI エージェントはレンダリングされた視覚的イメージとともに、インタラクティブ ノード、テキスト、境界を検査できます。

例

HotelDetailScreenPreview を preview_hotel.png にレンダリングし、そのセマンティクス ツリーを出力します。

android studio render-compose-preview \
  --output-image-file=preview_hotel.png \
  --print-semantics \
  app/src/main/java/com/example/myapp/ui/DetailScreen.kt \
  HotelDetailScreenPreview