envrc.el - Emacs的缓冲区本地direnv集成

这是一个GNU Emacs库，它使用direnv工具来确定每个目录/项目的环境变量，然后在每个缓冲区的基础上设置这些环境变量。这意味着当你在多个具有.envrc文件的项目之间工作时，从这些项目的缓冲区中启动的所有进程都将使用这些文件中指定的环境变量执行。这允许在每个项目中使用不同版本的代码检查工具和其他工具（如果需要）。

这与`direnv.el`有何不同？

direnv.el根据你正在工作的缓冲区，反复更改全局Emacs环境。

相反，envrc.el只是在每个缓冲区中设置和存储正确的环境，作为一个缓冲区本地变量。

从用户的角度来看，两者都经过充分测试，通常运行良好，但对我来说，envrc.el的方法感觉更加简洁。

安装

可安装的包可通过MELPA获得：执行M-x package-install RET envrc RET。

或者，下载最新版本或克隆仓库，然后用M-x package-install-file安装envrc.el。

使用

在你的init.el底部添加类似以下的代码片段：

(envrc-global-mode)

或

(add-hook 'after-init-hook 'envrc-global-mode)

或者，如果你是use-package的粉丝：

(use-package envrc
  :hook (after-init . envrc-global-mode))

为什么必须在启动序列的后期启用全局模式？通常，你希望在每个缓冲区中初始化envrc-mode之前初始化其他次要模式，比如flycheck-mode，这些模式可能会寻找可执行文件。与直觉相反，这意味着应该在其他全局次要模式之后启用envrc-global-mode，因为每个模式都会将自己前置到各种钩子中。

只有当direnv已安装并在默认的Emacs exec-path中可用时，全局模式才会生效。（还有一个本地次要模式envrc-mode，但你不应该尝试有选择性地启用它，例如针对某些模式或项目，因为编译和其他缓冲区可能无法获得正确的环境设置。）

关于与该模式的交互，请参见envrc-mode-map，以及命令envrc-reload、envrc-allow和envrc-deny。（目前还有envrc-reload-all作为"核弹式"重置！）

特别地，你可以通过在envrc-mode-map中将你喜欢的前缀绑定到envrc-command-map来为上述命令启用键绑定，例如：

(with-eval-after-load 'envrc
  (define-key envrc-mode-map (kbd "C-c e") 'envrc-command-map))

故障排除

如果你发现某个特定的Emacs命令没有获取到当前缓冲区的环境，并且你确定envrc-mode在该缓冲区中处于活动状态，那么你可能发现了在临时缓冲区中运行进程但在执行之前忽略了将你的环境传播到该缓冲区的代码。

有几个常见的Emacs命令存在这个缺陷，它们也通过envrc.el中的建议直接进行了修补 —— shell-command-to-string就是一个突出的例子！

inheritenv包被设计用来处理这种一般情况。

设计说明

默认情况下，Emacs有一组用于所有子进程的单一全局环境变量集，存储在process-environment变量中。direnv.el在用户执行某些操作时（如在不同项目的缓冲区之间切换）使用来自direnv的值切换该全局环境。

实际上，这很简单，而且大多数情况下运行得很好。但是有一些怪异之处，对我来说，为了支持每个目录的环境而改变全局环境感觉是错误的。

现在，在Emacs中，我们也可以在缓冲区中本地设置process-environment。如果可以根据各自的.envrc文件在所有缓冲区中正确维护这个值，那么跨多个项目的缓冲区就可以同时"连接"到其对应项目目录的环境。我编写envrc.el就是为了探索这种方法。

envrc.el使用一个全局次要模式（envrc-global-mode）来钩入Emacs创建的几乎每个缓冲区，包括隐藏和临时缓冲区。当发现一个缓冲区"位于"一个由.envrc管理的项目内时，通过运行direnv来设置缓冲区本地的process-environment，其结果也被无限期缓存，以使整体成本不会太高。每个缓冲区都有一个本地次要模式（envrc-mode），带有一个指示器，显示该缓冲区中是否有效的direnv。（钩入每个缓冲区很重要，而不仅仅是那些具有特定主要模式的缓冲区，因为经常使用单独的临时、编译和REPL缓冲区来执行进程。）

这种方法也有一些权衡：

像*Help*这样的缓冲区将基于最初创建它们的缓冲区的目录启用envrc-mode，而这些缓冲区通常会长期存在。如果你在处理不同项目时从这些缓冲区启动程序，结果可能不符合你的预期。我可能会排除某些模式以最小化混淆，但用户始终需要意识到环境是特定于缓冲区的这一事实。
每次创建缓冲区时都会有（非常小的）开销，而这种情况经常发生。
direnv更新不是自动的。direnv.el在切换到访问不同目录文件的缓冲区时重新执行direnv，而envrc-mode会缓存环境，直到用户使用envrc-reload显式刷新它。