目录
一、在 VSCode 中通过 .gitignore 文件设置 Git 忽略文件
1. 创建 .gitignore 文件
方法 1:在 VS Code 中手动创建
方法 2:使用 Git 命令创建
2. 配置 .gitignore 内容
2.1 基础规则
3. .gitignore 文件的使用
4. 验证忽略规则是否生效
5. 移除已被追踪的 .vscode 文件
6. 提交 .gitignore 文件
or:除了手动创建 .gitignore 文件,还可以使用VS Code 中的辅助插件来帮助生成 .gitignore 文件
二、全局 .gitignore 文件(全局级别设置忽略规则)
三、在 VSCode 的 settings.json 文件中设置忽略规则
一、在 VSCode 中通过 .gitignore 文件设置 Git 忽略文件
在使用 VSCode 进行软件开发时,经常需要通过 Git 来进行版本控制。有时候,我们希望 Git 能够忽略掉一些不需要提交的文件或文件夹,比如编译生成的文件、日志文件或者依赖包文件夹(如 node_modules)。为了实现这一点,我们可以通过编辑 .gitignore 文件来指定 Git 忽略的内容。
1. 创建 .gitignore 文件
方法 1:在 VS Code 中手动创建
- 右键侧边栏的文件夹树,选择 新建文件。
- 命名为 .gitignore。
方法 2:使用 Git 命令创建
打开 VS Code 内置终端(快捷键:Ctrl+Shift+` ),运行以下命令:
touch .gitignore
2. 配置 .gitignore 内容
2.1 基础规则
忽略文件的语法:
- 单独的文件名:filename.ext 忽略特定文件。
- 目录名:/folder/ 忽略整个目录。 通配符:
- * 匹配任意多个字符。
- ** 匹配任意深度的目录。
- ? 匹配单个字符。
- 以 ! 开头的规则表示排除特例。
3. .gitignore 文件的使用
.gitignore 文件是一个特殊的文件,它告诉 Git 哪些文件或文件夹是不需要进行版本控制的。在项目的根目录下创建或修改 .gitignore 文件,可以达到忽略特定文件变更的效果。例如,如果你想忽略所有的 .log 文件,你可以在 .gitignore 文件中添加一行 *.log。
# 忽略所有 .log 文件
*.log
# 忽略 node_modules 文件夹
node_modules/
# 忽略特定文件夹
dist/
-
如果需要忽略所有 .vscode 文件夹,但保留特定文件(如 launch.json),可使用以下规则:
vscode/*
!.vscode/launch.json
-
确保规则书写正确,否则可能导致忽略失败。
通过以上步骤,可以成功忽略 .vscode 文件夹,避免不必要的配置文件进入版本控制系统。
4. 验证忽略规则是否生效
-
使用以下命令检查 .vscode 是否被忽略:
git status
-
确保 .vscode 不再出现在未跟踪文件列表中。
5. 移除已被追踪的 .vscode 文件
如果某些文件已被 Git 追踪,修改 .gitignore 后不会自动生效。需要手动清除:如 .vscode 已经被 Git 跟踪,需先从仓库中移除:
-
移除缓存:
git rm -r –cached .vscode/
- 然后再次提交更改:
git commit -m "Remove .vscode from tracking"
git push
6. 提交 .gitignore 文件
将更新后的 .gitignore 提交到 Git 仓库:然后生效
git add .gitignore
git commit -m "Add .gitignore rules for .vscode directory"
git push
or:除了手动创建 .gitignore 文件,还可以使用VS Code 中的辅助插件来帮助生成 .gitignore 文件
1. 推荐插件
- Ignore Files for VSCode:
- 帮助生成 .gitignore 文件。
- 提供快速选择和模板支持。
2.安装: 打开 VS Code 扩展市场,搜索 Ignore Files for VSCode,点击 Install。 3. 使用方法
- 安装插件后,右键项目文件夹,选择 Add to .gitignore。
- 通过插件选择要忽略的文件或目录。(即在 VSCode 中,你可以直接在源代码管理面板中右键点击不想跟踪的文件或文件夹,选择“添加到 .gitignore”,这样 VSCode 就会自动更新 .gitignore 文件。)
二、全局 .gitignore 文件(全局级别设置忽略规则)
除了在项目级别设置 .gitignore 文件外,你还可以在全局级别设置忽略规则。在你的用户根目录下创建一个名为 .gitignore_global 的文件,并在其中指定全局忽略的规则。然后,运行以下 Git 命令来配置 Git 使用这个全局忽略文件: 这样,你就不需要在每个项目中都创建 .gitignore 文件了。
git config –global core.excludesfile "%USERPROFILE%\\.gitignore_global"
三、在 VSCode 的 settings.json 文件中设置忽略规则
在 VSCode 的 settings.json 文件中,你也可以设置忽略规则,以控制哪些文件或文件夹不显示在编辑器的工作区或搜索结果中。例如:
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true
},
"search.exclude": {
"**/node_modules": true,
"**/bower_components": true
}
通过这些设置,你可以让 VSCode 在工作区中不显示 .git 文件夹,以及在搜索时排除 node_modules 文件夹。
参考文章
评论前必须登录!
注册