# .gitignore 生成器使用教程：29 种模板组合，一键生成标准忽略文件

> 来源：工具派（https://gjupai.com） 原文页面：https://gjupai.com/tutorial/gitignore-generator-guide

## 工具简介

**.gitignore 生成器**是工具派推出的一款面向开发者的免费在线工具：不用去网上翻找各种技术栈的忽略规则，只要在页面上勾选你项目用到的语言、框架、操作系统和 IDE 模板，右侧就会实时合并生成一份标准的 `.gitignore` 文件，并支持一键复制或直接下载。工具内置 **29 个常用模板**，涵盖 Node.js、Python、Java、Go、Rust 等 8 种语言，React、Vue、Django、Spring Boot、Docker、Kubernetes 等 13 种框架，macOS、Windows、Linux 三大操作系统，以及 VS Code、IntelliJ IDEA、Eclipse、Vim、Sublime Text 五款编辑器，还能在「自定义规则」里追加项目专属的忽略条目。合并时会**自动去重**重复规则、保留注释分组，生成的文件头还会标注所用模板清单，干净规范、开箱即用，全程在浏览器本地完成，无需安装任何插件。

## 功能亮点

- **29 个内置模板**：覆盖主流编程语言、前后端框架、云原生工具（Docker / Kubernetes / Terraform）、三大操作系统和五款常用 IDE / 编辑器，常见技术栈基本都能找到。
- **分类筛选 + 搜索**：顶部可按「全部 / 语言 / 框架 / 操作系统 / IDE/编辑器」五个分类过滤模板，也可以在搜索框输入关键字（如 Python、macOS）快速定位。
- **多模板自由组合**：模板可多选，已选项会以标签形式汇总在「已选模板」区，点标签上的 × 即可移除，组合顺序无关、结果一致。
- **自动去重合并**：多个模板合并时重复的规则只保留一条，注释和空行分组完整保留，不会出现 node_modules/ 之类的重复条目。
- **自定义规则追加**：在「自定义规则」文本框中每行写一条（如 `secret.txt`、`*.tmp`），会自动以 `# Custom rules` 分组追加到文件末尾。
- **实时预览 + 一键复制 / 下载**：右侧预览区随选择即时更新，「复制」按钮把内容拷到剪贴板，「下载 .gitignore」直接保存为可放入项目根目录的文件。
- **规范文件头**：生成结果顶部自动附带 `# Generated by 工具派 .gitignore generator` 及所用模板清单注释，方便团队知晓文件来源与构成。

## 参数说明

| 参数 | 说明 | 默认值 / 取值范围 |
| --- | --- | --- |
| 分类筛选 | 按模板类别过滤下方模板列表 | 全部（默认）/ 语言 / 框架 / 操作系统 / IDE/编辑器 |
| 搜索框 | 按模板名称或 key 过滤模板，支持「清空搜索」按钮一键重置 | 默认空，大小写不敏感 |
| 模板选择 | 点击模板卡片勾选 / 取消勾选，可多选 | 默认已选 Node.js、VS Code，共 29 个模板可选 |
| 全选当前分类 | 将当前分类下的所有模板一次性加入已选 | 按钮，配合分类筛选使用 |
| 清空已选 | 移除所有已选模板 | 按钮 |
| 已选模板 | 已勾选模板以标签展示，点 × 可单独移除 | 默认显示 Node.js、VS Code |
| 自定义规则 | 追加项目专属忽略规则，每行一条 | 默认空，追加到 `# Custom rules` 分组下 |
| 输出操作 | 「复制」拷贝预览内容，「下载 .gitignore」保存为文件 | 无生成内容时下载按钮不可用 |

## 使用步骤

1. **打开工具页面**：左侧是模板选择与规则配置区，右侧是实时预览区，默认已为你勾选了 Node.js 和 VS Code 两个模板，无需登录即可使用。

![.gitignore 生成器主界面：左侧为模板选择区，顶部是「全部/语言/框架/操作系统/IDE/编辑器」分类按钮、技术](article/202607/1783994191763_1297.png)

2. **筛选模板分类**：在左侧面板顶部点击「全部 / 语言 / 框架 / 操作系统 / IDE/编辑器」切换分类，只显示该类别下的模板；也可以在搜索框输入关键字（如 Python、macOS）快速过滤，点「清空搜索」恢复全部。

