vscode中配置git的.gitignore文件

打印 上一主题 下一主题

主题 835|帖子 835|积分 2505

在 Visual Studio Code (VS Code) 中配置 .gitignore 文件,可以有效地忽略不必要提交到 Git 堆栈的文件或目次。
  
  一、什么是 .gitignore 文件?

  .gitignore 是一个文本文件,告诉 Git 哪些文件或文件夹应该被忽略,不包括在版本控制中。这对保护敏感信息和避免提交多余文件非常紧张。
  
  二、创建和配置 .gitignore 的步骤

  1. 创建 .gitignore 文件

  方法 1:在 VS Code 中手动创建

  

  • 在项目根目次下新建一个文件:

    • 右键侧边栏的文件夹树,选择 New File
    • 命名为 .gitignore。

  方法 2:利用 Git 命令创建

  

  • 打开 VS Code 内置终端(快捷键:Ctrl+` ),运行以下命令:
    1. touch .gitignore
    复制代码
  
  2. 配置 .gitignore 内容

  2.1 底子规则

  

  • 忽略文件的语法:

    • 单独的文件名:filename.ext 忽略特定文件。
    • 目次名:/folder/ 忽略整个目次。
    • 通配符:

      • * 匹配任意多个字符。
      • ** 匹配任意深度的目次。
      • ? 匹配单个字符。

    • 以 ! 开头的规则表示排除特例。

  2.2 常见示例

  

  • 忽略系统文件:
    1. # MacOS 系统文件
    2. .DS_Store
    3. # Windows 系统文件
    4. Thumbs.db
    复制代码
  • 忽略日志和缓存文件:
    1. # 忽略日志文件
    2. *.log
    3. # 忽略临时文件
    4. *.tmp
    复制代码
  • 忽略依赖和编译文件:
    1. # Node.js 项目
    2. node_modules/
    3. # Python 项目
    4. __pycache__/
    5. *.pyc
    复制代码
  • 忽略特定 IDE 配置:
    1. # VS Code 设置文件
    2. .vscode/
    复制代码
  
  3. 检查 .gitignore 的收效状态

  3.1 确保 Git 已应用 .gitignore

  

  • 在 VS Code 图形界面查看

    • 左侧 Source Control 面板应显示 .gitignore 文件中的规则收效,不再追踪对应文件。

  • 在终端运行命令检查
    1. git status
    复制代码
  3.2 处置处罚已经被追踪的文件

  

  • 如果某些文件已被 Git 追踪,修改 .gitignore 后不会自动收效。必要手动清除:
    1. git rm --cached <file_or_directory>
    复制代码
    然后重新提交更改:
    1. git add .gitignore
    2. git commit -m "Update .gitignore"
    复制代码
  
  4. 利用 .gitignore 模板

  4.1 下载模板

  

  • 常见项目范例的 .gitignore 模板可以从以下地点获取:

    • GitHub 官方 .gitignore 模板库

  4.2 在 VS Code 中添加模板

  

  • 打开模板堆栈,找到对应的 .gitignore 文件。
  • 将内容复制到项目标 .gitignore 文件中。
  
  三、VS Code 中的辅助插件

  1. 推荐插件

  

  • Ignore Files for VSCode

    • 资助天生 .gitignore 文件。
    • 提供快速选择和模板支持。
    • 安装:

      • 打开 VS Code 扩展市场,搜索 Ignore Files for VSCode,点击 Install


  2. 利用方法

  

  • 安装插件后,右键项目文件夹,选择 Add to .gitignore
  • 通过插件选择要忽略的文件或目次。
  
  四、常见标题与解决方案

  1. .gitignore 不收效

  大概原因

  

  • 文件已被 Git 追踪。
  • .gitignore 规则书写错误。
  • 文件路径未精确匹配。
  解决方法

  

  • 清除已追踪文件:
    1. git rm --cached <file_or_directory>
    复制代码
  • 验证规则是否精确:

    • 在终端利用以下命令测试 .gitignore 是否匹配目标文件:
      1. git check-ignore -v <file_name>
      复制代码

  
  五、参考文档

  

  • Git 官方文档 - 忽略文件
  • VS Code 官方文档 - 利用 Git
  • GitHub 官方 .gitignore 模板库
     ​
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

络腮胡菲菲

金牌会员
这个人很懒什么都没写!

标签云

快速回复 返回顶部 返回列表