工具介绍
.gitignore是Git版本控制系统中用来指定不需要提交到版本库的文件和目录的配置文件。本工具可以帮你快速生成符合常用项目规范的.gitignore文件,选择需要的规则模板即可一键生成、复制或下载。
使用方法
- 在上方分类中勾选你需要的忽略规则(对应操作系统、编辑器、语言框架等);
- 在「自定义规则」文本框中添加你自己需要的忽略规则(每行一条);
- 勾选/添加后会自动生成内容,也可以点击「生成.gitignore」按钮手动更新;
- 生成完成后可以点击「复制内容」复制到剪贴板,或点击「下载文件」下载为标准的.gitignore文件。
规则语法说明
| 语法 | 说明 | 示例 |
|---|---|---|
| 空行 | 不匹配任何文件,用来分隔规则方便阅读 | - |
| #开头 | 注释,不会作为规则生效 | # 这是注释 |
| 文件名/目录名 | 忽略当前目录及子目录下所有该名称的文件/目录 | node_modules/ 会忽略所有node_modules目录 |
| 星号 * | 匹配零个或多个任意字符 | *.log 会忽略所有.log后缀的日志文件 |
| 问号 ? | 匹配单个任意字符 | project?.log 会匹配 project1.log、projecta.log等 |
| 方括号 [] | 匹配方括号中的任意一个字符 | [0-9].log 会匹配 1.log、2.log等 |
| 感叹号 ! | 不忽略(强制保留)该文件/目录,可覆盖前面的规则 | !important.log 即使前面规则忽略了所有log文件,这个文件依然保留 |
| 斜杠 / 结尾 | 只忽略目录,不忽略同名文件 | build/ 只忽略build目录,不忽略build文件 |
| 开头斜杠 / | 只匹配项目根目录下的该文件/目录 | /debug 只忽略根目录下的debug,不忽略子目录下的debug |
使用说明
生成完成后,把下载得到的.gitignore文件放到你的Git项目根目录即可生效,无需额外配置。