.gitignore 生成器

勾选项目用到的语言、框架、编辑器和操作系统,自动组合成一个 .gitignore 并去掉重复的规则,再加上自己的规则后复制或下载。下方可以输入文件路径,测试它会不会被忽略、命中了哪一行规则,排查“.gitignore 不生效”的问题。

测试路径是否被忽略

.gitignore 规则怎么写

写法含义
*.log任意目录下所有 .log 文件
build/任意位置名为 build 的目录(结尾的 / 表示只匹配目录)
/build只匹配仓库根目录下的 build,不影响 src/build
docs/*.pdf中间有 / 时相对于 .gitignore 所在目录,只匹配 docs 下一层的 pdf
**/temp、logs/**** 匹配任意层目录
!.env.example! 表示例外,重新包含前面被忽略的文件
\#file以 # 或 ! 开头的文件名要用反斜杠转义
  • 已经提交的文件不受影响:.gitignore 只对还没被跟踪的文件生效。文件已经提交过的话,执行 git rm --cached 文件(目录加 -r)取消跟踪,再提交一次。
  • 父目录被忽略后无法例外:写了 logs/ 再写 !logs/keep.txt 不会生效,因为 Git 根本不会进入被忽略的目录。要改成 logs/* 加 !logs/keep.txt。本工具的路径测试会模拟这条规则。
  • 后面的规则优先:同一个文件被多条规则匹配时,以最后一条为准。
  • 个人的忽略规则:只和自己电脑有关的文件(如 .DS_Store、编辑器配置)也可以写进全局文件:git config --global core.excludesfile ~/.gitignore_global。
  • 排查命令:git check-ignore -v 文件路径 会显示是哪个文件的哪一行忽略了它。

停止跟踪已提交文件的完整步骤见 Git 命令生成器。

.gitignore 生成器常见问题

.gitignore 生成器怎么使用?

点选项目用到的语言、框架、编辑器、操作系统模板,可以搜索模板名;在“自己的规则”中追加规则,右侧实时生成并统计去重的规则数;在测试框中输入路径,查看是否会被忽略以及命中了哪一行规则。

.gitignore 为什么不生效?

文件已经被 Git 跟踪了,需要先用 git rm --cached 取消跟踪。

怎么忽略目录但保留其中一个文件?

写 目录/* 和 !目录/文件,不能写成 目录/,否则无法例外。

/build 和 build/ 有什么区别?

/build 只匹配根目录下的 build,build/ 匹配任意位置名为 build 的目录。

.env 应该忽略吗?

应该,.env 通常包含密码和密钥,提交一份去掉真实值的 .env.example 即可。

.gitignore 生成器的结果应怎样理解?

路径测试模拟 Git 的匹配规则,适用于单个位于仓库根目录的 .gitignore,不包含子目录中的 .gitignore 和全局忽略文件。

输入内容会保存或发给外部服务吗?

所有内容在浏览器本地生成,不会上传。

没有结果或操作失败时先检查什么?

.gitignore 不生效,通常是文件之前已经被提交过,执行 git rm --cached 文件 取消跟踪后再提交。

相关工具

README 生成器 · CHANGELOG 生成器 · CSS Transform 变换生成器 · Diff 补丁查看器 · 全部开发工具