不清楚的 .gitignore

起因:

在项目 .gitignore 看见了部分配置如下:

node_modules
/dist
.history

/.history/src/views/incomeData/incomePool/list_20230209102341.vue
/.history/src/views/incomeData/incomePool/list_20230209102421.vue
/.history/src/views/incomeData/incomePool/list_20230209102435.vue

.vscode
.vscode/

你是否也觉得这个忽略文件怪怪的,但知识它在脑子里又不那么清楚 🫣

1. node_modules一般配置是 node_modules/,他们有什么区别?
2. /dist前面加不加/有区别吗?
3. 配置过了 .history,后面三条还有必要? 难道 .history配置后内部文件不忽略??
4. .vscode和.vscode/不重复?

下面逐个分析

1. node_modules一般配置是 node_modules/,他们有什么区别?

node_modules:忽略任意层级路径中，名为 node_modules 的路径项

• 如果该路径项是 文件
  👉 忽略该文件
• 如果该路径项是 目录
  👉 忽略该目录 及其全部子内容

node_modules/: 忽略任意层级路径中,名为node_modules的目录(及其全部子内容)

虽然它们都能实现忽略 node_modules目录

但node_modules规则本身语义不明确,从规则本身无法一眼判断

• 要忽略文件?
• 还是忽略目录?

node_modules/一眼就知道要忽略这个目录,所以在忽略目录的时候更推荐这种写法

2. /dist前面加不加/有区别吗?

有区别

dist:忽略任意层级 路径中，名为 dist 的路径项

/dist:忽略根目录 下名为dist的路径项

3. 配置过了 .history,后面三条还有必要? 难道 .history配置后内部文件不忽略?

现在我们已经知道 .history的含义(忽略任意层级路径中，名为 .history 的路径项),

/.history/src/views/incomeData/incomePool/list_20230209102341.vue
/.history/src/views/incomeData/incomePool/list_20230209102421.vue
/.history/src/views/incomeData/incomePool/list_20230209102435.vue

很明显这三个文件都是目录 .history下的内容,配置.history已经包含,完全可以删掉这三条.

.history是常见vscode 插件生成的目录,故推荐写法.history/.

4. .vscode和.vscode/不重复?

重复

想必到这里已经非常明确的知道他们的区别了(不明白看第一个问题),.vscode是常见 IDE 配置目录,所以推荐.vscode/

成果展示

现在要修改文章开头的 .gitignore,易如反掌

node_modules/
dist/
.history/
.vscode/

至于前面要不要加/自行判断需要忽略任意层级路径中的目录 还是仅根目录

扩展

# 1️⃣ * 通配符: 匹配任意字符(不含/)
# 忽略所有 .log 结尾的路径项
*.log 


# 2️⃣ !反向忽略
# 2.1 忽略 .vscode 目录下所有内容,但保留项目级 VS Code 配置
.vscode/*
!.vscode/settings.json
# 2.2 忽略所有 .env，但保留示例文件
.env
!.env.example

为什么反向忽略例子2.1用的是.vscode/*而不是.vscode/

用一个例子解释,目录结构：

.vscode/
  settings.json
  launch.json

1️⃣ 使用 .vscode/

含义:

忽略名为 .vscode 的目录

一旦该目录被忽略，其内部所有文件都会被隐式忽略

结果：

.vscode/            ❌
  settings.json     ❌
  launch.json       ❌

git 已经忽略 .vscode 目录,不会再进入该目录,无论写多少个反向忽略,都没用

2️⃣ 使用 .vscode/*

含义:

忽略 .vscode 目录下的 所有直接子路径

但 .vscode 目录本身 仍然是"可见的"

结果：

.vscode/            ✅
  settings.json     ❌（除非反向忽略）
  launch.json       ❌

在此基础上添加反向忽略,git才能识别.

有趣 🌾