ザクっと理解するsettings.gradle(.kts) – Gradle Android Kotlin
Gradleシリーズです。
なんとなく使っているGradleをザクっと理解できるように書いています。
前回はGradle Wrapperをザクっとご紹介しました。
今回はGradleの設定ファイルについてご紹介します。
Gradleの設定ファイル(Gradle settings file)とは
すべてのGradleプロジェクトのエントリーポイント(開始点)で、主な目的はビルドにサブプロジェクトを追加することです。
シングルプロジェクトの場合、設定ファイルは任意です。
一方、マルチプロジェクトの場合、設定ファイルは必須かつすべてのサブプロジェクトを宣言する必要があります。
設定ファイルの書き方
Kotlinで書く場合は「settings.gradle.kts」、Groovyで書く場合は「settings.gradle」という名前でファイルを作成する必要があります。
多くの場合、このファイルはプロジェクトのルートディレクトリに配置します。
rootProject.name = "root-project" // 1
include("sub-project-a") // 2
include("sub-project-b")
include("sub-project-c")rootProject.name = 'root-project' // 1
include('sub-project-a') // 2
include('sub-project-b')
include('sub-project-c')1. プロジェクト名の定義
rootProject.name = “root-project”
この行でプロジェクトの名前を定義しており、各ビルドに対してこの行は1つです。
2. サブプロジェクトの追加
設定ファイルにはサブプロジェクトを含めたプロジェクトの構成を定義します。
サブプロジェクトの定義は下記のように行い、複数のサブプロジェクトがある場合はその数だけ定義します。
include(“sub-project-name”)
おわりに
次回はBuild File(ビルドファイル)について解説します。
ご要望等がありましたらお気軽にコメントまでお願いします。
コメント