github/gitignore · Global/JetBrains.gitignore
JetBrains .gitignore 模板详解
说明 JetBrains.gitignore 只从 IntelliJ、PyCharm、WebStorm 等的 .idea 目录中挑出个人设置和敏感文件进行忽略的原因,以及与忽略整个 .idea 的区别。
JetBrains.gitignore 处理 IntelliJ IDEA、PyCharm、WebStorm、GoLand、PhpStorm、Rider、CLion、Android Studio 共用的 .idea 目录。模板并不排除整个 .idea,而是只挑出个人状态、敏感信息和自动生成的文件进行拦截。
JetBrains 官方指南也建议共享代码风格、运行配置、检查配置文件等对团队有帮助的设置,并排除 workspace.xml 之类的个人文件。
逐条规则详解
| 模式 | 忽略什么,为什么忽略 |
|---|---|
.idea/**/workspace.xml.idea/**/tasks.xml.idea/**/usage.statistics.xml.idea/**/dictionaries.idea/**/shelf | 个人工作状态打开的文件、光标位置、任务(task)历史、个人词典以及搁置(shelve)的更改。因人而异,且经常变化。 |
.idea/**/dataSources/.idea/**/dataSources.local.xml.idea/**/sqlDataSources.xml.idea/**/dynamic.xml.idea/**/dbnavigator.xml | 数据库连接数据库工具的连接信息和架构缓存。本地连接设置中包含用户名等个人信息。 |
.idea/**/gradle.xml.idea/**/libraries | 构建工具同步结果导入 Gradle、Maven 项目时 IDE 重新生成的设置和库列表。 |
out/*.iws.idea_modules/cmake-build-*/ | IDE 输出与旧版格式IntelliJ 编译输出、旧式基于文件的项目格式的工作区文件,以及 CLion 的 CMake 构建目录。 |
atlassian-ide-plugin.xml.idea/sonarlint/com_crashlytics_export_strings.xmlcrashlytics.propertiesfabric.properties | 插件文件JIRA、SonarLint、Crashlytics 插件生成的设置和缓存。 |
.idea/httpRequestshttp-client.private.env.json | HTTP 客户端机密内置 HTTP 客户端的请求历史,以及存放令牌和密码的 private 环境文件。可公开的值放在 http-client.env.json 中并提交。 |
.idea/caches/build_file_checksums.ser.idea/**/contentModel.xml.idea/**/aws.xml | 缓存Android Studio 构建文件校验和缓存、自动生成的模型以及 AWS Toolkit 的个人设置。 |
实践中的注意事项
- 如果使用 Gradle、Maven 自动导入,取消模板注释中
.idea/modules.xml、.idea/*.iml、*.iml规则的注释可以减少变更。 - 如果不需要共享设置,也可以在全局 gitignore 中加入
.idea/。这种情况下就不需要此模板。 - 如果
.idea/workspace.xml已经被提交,即使添加规则也会继续被跟踪。请用git rm --cached .idea/workspace.xml清理。
原始模板
JetBrains.gitignore
# Covers JetBrains IDEs: IntelliJ, GoLand, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839# User-specific stuff.idea/**/workspace.xml.idea/**/tasks.xml.idea/**/usage.statistics.xml.idea/**/dictionaries.idea/**/shelf# AWS User-specific.idea/**/aws.xml# Generated files.idea/**/contentModel.xml# Sensitive or high-churn files.idea/**/dataSources/.idea/**/dataSources.ids.idea/**/dataSources.local.xml.idea/**/sqlDataSources.xml.idea/**/dynamic.xml.idea/**/uiDesigner.xml.idea/**/dbnavigator.xml# Gradle.idea/**/gradle.xml.idea/**/libraries# Gradle and Maven with auto-import# When using Gradle or Maven with auto-import, you should exclude module files,# since they will be recreated, and may cause churn. Uncomment if using# auto-import.# .idea/artifacts# .idea/compiler.xml# .idea/jarRepositories.xml# .idea/modules.xml# .idea/*.iml# .idea/modules# *.iml# *.ipr# CMakecmake-build-*/# Mongo Explorer plugin.idea/**/mongoSettings.xml# File-based project format*.iws# IntelliJout/# mpeltonen/sbt-idea plugin.idea_modules/# JIRA pluginatlassian-ide-plugin.xml# Cursive Clojure plugin.idea/replstate.xml# SonarLint plugin.idea/sonarlint/# see https://community.sonarsource.com/t/is-the-file-idea-idea-idea-sonarlint-xml-intended-to-be-under-source-control/121119.idea/sonarlint.xml# Crashlytics plugin (for Android Studio and IntelliJ)com_crashlytics_export_strings.xmlcrashlytics.propertiescrashlytics-build.propertiesfabric.properties# Editor-based HTTP Client.idea/httpRequestshttp-client.private.env.json# Android studio 3.1+ serialized cache file.idea/caches/build_file_checksums.ser# Apifox Helper cache.idea/.cache/.Apifox_Helper.idea/ApifoxUploaderProjectSetting.xml# Github Copilot persisted session migrations, see: https://github.com/microsoft/copilot-intellij-feedback/issues/712#issuecomment-3322062215.idea/**/copilot.data.migration.*.xml
模板来源: github/gitignore/Global/JetBrains.gitignore @356fd7b (2026-09-11) · CC0-1.0