学习笔记003《在VS Code与PyCharm中使用gitlens插件的教程》

1,358 阅读6分钟

【上海赛申宇机电科技有限公司】 www.saisenyoo.cn 荣誉出品

GitLens 是一个非常强大的 Git 扩展,可以极大地增强 VS Code 和 PyCharm(以及其他 JetBrains IDE)中的 Git 使用体验。我将分别介绍 GitLens 在这两款 IDE 中的详细使用教程。

GitLens 在 VS Code 中的使用教程

  1. 安装 GitLens

    • 打开 VS Code。
    • 点击左侧的扩展图标(或按 Ctrl+Shift+X)。
    • 搜索 "GitLens",点击安装。
  2. 主要功能和界面

    GitLens 的功能非常丰富,主要通过以下几种方式呈现:

    • 当前行 Blame 注解: 在编辑器中,光标所在行的末尾会显示该行最后一次提交的信息(提交者、时间、提交消息)。
    • 行 Blame 侧边栏: 鼠标悬停在当前行 Blame 注解上时,会显示一个更详细的侧边栏,包括完整的提交信息、提交 ID、文件更改等。
    • 热力图(Heatmap): 在编辑器左侧的滚动条旁边,会显示一个热力图,颜色越深表示修改越近。
    • 状态栏: VS Code 状态栏会显示当前分支、未提交更改数、领先/落后提交数等信息。
    • 源代码管理视图(Source Control View): VS Code 左侧的 Git 图标,GitLens 增强了该视图,提供了更丰富的仓库信息、分支管理、提交历史等功能。
    • GitLens 侧边栏: 点击 VS Code 左侧活动栏中的 GitLens 图标,可以打开 GitLens 专属侧边栏,其中包含多个视图:
      • Repositories(仓库): 浏览当前仓库和子模块。
      • File History(文件历史): 查看当前文件的提交历史。
      • Line History(行历史): 查看当前行的提交历史。
      • Branches(分支): 管理分支、切换分支、创建分支、合并分支等。
      • Commits(提交): 查看提交历史、比较提交、搜索提交等。
      • Stashes(储藏): 管理储藏的更改。
      • Tags(标签): 管理标签。
      • Remotes(远程): 管理远程仓库。
      • Search & Compare(搜索和比较): 搜索提交、比较分支或提交等。
      • Interactive Rebase(交互式变基): 执行交互式变基操作。
    • 命令面板(Command Palette): 按 Ctrl+Shift+P(或 Cmd+Shift+P)打开命令面板,输入 "GitLens" 可以查看所有 GitLens 提供的命令。
  3. 常用操作

    • 查看当前行 Blame 信息:
      • 直接看编辑器中光标所在行末尾的注解。
      • 鼠标悬停在注解上,查看更详细的侧边栏。
      • 点击侧边栏中的提交 ID,可以打开该提交的详细信息。
    • 查看文件历史:
      • 在 GitLens 侧边栏中选择 "File History" 视图。
      • 在编辑器中右键单击,选择 "GitLens: Show File History"。
      • 使用命令面板,输入 "GitLens: Show File History"。
    • 查看行历史:
      • 在 GitLens 侧边栏中选择 "Line History" 视图。
      • 在编辑器中右键单击某一行,选择 "GitLens: Show Line History"。
    • 比较文件版本:
      • 在文件历史视图中,选择两个提交,右键单击,选择 "Compare with Each Other"。
      • 在编辑器中右键单击,选择 "GitLens: Compare with...",然后选择要比较的版本。
    • 管理分支:
      • 在 GitLens 侧边栏中选择 "Branches" 视图。
      • 在状态栏中点击当前分支名称,可以切换分支或创建新分支。
    • 查看提交历史:
      • 在 GitLens 侧边栏中选择 "Commits" 视图。
      • 在源代码管理视图中查看提交历史。
    • 搜索提交:
      • 在 GitLens 侧边栏中选择 "Search & Compare" 视图。
    • 执行交互式变基:
      • 在 GitLens 侧边栏中选择 "Interactive Rebase" 视图。
      • 在源代码管理视图中,右键单击某个提交,选择 "Rebase Interactive...".
    • 更多操作: 通过命令面板或 GitLens 侧边栏中的各个视图,可以执行更多操作。

