github/gitignore · Kotlin.gitignore
Kotlin .gitignore 模板详解
说明 Kotlin.gitignore 忽略 .class、jar 等 JVM 产物和 Kotlin 2.0 的 .kotlin 目录的原因,以及与 Gradle、Android 模板组合时的注意事项。
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 模板处理。
原始模板
Kotlin.gitignore
# 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/
模板来源: github/gitignore/Kotlin.gitignore @356fd7b (2026-09-11) · CC0-1.0