git-link

用于在GitHub/Bitbucket/GitLab等代码仓库中为文件和提交创建URL的交互式Emacs函数。

git-link返回当前缓冲区文件在当前行号或活动区域的URL。

git-link-commit返回光标所在提交的URL。

git-link-homepage返回仓库主页的URL。

URL会被添加到剪贴环中。

使用方法

可以通过交互方式调用函数（M-x git-link）或通过自定义的按键绑定。例如：

(global-set-key (kbd "C-c g l") 'git-link)

使用单个前缀参数时会提示输入远程仓库名称。默认为"origin"。

使用双前缀参数时会反转git-link-use-commit的值。

使用-前缀参数时会生成不包含行号的链接。

也适用于Dired、Magit、VC修订版和Tramp。

设置

全局设置是Elisp变量。可以直接设置或通过M-x customize设置。

本地设置通过仓库的git配置管理。可以通过以下命令设置：

git config --local --add setting value

本地设置优先于全局设置。

全局

`git-link-default-remote`

要链接的远程仓库名称，默认为nil。

`git-link-default-branch`

要链接的远程分支名称，默认为当前分支。

`git-link-open-in-browser`

如果设为t，还会通过browse-url在浏览器中打开链接。要使用其他函数，请设置为该函数的符号。默认为nil。

`git-link-use-commit`

如果非nil，链接中使用最新提交的哈希值而不是分支名，默认为nil。

`git-link-use-single-line-number`

如果为nil，只有当选择包含多行时才添加行号，默认为t。

注意，使用-前缀参数调用git-link时会排除行号。

`git-link-add-to-kill-ring`

如果为t，链接将被添加到剪贴环中，默认为t。

`git-link-consider-ssh-config`

如果为t，考虑ssh配置文件来解析远程主机名。如果有匹配项（使用ssh -G），链接将生成到匹配的主机而不是远程主机。默认为nil。

本地

`git-link.remote`

要链接的远程仓库名称。

`git-link.branch`

要链接的远程分支名称。

支持的服务

Git Timemachine

如果git-timemachine-mode处于活动状态，git-link会为正在访问的文件版本生成URL。

cgit和Gitea

git-link提供了用于链接这些服务托管的仓库的函数，但由于它们是自托管的，没有默认的URL匹配。要使git-link与这些服务配合使用，您必须配置您的URL以使用适当的匹配函数。

cgit

(eval-after-load 'git-link
 '(progn
   (add-to-list 'git-link-remote-alist
     '("your-cgit\\.example\\.com" git-link-cgit))
   (add-to-list 'git-link-commit-remote-alist
     '("your-cgit\\.domain\\.tld" git-link-commit-cgit))))

Gitea

(eval-after-load 'git-link
 '(progn
   (add-to-list 'git-link-remote-alist
     '("your-gitea\\.example\\.com" git-link-gitea))
   (add-to-list 'git-link-commit-remote-alist
     '("your-gitea\\.domain\\.tld" git-link-commit-gitea))))

Sourcegraph

要链接到 Sourcegraph 服务器上的文件，请添加一个指向仓库 Sourcegraph 页面的 git 远程：

git remote add sourcegraph https://sourcegraph.com/github.com/sshaw/copy-as-format

可以通过在调用所需链接函数时指定 sourcegraph 作为远程或将 sourcegraph 设置为默认远程来生成链接。

注意远程可以命名为任何名称，但其 URL 的主机必须与相关链接函数的 alist 中的内容匹配。这默认为 "sourcegraph"，但可以更改。请参阅构建链接和添加服务。

带有端口或 http 协议的 URL 将不起作用。这是一个简单的修复，如果这对您来说是个问题，请提出问题。

构建链接和添加服务

git-link-remote-alist 是一个包含 (REGEXP FUNCTION) 元素的 alist。FUNCTION 为匹配 REGEXP 的远程主机名创建文件 URL。要添加（或修改）为给定主机创建 URL 的方式，请向此列表添加适当的元素。

例如，此 alist 中的一个默认元素是 ("gitlab" git-link-gitlab)。因此，git-link-gitlab 函数将用于为匹配正则表达式 "gitlab" 的远程创建文件 URL。这将涵盖常见的 Gitlab 主机 URL，如 "gitlab.com"、"gitlab.example.com" 和 "gitlab.example.org"。

git-link-commit-remote-alist 也是一个包含 (REGEXP FUNCTION) 元素的 alist。在这里，FUNCTION 为匹配 REGEXP 的远程主机创建提交页面的 URL。

如果您使用支持的服务的自托管版本，但您的远程 URL 与默认值不匹配，您可以配置这些链接函数 alist。例如，对于位于 gh.example.com 的 GitHub Enterprise 实例，您可以在 .emacs 文件中添加以下内容：

(eval-after-load 'git-link
 '(progn
   (add-to-list 'git-link-remote-alist
     '("gh\\.example\\.com" git-link-github))
   (add-to-list 'git-link-commit-remote-alist
     '("gh\\.example\\.com" git-link-commit-github))))

git-link 的签名是：

HOSTNAME DIRNAME FILENAME BRANCH COMMIT START END