GitLens 在 PyCharm 中的使用教程

  1. 安装 GitLens

    • 打开 PyCharm。
    • 进入 File -> Settings(或 PyCharm -> Preferences)。
    • 选择 Plugins。
    • 在 Marketplace 标签中搜索 "GitLens",点击 Install。
    • 重启 PyCharm。
  2. 主要功能和界面

    GitLens 在 PyCharm 中的功能与 VS Code 中类似,但界面略有不同:

    • 当前行 Blame 注解: 同样在编辑器中光标所在行末尾显示。
    • 行 Blame 工具提示: 鼠标悬停在注解上时显示更详细的信息。
    • 热力图: 在编辑器左侧的滚动条旁边显示。
    • 状态栏: PyCharm 状态栏显示当前分支、未提交更改数等信息。
    • Version Control 工具窗口: PyCharm 底部工具栏中的 Version Control 窗口(通常是 Git 标签),GitLens 增强了该窗口,提供了更丰富的仓库信息、分支管理、提交历史等功能。
    • GitLens 工具窗口: 通过 View -> Tool Windows -> GitLens 可以打开 GitLens 专属工具窗口,其中包含多个视图,与 VS Code 中的 GitLens 侧边栏类似。
    • 右键菜单: 在编辑器中右键单击,GitLens 会在 Git 子菜单中添加一些额外的选项。
    • Annotate with GitLens: 在编辑器中右键单击,选择 "Annotate with GitLens",可以在每行代码旁边显示 Blame 信息。
  3. 常用操作

    • 查看当前行 Blame 信息:
      • 直接看编辑器中光标所在行末尾的注解。
      • 鼠标悬停在注解上,查看更详细的工具提示。
    • 查看文件历史:
      • 在 GitLens 工具窗口中选择 "File History" 视图。
      • 在编辑器中右键单击,选择 "Git" -> "Show History"。
      • 在 Version Control 工具窗口中选择 "Log" 标签。
    • 查看行历史:
      • 在 GitLens 工具窗口中选择 "Line History" 视图。
      • 在编辑器中右键单击某一行,选择 "Git" -> "Show History for Selection"。
    • 比较文件版本:
      • 在文件历史视图中,选择两个提交,右键单击,选择 "Compare Versions"。
      • 在编辑器中右键单击,选择 "Git" -> "Compare with...",然后选择要比较的版本。
    • 管理分支:
      • 在 GitLens 工具窗口中选择 "Branches" 视图。
      • 在状态栏中点击当前分支名称,可以切换分支或创建新分支。
      • 在 Version Control 工具窗口中选择 "Branches" 标签。
    • 查看提交历史:
      • 在 GitLens 工具窗口中选择 "Commits" 视图。
      • 在 Version Control 工具窗口中选择 "Log" 标签。
    • 搜索提交:
      • 在 GitLens 工具窗口中选择 "Search & Compare" 视图。
    • 执行交互式变基:
      • 在 Version Control 工具窗口中,右键单击某个提交,选择 "Interactively Rebase from Here...".
    • 更多操作: 通过 GitLens 工具窗口、Version Control 工具窗口、右键菜单等,可以执行更多操作。

总结

GitLens 在 VS Code 和 PyCharm 中都提供了强大的 Git 功能增强,可以帮助你更轻松地查看代码历史、比较版本、管理分支、搜索提交等。虽然两者的界面略有不同,但核心功能是相似的。

建议你花一些时间探索 GitLens 的各个视图和功能,找到最适合你的工作流程的使用方式。GitLens 的官方文档也提供了非常详细的说明:

希望这些教程对你有帮助!