从 .idea 文件夹中 gitignore 什么？

Question

可能重复：
Intellij Idea 9/10，哪些文件夹要签入（或不签入）源代码管理？

我开始使用 WebStorm 进行 web 开发，但不确定要添加什么以及要从我们的 Git 存储库中排除什么。 很明显， .idea文件夹中的一些文件应该像外部库设置 ( jsLibraryMappings.xml ) 一样进行版本控制，但其他文件可能会经常更改并且是特定于开发人员的（例如， workspace.xml ）。

WebStorm/IntelliJ IDEA 推荐的.gitignore模式是什么？

PS 已经有关于此的问题，但通常只关注是否包含整个.idea文件夹或是否完全排除它。 我认为.idea文件夹中的一些文件应该是版本控制的，而其他的不应该，我正在尝试找出哪些文件。

Answer 1

官方支持页面应该可以回答您的问题。

因此，在您的.gitignore您可能会忽略以.iws结尾的文件，以及workspace.xml和tasks.xml文件。

Answer 2

我只想提出一个更新的替代方案。 有一个在线工具可以根据您可能使用的操作系统、IDE 和编程语言生成.gitignore文件。

gitignore.io

---

编辑免责声明：不要复制此文件，而是复制网站生成的文件，他们在保持更新方面做得很好。 这只是一个例子。

为IntelliJ生成的文件包含以下内容

# Created by https://www.gitignore.io/api/intellij

### Intellij ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff:
.idea/workspace.xml
.idea/tasks.xml
.idea/dictionaries
.idea/vcs.xml
.idea/jsLibraryMappings.xml

# Sensitive or high-churn files:
.idea/dataSources.ids
.idea/dataSources.xml
.idea/dataSources.local.xml
.idea/sqlDataSources.xml
.idea/dynamic.xml
.idea/uiDesigner.xml

# Gradle:
.idea/gradle.xml
.idea/libraries

# Mongo Explorer plugin:
.idea/mongoSettings.xml

## File-based project format:
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

### Intellij Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml

Answer 3

https://www.gitignore.io/api/jetbrains

由https://www.gitignore.io/api/jetbrains创建

### JetBrains ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff:
.idea/workspace.xml
.idea/tasks.xml
.idea/dictionaries
.idea/vcs.xml
.idea/jsLibraryMappings.xml

# Sensitive or high-churn files:
.idea/dataSources.ids
.idea/dataSources.xml
.idea/dataSources.local.xml
.idea/sqlDataSources.xml
.idea/dynamic.xml
.idea/uiDesigner.xml

# Gradle:
.idea/gradle.xml
.idea/libraries

# Mongo Explorer plugin:
.idea/mongoSettings.xml

## File-based project format:
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

### JetBrains Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml 
# *.ipr 

Answer 4

几年来，我一直支持在 IntelliJ 中使用特定的.gitignore和这个建议的配置。

不再。

IntelliJ 更新非常频繁，内部配置文件规范的更改比我想要的更频繁，JetBrains 旗舰在基于 maven/gradle/etc 构建文件自动配置自身方面表现出色。

所以我的建议是将所有编辑器配置文件都放在项目之外，让用户根据自己的喜好配置编辑器。 代码样式之类的东西可以而且应该在构建级别进行配置； 比如说直接在 Maven/Gradle/sbt/etc 上使用Google Code Style或CheckStyle 。

这确保了一致性并将编辑器文件排除在源代码之外，在我个人看来，源代码是它们应该存在的地方。

Answer 5

Github 在他们的程序中使用以下 .gitignore

https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore

# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
# 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

# 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/modules.xml
# .idea/*.iml
# .idea/modules

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

Answer 6

您可以通过将.idea/*添加到.gitignore文件来简单地忽略所有这些。

Answer 7

在我的情况下/**/.idea/*运行良好

Answer 8

如支持页面所述，从 2019.1 版本开始，IntelliJ 能够自动将需要共享的所有内容添加到版本控制。

这很好，因为 IDE 会分两步将必要的文件添加到 Git：

1. 用IntelliJ打开项目，稍等片刻，直到右下角出现如下弹窗
2. Select“总加”

或者，您可以拨打 select“查看文件”，然后手动添加它们。

Answer 9

虽然维护正确的.gitignore文件很有帮助，但我发现这种替代方法更简洁、更易于使用。

• 创建虚拟文件夹my_project并在该git clone my_real_project中创建实际的项目存储库。
• 现在，在 IDE (Intellij/Pycharm) 中打开项目时，打开文件夹my_project并将my_project/my_real_project标记为 VCS 根。
• 你可以看到my_project/.idea不会污染你的 git repo，因为它快乐地生活在你想要的 git repo 之外。 这样你的.gitignore文件也能保持干净。

由于以下原因，这种方法效果更好。

1 - .gitignore文件保持干净，我们不必插入与 JetBrains 产品相关的行，该文件更适合用于二进制文件和库以及 autogen 内容。

2 - Intellij 不断更新他们的项目， .idea的文件不断更改 JB 的每个重要版本。 这意味着我们必须相应地不断更新我们的.gitignore ，这不是理想的时间利用方式。

3 - Intellij 在这里有缺陷的模式，大多数编辑器 Atom、VS Code、Eclipse ......没有人将他们的 IDE 内容存储在项目根目录中。 JB也不应该例外。 Jetbrains 有责任在项目根目录之外跟踪这些文件。 他们必须避免污染 VCS 根。 这种方法就是这样做的。 .idea文件夹保存在PROJECT_ROOT之外

希望这可以帮助。

Answer 10

• 删除 .idea 文件夹

  $rm -R .idea/

• 添加规则

  $echo ".idea/*" >> .gitignore

• 提交 .gitignore 文件

  $git commit -am "remove .idea"

• 下一次提交没问题