3. **勾选所需模板**：在模板卡片网格中点击你的项目用到的技术栈，卡片变为蓝色高亮即表示选中，可多选；想批量操作时可用「全选当前分类」一次加入某类全部模板，或「清空已选」重新开始。已选的模板会以标签形式显示在「已选模板」区，点标签上的 × 可单独移除。

4. **追加自定义规则（可选）**：如果模板没有覆盖到项目特有的文件，在「自定义规则」文本框中每行写一条规则，例如 `secret.txt`、`*.tmp`，生成时会以 `# Custom rules` 分组追加到文件末尾。

5. **检查右侧预览**：右侧预览区会实时合并所有已选模板与自定义规则，重复规则自动去重，文件顶部带有工具派生成标记和所用模板清单，滚动检查内容是否符合预期。

6. **复制或下载使用**：确认无误后，点「复制」把内容粘贴到项目根目录的 `.gitignore` 中，或直接点「下载 .gitignore」保存文件并放入项目根目录，Git 即刻按规则忽略对应文件。

## 使用技巧

- **按项目实际技术栈组合勾选**：一个典型的前端项目通常需要「Node.js + React/Vue + VS Code + 操作系统」四块组合，后端项目则是「语言 + 框架 + IDE + 操作系统」，按需叠加即可，不必贪多。
- **善用「全选当前分类」做基线**：切换到「操作系统」分类后点「全选当前分类」，可一次把 macOS、Windows、Linux 的系统垃圾文件规则全部纳入，适合多人跨平台协作的项目。
- **IDE 规则只选自己团队用的**：VS Code 模板刻意保留了 settings.json、tasks.json 等共享配置（只忽略 .vscode 下的其余文件），如果团队需要共享编辑器配置，这个模板正合适；反之可改用 IntelliJ IDEA 模板的写法思路，用自定义规则整目录忽略。
- **自定义规则支持完整 gitignore 语法**：`#` 开头的注释、`!` 开头的例外规则、`*` 通配符都可以写在自定义规则框里，和手写 .gitignore 完全一致。
- **下载后直接覆盖旧文件要小心**：如果项目已有 .gitignore，建议先用「复制」对比合并，避免直接覆盖丢掉历史规则；已被 Git 跟踪的文件还需 `git rm --cached` 后忽略规则才生效。

## 常见问题

**Q1：工具内置了哪些模板？**
共 29 个：语言类有 Node.js、Python、Java、Go、Rust、Ruby、PHP、Swift；框架类有 React、Vue、Angular、Django、Flask、Spring Boot、Laravel、.NET、Dart/Flutter、Docker、Kubernetes、Terraform、Android；操作系统有 macOS、Windows、Linux；IDE/编辑器有 VS Code、IntelliJ IDEA、Eclipse、Vim、Sublime Text。

**Q2：同时勾选多个模板，重复的规则会出现两遍吗？**
不会。合并时工具会自动去重，内容相同的规则只保留第一次出现的那条，注释行和空行分组则会完整保留，保证生成文件整洁可读。

**Q3：生成的文件顶部那几行 `# Generated by ...` 注释有什么用？**
这是工具自动添加的文件头，标明了生成来源、所用模板清单和工具链接，方便团队成员了解这份 .gitignore 的构成。它都是注释行，不影响 Git 的忽略行为，也可以手动删除。

**Q4：下载的文件没有扩展名，怎么放进项目？**
「下载 .gitignore」保存的就是名为 `.gitignore` 的纯文本文件，直接放到 Git 仓库根目录即可。Windows 下如果资源管理器不允许以点开头命名，用下载的文件本身或在编辑器中另存即可。

**Q5：勾选了 VS Code 模板，为什么 .vscode 目录里有些文件没被忽略？**
这是有意设计：VS Code 模板用 `.vscode/*` 加 `!.vscode/settings.json` 等例外规则，只忽略本地缓存类文件，保留团队共享的 settings、tasks、launch 配置。如果你想整个忽略 .vscode，在自定义规则里加一行 `.vscode/` 即可。

**Q6：加了忽略规则后，文件还是被 Git 跟踪着？**
.gitignore 只对「未被跟踪」的文件生效。如果文件已经被提交过，需要先执行 `git rm --cached <文件>` 把它移出索引，忽略规则才会起作用，这是 Git 本身的机制，与生成工具无关。