gitignore 忽略子文件夹

介绍

在使用 Git 进行版本控制时，我们通常需要忽略某些文件或文件夹，以避免将不必要的内容纳入仓库中。对于需要忽略的文件和文件夹，我们可以使用 .gitignore 文件来指定。

在本文中，我们将重点讨论如何在 .gitignore 文件中忽略子文件夹。我们将了解如何在不同的情况下配置 .gitignore 文件以忽略特定的子文件夹。

创建 .gitignore 文件

首先，我们需要在我们的 Git 项目中创建一个名为 .gitignore 的文件，用于指定需要忽略的文件和文件夹。在项目的根目录中使用文本编辑器创建一个新文件，并将其命名为 .gitignore。

忽略子文件夹的一般方法

忽略子文件夹的一般方法是在 .gitignore 文件中指定子文件夹的相对路径。假设我们有一个名为 subfolder 的子文件夹，我们可以在 .gitignore 文件中添加以下内容以忽略这个子文件夹：

subfolder/

上述语法中的 / 表示路径分隔符，Git 将忽略 subfolder 文件夹及其内部的所有文件和文件夹。

如果我们的项目中有多个子文件夹需要被忽略，我们可以在 .gitignore 文件中添加多行来指定这些子文件夹。例如，如果我们还有一个名为 another_subfolder 的子文件夹需要被忽略，我们可以将以下内容添加到 .gitignore 文件中：

subfolder/
another_subfolder/

在上述示例中，Git 将忽略 subfolder 和 another_subfolder 文件夹及其内部的所有内容。

忽略包含特定文件的子文件夹

有时，我们希望忽略子文件夹，但保留其中的某些特定文件。在这种情况下，我们可以使用 ! 符号在 .gitignore 文件中指定要保留的文件。

假设我们有一个名为 subfolder 的子文件夹，我们希望忽略这个子文件夹中的所有内容，但保留其中名为 important.txt 的文件。我们可以按照以下步骤配置 .gitignore 文件：

1. 忽略 subfolder 文件夹及其内部的所有文件和文件夹：

    subfolder/

2. 在 .gitignore 文件的末尾添加一行，指定要保留的文件：

    !subfolder/important.txt

现在，Git 会忽略 subfolder 文件夹中除了 important.txt 以外的所有内容。

示例与测试

让我们通过一个示例来演示如何在 .gitignore 文件中忽略子文件夹。假设我们的项目结构如下：

project/
├─ .gitignore
├─ main.py
├─ subfolder/
│  ├─ important.txt
│  └─ unnecessary.txt
└─ another_subfolder/
   ├─ temp.bin
   └─ log.txt

我们希望忽略 subfolder 和 another_subfolder 两个子文件夹及它们内部的所有内容，但保留 subfolder 下的 important.txt 文件。我们可以按照以下步骤进行配置：

1. 在项目的根目录中创建一个名为 .gitignore 的文件。

2. 在 .gitignore 文件中添加以下内容：

    subfolder/
    another_subfolder/

3. 在 .gitignore 文件的末尾添加一行，保留 subfolder 下的 important.txt 文件：

    !subfolder/important.txt

保存并关闭 .gitignore 文件后，我们可以执行以下命令验证配置是否正确：

$ git status

如果一切顺利，Git 不会显示 subfolder 和 another_subfolder 中的内容。

总结

通过正确配置 .gitignore 文件，我们可以轻松地忽略子文件夹及其内部的所有内容。使用上述方法，我们可以灵活地控制 Git 仓库忽略哪些子文件夹，并保留其中的特定文件。