什么是 GITIGNORE 文件以及如何使用?

使用 git 存储库时,存在不需要数据的危险。值得庆幸的是,您可以创建一个带有 GITIGNORE 扩展名的文件,并定义项目中应忽略哪些文件和文件夹。您可以形成一个全局 GITIGNORE 数据,用于每个 Git 存储库。

什么是 GITIGNORE 文件以及如何使用它?

如何创建 GITIGNORE 文件

GITIGNORE 文件是纯文本文件,因此您可以使用记事本或任何文本编辑器打开它们。以下是制作 GITIGNORE 文件的方法:

  1. 打开任何文本编辑器并点击保存。将名称更改为 .gitignore。
  2. 编辑文件时,每一行都保留给一个文件夹或一个 git 应该忽略的文件。

使用“#”向 .gitignore 文件添加注释

使用“*”进行通配符匹配

使用 #/” 忽略相对于 GITIGNORE 文件的路径。

例如,您的 GITIGNORE 可能如下所示:

# 忽略 node_modules 文件夹

节点模块

# 忽略与 API 密钥相关的文件

.env

# 忽略 Mac 系统文件

.DS_store

# 忽略 SASS 配置文件

.sass 缓存

# 忽略所有文本文件

*。文本文件

您可能知道,注释是可选的。

通过包含路径并在每行末尾使用“/”来忽略目录。

例如:

测试/

日志/

负载/

虽然通配符“*”可用于忽略具有特定扩展名的所有文件,但您可以将其与否定符号“!”结合使用。下面是一个例子:

*。文本文件

!readme.txt

!main.txt

以上将通知 git 忽略除 readme.txt 和 main.txt 之外的每个扩展名为 .txt 的文件。

通配符可用于目录。使用它们时要小心,如本例所示:

测试/

!test/example.txt

您可能认为 git 现在会忽略“test”目录中除“example.txt”之外的所有文件。然而,事实并非如此。出于性能原因,它仍然会忽略 example.txt,因为我们已经定义了整个“test”目录被忽略。

您可以选择使用双星号 (**) 来匹配任意数量的目录和文件。例如,Test/**/*.txt 将告诉 git 仅忽略测试目录及其子目录中以 .txt 结尾的文件。

GITIGNORE 文件如何使用一个

实现GITIGNORE文件的三种方式

将全局 GITIGNORE 用于您的所有项目,无论是与您的同事还是单独使用。但是,您可以创建本地 GITIGNORE 甚至指定排除规则。

创建本地 GITIGNORE 文件

有两种方法可以定义 GITIGNORE 文件。您可以在目录级别拥有一个 GITIGNORE 文件或在根目录中创建一个文件。大多数情况下,GITIGNORE 包括属性文件和配置文件。当你的队友也在拉同一个 GITIGNORE 文件时,为了清楚起见,请务必使用“#”添加注释。

创建全局 GITIGNORE 文件

如果使用多个 git 存储库,您可以通过为本地存储库定义全局规则来节省大量时间。

  1. 创建 GITIGNORE 文件并定义要应用的通用规则。
  2. 使用 core.excludesFiles 属性将本地 GITIGNORE 文件转换为全局文件。使用以下行:

git config –global core.excludesFile

创建个人 GITIGNORE 规则

如果您有特定的存储库、规则,则可以修改全局或本地 GITIGNORE 文件。这些规则不能与您工作组的其他成员共享或控制。您可以将个人 GITIGNORE 规则用于本地工作目录或记录器设置。

对提交的文件使用 GITIGNORE 文件

忽略提交的文件

提交的文件集成到存储库中,因为它们被缓存。如果忽略此数据,则需要先将其删除。建议的方法是删除这些文件,然后提交并应用更改。完成此操作后,您最终可以通过定义在本地忽略文件的规则来使用 GITIGNORE。添加这一行:

git rm –缓存

以这种方式,即使文件将保留在工作目录中,它也会从存储库中删除。具有此规则的 GITIGNORE 文件应位于工作目录中。

提交以前忽略的文件

如果您希望提交一个被忽略的文件,您可以使用“git add”行和“force”选项来执行此操作。例如,如果要从 GITIGNORE 文件中删除 example.txt,同时保持存储库已提交,请插入以下行:

git add -f 例子.txt

git commit -m “强制添加example.txt”。

您现在已将一个被忽略的文件添加到存储库中。最后一步是通过删除忽略模式或规则来修改 GITIGNORE 文件。

什么是 GITIGNORE 文件 如何使用一个

使用 GITIGNORE 为您带来优势

由于几乎每个项目中都存在 GITIGNORE 文件,因此您需要学习如何使用它们。虽然命令很简单,但定义规则并忽略正确的文件至关重要。通过正确使用 GITIGNORE,您将节省时间并优化您的项目。

您多久需要 git 存储库中的 GITIGNORE 文件?您主要使用全球规则还是本地规则?请在评论部分分享您的经验。