Git移除文件.gitignore规则讲解

原创

小哥 3年前 (2022-11-05) 阅读数 22 #AI人工智能

在工程中，并不是所有文件都需要保存到版本库中的，例如“target”目录及目录下的文件就可以忽略。在Git工作区的根目录下创建一个特殊的.gitignore文件，然后把要忽略的文件名填进去，Git就会自动忽略这些文件或目录。

Git 忽略规则优先级

在 .gitingore 文件中，每一行指定一个忽略规则，Git 检查忽略规则的时候有多个来源，它的优先级如下（由高到低）：

从命令行中读取可用的忽略规则当前目录定义的规则父级目录定义的规则，依次递推 $GIT_DIR/info/exclude 文件中定义的规则 core.excludesfile中定义的全局规则

Git 忽略规则匹配语法

在 .gitignore 文件中，每一行的忽略规则的语法如下：

空格不匹配任意文件，可作为分隔符，可用反斜杠转义开头的文件标识注释，可以使用反斜杠进行转义 ! 开头的模式标识否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用 ! 也不会再次被包含。可以使用反斜杠进行转义 / 结束的模式只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件 / 开始的模式匹配项目跟目录如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在 .gitignore 文件中，则相对于项目根目录 ** 匹配多级目录，可在开始，中间，结束 ? 通用匹配单个字符

通用匹配零个或多个字符 [] 通用匹配单个字符列表

常用匹配示例

bin/: 忽略当前路径下的bin文件夹，该文件夹下的所有内容都会被忽略，不忽略 bin 文件 /bin: 忽略根目录下的bin文件 /.c: 忽略 cat.c，不忽略 build/cat.c debug/.obj: 忽略 debug/io.obj，不忽略 debug/common/io.obj 和 tools/debug/io.obj /foo: 忽略/foo, a/foo, a/b/foo等 a//b: 忽略a/b, a/x/b, a/x/y/b等 !/bin/run.sh: 不忽略 bin 目录下的 run.sh 文件 *.log: 忽略所有 .log 文件 config.php: 忽略当前路径的 config.php 文件

.gitignore规则不生效

.gitignore只能忽略那些原来没有被track的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。

解决方法就是先把本地缓存删除（改变成未track状态），然后再提交:

git rm -r --cached . git add . git commit -m update .gitignore

你想添加一个文件到Git，但发现添加不了，原因是这个文件被.gitignore忽略了：

$ git add App.class The following paths are ignored by one of your .gitignore files: App.class Use -f if you really want to add them.

如果你确实想添加该文件，可以用-f强制添加到Git：

$ git add -f App.class

或者你发现，可能是.gitignore写得有问题，需要找出来到底哪个规则写错了，可以用git check-ignore命令检查：

$ git check-ignore -v App.class .gitignore:3:*.class App.class

Git会告诉我们，.gitignore的第3行规则忽略了该文件，于是我们就可以知道应该修订哪个规则。

Java项目中常用的.gitignore文件

Created by JourWon on 2021/02/22

Eclipse template

.metadata bin/ tmp/ .tmp .bak .swp ~.nib local.properties .settings/ .loadpath .recommenders .classpath

External tool builders

.externalToolBuilders/

Locally stored "Eclipse launch configurations"

*.launch

PyDev specific (Python IDE for Eclipse)

*.pydevproject

CDT-specific (C/C++ Development Tooling)

.cproject

CDT- autotools

.autotools

Java annotation processor (APT)

.factorypath

PDT-specific (PHP Development Tools)

.buildpath

sbteclipse plugin

.target

Tern plugin

.tern-project

TeXlipse plugin

.texlipse

STS (Spring Tool Suite)

.springBeans

Code Recommenders

.recommenders/

Annotation Processing

.apt_generated/ .apt_generated_test/

Scala IDE specific (Scala & Java development for Eclipse)

.cache-main .scala_dependencies .worksheet

Uncomment this line if you wish to ignore the project description file.

Typically, this file would be tracked if it contains build/dependency configurations:

.project

NetBeans template

/nbproject/private/ /nbproject/Makefile-*.mk */nbproject/Package-.bash build/ nbbuild/ dist/ nbdist/ .nb-gradle/

JetBrains template

Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider

Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

idea

.idea/ .ipr .iml

CMake

cmake-build-*/

File-based project format

*.iws

IntelliJ

out/

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

Maven template

target/ pom.xml.tag pom.xml.releaseBackup pom.xml.versionsBackup pom.xml.next release.properties dependency-reduced-pom.xml buildNumber.properties .mvn/ mvnw mvnw.cmd