A fast and incredible Emacs config

Table of Contents

• 个人Emacs配置
• 需要的依赖
• 基础配置
• 插件配置、升级
• 界面
• 趁手的工具
• 按键绑定
  • evil-mode
  • Emacs
• 通用开发设置
• prog-mode
  • cc-mode
  • rust-mode
  • ocaml-mode
  • haskell-mode
• 截图
• FAQ
• 其他

个人Emacs配置

仿 Centaur Emacs 的个人配置.

git clone --depth 1 https://github.com/condy0919/.emacs.d ~/.emacs.d

仅包含C/C++/Rust/OCaml/Haskell相关配置，且全线使用lsp。当前由于haskell-ide-engine水土不服，故haskell没有采用lsp。

保持着尽量使用Emacs自带功能的原则，能用自带的就用自带的。

需要的依赖

• hunspell 拼写检查，目前仅在git-commit-mode下启用
• rg 更快的grep
• pandoc (optional) 文本转换工具，markdown-mode渲染需要
• markdown (optional) 文本转换工具，markdown-mode渲染需要
• cmake c++项目的构建工具
• git 这个就不用说了吧？
• gcc 这个就不用说了吧？
• fd (optional) 更现代的 find, projectile 会自动检测
• languagetool (optional) 更好的拼写检查、语法纠错工具

基础配置

最基础的配置包含了那些在所有mode下都不会变更的配置，包含了：

而这几个包也是Emacs自带的。

为了保持界面的整洁，禁用了菜单栏、工具栏和滚动条。

在跳转之后会闪烁一下当前行，这样就比较容易知道当前光标在哪里了。这个功能也是基于自带的pulse。

插件配置、升级

选用use-package来管理插件。对于elpa, melpa里没有的包，使用quelpa辅助下载。为什么我会从straight.el切换至quelpa呢？主要是straight.el不支持单个文件的下载、配置，见init-cpp.el内的llvm-mode配置项。

而自动升级选择了auto-package-update这个包。如果需要更新，M-x auto-package-update-now即可。需要注意的是，更新是同步的。

注意：

llvm-mode和tablegen-mode下载通过raw.githubusercontent.com，而这个域名在国内几乎不可达，需要科学上网。因此现在已使用gitee的镜像服务来中转。

界面

使用了doom-themes和doom-modeline，简直惊艳！doom-one的界面非常好看！

趁手的工具

which-key,rg是比较常用的工具。更有projectile管理项目，让项目编译、测试、运行变得更加方便。而且还有counsel-projectile的加成，在原有projectile的基础上又添加了许多ivy action，更一步提升了便捷性。

avy用来代替vim-easymotion。而且avy还提供了goto-line的功能，这下都不用开相对行号8k 9j这样跳了。

自然ivy,counsel是要上的，补全功能太好用了。没有counsel加持的M-x根本无法让人按下去。这里推荐尽量使用isearch，因为swiper下方占用空间过大(继承于ivy的设置)，搜索时必然是比较在意上下文的。而自带的isearch在稍加设置之后，效果也还可以接受。当evil-search-module设置成isearch后，也可以使用相同的快捷键来触发ivy-occur。再加上ivy-occur可以与wgrep配合，将原来的「搜索、打开对应文件、修改」变成了「搜索、修改」。

Emacs下的org-mode/markdown-mode让人惊艳，突然觉得写文档也会这么快乐。与之相辅相成的还有separedit，让人在代码里写documentation comments不再烦恼。

valign 提供了像素级别的表格对齐，终于不用再靠西文半宽的字体了！

从neovim迁移过来的我，自然是常开evil-mode，相关的evil套件有:

• evil
• evil-collection (已包含 evil-magit)
• evil-surround

按键绑定

evil-mode

normal状态下增加了如下键绑定:

avy真乃神器也！

同时，因为开启了evil-collection-want-unimpaired-p (由evil-collection提供) 而获得了如下键绑定:

本配置里使用hideshow来fold代码块。由于hideshow本身提供的快捷键非常长，非常推荐使用evil-mode在normal状态下定义的键绑定。

此外另外提供了一个Leader键，绑定在了SPC键上。

special-mode专用。通常在special-mode里会定义一个SPC用来翻页 (如Info)，但是由于SPC已经作为Leader键了。这里曲线救国，用SPC SPC来代替原来的SPC单键行为，并且会进入transient状态，接下来仅按SPC即可触发原函数。

与文件相关的Leader键绑定如下:

