Kotlin .gitignore テンプレート解説

Kotlin.gitignore は Java テンプレートのルールに、Kotlin Gradle プラグインが使う .kotlin/ ディレクトリを加えた形である。Kotlin/JVM のコードをコンパイルすると Java と同じ .class・.jar が出力されるためである。

ビルドツールのルールは含まれていない。ほとんどの Kotlin プロジェクトは Gradle を使うため Gradle テンプレートを、Android アプリなら Android テンプレートを一緒に選ぶ。

ルール別の解説

パターン	何を、なぜ無視するか
.kotlin/	Kotlin Gradle プラグインのデータKotlin 2.0 から、Gradle プラグインはプロジェクトルートの .kotlin フォルダーにセッション情報やエラーログなどのデータを保存する。Kotlin のドキュメントもこのフォルダーを .gitignore に追加するよう案内している。
*.class*.jar*.war*.nar*.ear*.zip*.tar.gz*.rar	コンパイル結果・アーカイブJVM バイトコードと配布アーカイブである。ソースとビルドスクリプトさえあれば作り直せる。
hs_err_pid*replay_pid*	JVM クラッシュログJVM の異常終了時に残る診断ファイルである。
*.log*.ctxt.mtj.tmp/	その他実行ログと BlueJ・J2ME のツールファイルである。Java テンプレートからそのまま引き継いだルールである。

実務での注意点

• *.jar によって Gradle ラッパーの jar が無視されないよう、Gradle テンプレートを Kotlin の後に 置き、!gradle-wrapper.jar が最後に適用されるようにする。
• Kotlin Multiplatform で iOS ターゲットを使うなら、Xcode・Swift 関連のルールと macOS テンプレートも必要である。
• IntelliJ IDEA の設定は JetBrains テンプレートで扱う。

元のテンプレート

# Compiled class file*.class# Log file*.log# BlueJ files*.ctxt# Mobile Tools for Java (J2ME).mtj.tmp/# Package Files #*.jar*.war*.nar*.ear*.zip*.tar.gz*.rar# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xmlhs_err_pid*replay_pid*# Kotlin Gradle plugin data, see https://kotlinlang.org/docs/whatsnew20.html#new-directory-for-kotlin-data-in-gradle-projects.kotlin/

一緒に使うテンプレート

ほかのテンプレートの解説