Github 新建前端仓库,选择什么 .gitignore 模板?

1,955 阅读2分钟

前言

创建 .gitignore 文件,可以让 git 过滤指定的文件。

在 Github 创建仓库时,Github 提供了 .gitignore 模板供我们选择,那我们在 Github 创建一个前端仓库,要选哪一个模板?

Github .gitignore 模板如何选择

Github 提供的 .gitignore 模板列表,包含了主流编程语言。但是大家应该发现了,该列表并没有 javascript 语言。这是因为 javascript 不需要编译,没有编译产物需要过滤。

那有人就会问了,Vue 不是需要编译么?这是因为 Vue 并不是主流的编程语言,Github 官方将 Vue 等不常用的模板放在了 这里 ,但使用的人很少。

如果要新建一个前端仓库的话,还是建议大家跟着本文,自己快速创建一个 .gitignore 文件。

快速编写 .gitignore

首先需要新建 .gitignore 文件,在项目根目录运行命令:

$ touch .gitignore

然后在 gitignore.io 网站 中,输入关键词列表,就可以快速生成 .gitignore 文件了。

关键词有哪些?

前端工程需要过滤的文件,一般由 操作系统编程语言IDE 产生。

因此列出和上述 3 部分中,和前端相关的关键词,就可以在 gitignore.io 网站 快速生成一个前端工程的 .gitignore 文件了,上述 3 部分的相关关键词如下:

操作系统 的关键词为 macOSWindowsLinux

编程语言 的关键词为 NodeVuereact 等;

IDE 的关键词为 vswebStorm

新增了以上关键词后的列表,可以 点此查看

自己可以按照这个方法,根据需求进行关键词的删减即可。

.gitignore 常用语法

如果想手动编写,就需要学习下面的语法了。

# 开头代表注释

`.DS_Store`: 忽略所有 .DS_Store 文件

`\*.txt`: 忽略所有以 .txt 结尾的文件

`!readme.txt`: 取消对 readme.txt 的忽略

`folder/`: 忽略所有命名为 folder 的文件夹

`/folder`: 指定文件夹路径,忽略根目录下的 folder 文件夹

`folder/\*\*/\*.pdf`: 忽略 folder 文件夹内所有嵌套的文件夹中以 .pdf 结尾的文件

常用 .gitignore 忽略列表

如果觉得 gitignore.io 生成的列表太长,以下精简的列表,基本可以满足前端项目的需求:

# macOS

.DS_Store

# Node

node_modules

# IDE

.idea/

.code/

.vscode/

总结

希望通过本文能让大家对 Github .gitignore 的创建有所理解。