与目录相关的Leader键绑定如下:

与buffer、bookmark相关的键绑定:

打开其他程序的Leader键绑定:

打开一些看起来像是独立的应用:

搜索相关的Leader键绑定:

与文本相关的Leader键绑定:

与代码相关的Leader键绑定:

Emacs

因为projectile比较常用，把它单独拿出来 说。本配置中还使用了counsel-projectile来令projectile更加方便。

基于同样的理由，把flycheck单独拎了出来。

更详细的按键绑定请直接看代码. :-)

定义了一组hydra，通过调用avy与thing-at-point函数，快速复制对应光标处的内容。为了在编辑模式中也能够使用，将其绑定在了C-c h c上。C-c h是所有hydra的前缀，目前有3个，分别是:

1. hydra-copy通过avy用来快速拷贝
2. hydra-macro方便执行kmacro
3. hydra-other-window-scroll在不改变焦点的情况下移动另一窗口的buffer

通用开发设置

• 显示行末空白字符
• 高亮TODO FIXME等关键字
• dumb-jump作为lsp-find-definition失败后的备份手段
• magit作为git客户端
• hideshow来显示/隐藏结构化的代码块，如 "{ }" 函数体等
• rmsbolt作为一个本地的 Compiler Explorer 相比于godbolt友好一点
• ispell拼写检查器, evil用户可以快速通过z= (ispell-word) 来检查
• flyspell拼写检查器，仅在magit写提交信息时启用
• quickrun作为一个能够执行部分区域内的代码块，方便快速验证函数功能
• tempo作为代码片段展开工具, spdx然后再M-x tempo-expand-if-complete即可

prog-mode

cc-mode

使用lsp-mode作为补全、符号查找的工具，默认后端使用clangd，一般发行版的源里都 会有对应的包。如果想使用ccls，可以customize对应的变量:

(setq lsp-clients-clangd-executable "ccls"
      lsp-clients-clangd-args nil)

如果想使用ccls的lsp扩展功能，需要安装ccls扩展。

禁用了flycheck自带的3个checker(分别为c/c++-clang, c/c++-cppcheck, c/c++-gcc)，因为它们都无法正确包含自定义的头文件路径。

此外，

• c++-mode启用了modern-cpp-font-lock
• cmake-mode可使用company-mode进行符号补全
• 启用了hide-ifdef-mode，可以令#if 0到#endif之间的代码看起来像注释一样。也可以#define一些宏，放入hide-ifdef-env中生效。
• 部分常用snippet，如ifndef,main等等。详细列表见init-cpp.el文件
• cmake-mode增加了一个简单 lib 的snippet，可以通过lib关键字展开

rust-mode

使用lsp-mode作为补全、符号查找的工具，默认后端使用rls,一般发行版会把它直接跟rust绑在一起，也可以使用rustup来安装。对于rust-analyzer用户而言，通过设置

(setq lsp-rust-server 'rust-analyzer)

来切换至rust-analyzer。

当然，

• rust-mode开启了保存时格式化文件，需要确保rustfmt二进制包存在
• 使用了cargo来提供深度集成化的cargo命令

ocaml-mode

使用lsp-mode作为补全、符号查找的工具。在Arch Linux上，可以使用 ocaml-lsp-git 这个包。

由于ocaml-lsp-git目前只实现了lsp-format-buffer且额外依赖ocamlformat。

所以这里额外使用了ocp-indent，通过ocp-indent-region, ocp-indent-buffer来提供格式化代码的功能。

同时也集成了dune。

ocp-indent和dune都依赖系统级别的包。

如果你是Arch Linux可以直接通过如下命令安装:

yay -S ocaml-ocp-indent dune

haskell-mode

• 使用 dante

截图

FAQ

1. dashboard 里图标显示不正确？ 依赖 all-the-icons, 请确保M-x all-the-icons-install-fonts安 装对应的字体以显示图标。
2. 更新时提示对应版本的包不存在？ 这多是因为国内镜像源同步慢导致的。如果出错，可以临时禁用镜像源。

(setq package-archives
      '(("melpa"  . "https://melpa.org/packages/")
        ("gnu"    . "https://elpa.gnu.org/packages/")
        ("nongnu" . "https://elpa.nongnu.org/nongnu/")))

3. 如果升级包遇到了错误，可以使用 init-mini.el 这个最小的配置来 启动。

emacs -Q -l init-mini.el

其他

欢迎提issue给出建议，感谢！