Build Settings

Compose Preview Lab の Gradle プラグインには、コード生成や Preview の収集方法を制御するための ビルド設定 (Build Settings) が用意されています。
このページでは、composePreviewLab { ... } ブロックで設定できる主なオプションと、その使いどころを解説します。

どこに書くのか？

composePreviewLab { ... } ブロックは Compose Preview Lab Gradle プラグインを適用したモジュール の build.gradle.kts に記述します。

plugins {
    id("me.tbsten.compose.preview.lab") version "<version>"
}

composePreviewLab {
    // ここに設定を追加する
}

1. generatePackage

生成される PreviewList / PreviewAllList のパッケージ名を指定します。

build.gradle.kts
composePreviewLab {
    // デフォルトはプロジェクト名から自動生成される (e.g. my-app -> myApp)
    generatePackage = "com.example.preview"
}

いつ変更する？

複数モジュールから共通の PreviewList をインポートしたい
生成されたクラスを特定のパッケージ配下にまとめたい
という場合に、明示的にパッケージ名を指定します。

2. generateFeaturedFiles

.composepreviewlab/featured/ ディレクトリから FeaturedFileList を生成するかどうかを制御します。
詳しくは Featured Files を参照してください。

デフォルトで false です。

composePreviewLab {
    // Featured Files 機能を使うときのみ true にする
    generateFeaturedFiles = true
}

Featured Files を使うときの典型パターン

.composepreviewlab/featured/ にグループごとのテキストファイルを作る
generateFeaturedFiles = true を有効にする
生成された FeaturedFileList を previewLabApplication(...) に渡す

1. generatePackage​

2. generateFeaturedFiles​

1. generatePackage

2. generateFeaturedFiles