Blamer.el 使用与配置指南

Blamer.el 使用与配置指南

blamer.el A git blame plugin for emacs inspired by VS Code's GitLens plugin 项目地址: https://gitcode.com/gh_mirrors/bl/blamer.el

1. 项目目录结构及介绍

Blamer.el 是一个为 Emacs 编辑器开发的 Git blame 插件，灵感来源于 VS Code 的 GitLens 插件。项目的目录结构如下：

blamer.el/
├── .gitignore        # Git 忽略文件列表
├── Eldev             # Emacs 开发工具配置文件
├── LICENSE           # 项目许可证文件
├── README.org        # 项目说明文档
├── blamer.el         # Blamer.el 主插件文件
├── test.el           # 测试文件
└── images/           # 存放项目相关图片的目录

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• Eldev：包含项目特定于 Emacs 的配置。
• LICENSE：项目使用的是 GPL-3.0 许可证。
• README.org：项目的详细说明文档，使用 Org 模式编写。
• blamer.el：Blamer.el 插件的核心实现文件。
• test.el：用于测试 Blamer.el 功能和性能的测试脚本。
• images/：存放项目示例图片或截图的目录。

2. 项目的启动文件介绍

Blamer.el 的启动非常简单，首先确保你的 Emacs 版本至少是 27.1。然后，可以通过以下几种方式进行安装：

• 使用 MELPA 仓库：

(use-package blamer
  :ensure t
  :bind (("s-i" . blamer-show-commit-info)
         ("C-c i" . blamer-show-posframe-commit-info))
  :defer 20
  :custom (blamer-idle-time . 0.3)
           (blamer-min-offset . 70)
  :custom-face (blamer-face ((t (:foreground "#7a88cf" :height 140 :italic t))))
  :config (global-blamer-mode 1))

• 使用 Quelpa：

(use-package blamer
  :quelpa ((blamer :fetcher github :repo "artawower/blamer.el"))
  :upgrade t
  :bind (("s-i" . blamer-show-commit-info)
         ("C-c i" . blamer-show-posframe-commit-info))
  :custom (blamer-idle-time . 0.3)
           (blamer-min-offset . 70)
  :custom-face (blamer-face ((t (:foreground "#7a88cf" :height 140 :italic t))))
  :config (global-blamer-mode 1))

• 手动下载安装：

下载 blamer.el 文件，然后将其添加到你的 Emacs 的加载路径中，并在你的初始化文件中 (require 'blamer)。

启动 Blamer.el 后，你可以在编辑器中查看每行代码的最后提交者信息。

3. 项目的配置文件介绍

Blamer.el 的配置主要通过修改其内置变量来实现，以下是一些主要配置选项：

• blamer-idle-time：设置在用户停止输入多长时间后显示 blame 信息。
• blamer-min-offset：设置显示 blame 信息的最小行偏移量。
• blamer-face：自定义 blame 信息的字体样式。
• blamer-view：设置 blame 信息的显示方式（如 overlay 或 overlay-right）。
• blamer-author-formatter：自定义作者名称的显示格式。
• blamer-datetime-formatter：自定义日期和时间的显示格式。
• blamer-commit-formatter：自定义提交信息的显示格式。

你可以在 Emacs 的初始化文件中或 Blamer.el 的配置部分设置这些变量，以满足个性化的显示需求。例如：

(setq blamer-idle-time 0.5)          ; 设置为 0.5 秒
(setq blamer-min-offset 40)          ; 设置为 40 个字符
(setq blamer-view 'overlay-right)   ; 设置显示在行号的右侧

通过上述配置，你可以定制化 Blamer.el 的行为，以适应你的工作流程和显示偏好。

blamer.el A git blame plugin for emacs inspired by VS Code's GitLens plugin 项目地址: https://gitcode.com/gh_mirrors/bl/blamer.el