メインコンテンツまでスキップ

ComposeコンパイラーオプションDSL

ComposeコンパイラーのGradleプラグインは、さまざまなコンパイラーオプション用のDSLを提供します。 これを使用して、プラグインを適用するモジュールのbuild.gradle.ktsファイルのcomposeCompiler {}ブロックでコンパイラーを構成できます。

指定できるオプションには、次の2種類があります。

  • 一般的なコンパイラー設定。これは、特定のプロジェクトで必要に応じて無効または有効にできます。
  • 新しい実験的な機能を有効または無効にするフィーチャーフラグ。これらは最終的にベースラインの一部になるはずです。

利用可能な一般的な設定のリストと、 サポートされているフィーチャーフラグのリスト は、ComposeコンパイラーGradleプラグインのAPIリファレンスにあります。

構成例を次に示します。

composeCompiler {
   includeSourceInformation = true

   featureFlags = setOf(
           ComposeFeatureFlag.StrongSkipping.disabled(),
           ComposeFeatureFlag.OptimizeNonSkippingGroups
   )
}
注意

Gradleプラグインは、Kotlin 2.0より前に手動で指定されていたいくつかのComposeコンパイラーオプションのデフォルトを提供します。 たとえば、freeCompilerArgsで設定しているものがある場合、Gradleは重複オプションエラーを報告します。

フィーチャーフラグの目的と使用​

フィーチャーフラグは、新しいフラグが継続的にロールアウトおよび非推奨になるにつれて、トップレベルのプロパティへの変更を最小限に抑えるために、個別のオプションセットに編成されています。

デフォルトで無効になっているフィーチャーフラグを有効にするには、セットで指定します。例：

featureFlags = setOf(ComposeFeatureFlag.OptimizeNonSkippingGroups)

デフォルトで有効になっているフィーチャーフラグを無効にするには、そのdisabled()関数を呼び出します。例：

featureFlags = setOf(ComposeFeatureFlag.StrongSkipping.disabled())

Composeコンパイラーを直接構成する場合は、次の構文を使用してフィーチャーフラグを渡します。

-P plugin:androidx.compose.compiler.plugins.kotlin:featureFlag=<flag name>

サポートされているフィーチャーフラグのリスト を、ComposeコンパイラーGradleプラグインのAPIリファレンスで確認してください。