jinx.el - 魔法拼写检查器

#+作者: Daniel Mendler #+语言: 中文 #+导出文件名: jinx.texi #+texinfo_dir_category: Emacs 杂项功能 #+texinfo_dir_title: Jinx: (jinx). #+texinfo_dir_desc: 魔法拼写检查器

Jinx 是一个快速的即时拼写检查器，专为 Emacs 设计。Jinx 会在缓冲区可见部分的文本中高亮显示拼写错误的单词。为了提高效率，Jinx 采用惰性高亮方式，能识别窗口边界和文本折叠（如果有）。例如，当展开折叠或滚动时，只会检查之前未检查过的新可见文本部分。每个拼写错误都可以从字典单词列表中进行更正，这些建议以补全菜单的形式呈现。

安装 Jinx 非常简单，配置也不需要太多干预。Jinx 可以完全独立使用，也可以与 Emacs 内置的拼写检查器 Ispell 安全共存。

Jinx 的高性能和低资源消耗得益于直接调用广泛使用的 Enchant 库 API（参见 [[https://abiword.github.io/enchant/][libenchant]]）。Jinx 会在启动时自动编译 =jinx-mod.c= 并加载动态模块。通过直接绑定到原生 Enchant API，Jinx 避免了与 Aspell 进行较慢的后端进程通信。Enchant 被其他文本编辑器广泛使用，支持 [[https://nuspell.github.io/][Nuspell]]、[[http://hunspell.github.io/][Hunspell]]、[[http://aspell.net/][Aspell]] 以及一些特定语言的后端。

Jinx 支持在同一缓冲区中检查多种语言的拼写。可以通过 =jinx-languages= 变量自定义多语言支持。Jinx 可以灵活地忽略拼写错误，可以通过字体（=jinx-exclude-faces= 和 =jinx-include-faces=）、正则表达式（=jinx-exclude-regexps=）以及可编程的谓词来实现。Jinx 预先配置了最重要的 Emacs 主模式。Java、Ruby 或 Rust 等模式列在 =jinx-camel-modes= 中。对于这些模式，=camelCase= 和 =PascalCase= 的复合词会被接受。

• 安装

可以直接通过 =package-install= 从 GNU ELPA 或 MELPA 安装 Jinx。

Jinx 需要 =libenchant=。Enchant 库是 Jinx 在安装时编译其模块所必需的依赖项。如果在安装 Jinx 时可以使用 =pkgconf= 或 =pkg-config=，Jinx 将使用它来定位 =libenchant=。根据您的 BSD 或 Linux 发行版，您需要安装不同的包：

• Debian, Ubuntu: =libenchant-2-dev=, =pkgconf=
• Arch, Gentoo: =enchant=, =pkgconf=
• Guix: 在 =emacs-xyz.scm= 中定义的 =emacs-jinx=
• Nix: 在 =elpa-packages.nix= 中定义的 =jinx=
• Void, Fedora: =enchant2-devel=, =pkgconf=
• OpenSUSE: =emacs-jinx= 或 =enchant=, =pkgconf=
• FreeBSD, OpenBSD, Mac: =enchant2=, =pkgconf=

在 Windows 上安装原生模块可能需要手动干预。

• 配置

Jinx 有两种模式：命令 =global-jinx-mode= 全局激活；命令 =jinx-mode= 用于特定模式的激活。

#+begin_src emacs-lisp ;; 方案 1：全局启用 Jinx (add-hook 'emacs-startup-hook #'global-jinx-mode)

;; 方案 2：按模式启用 Jinx (dolist (hook '(text-mode-hook prog-mode-hook conf-mode-hook)) (add-hook hook #'jinx-mode)) #+end_src

命令 =jinx-correct= 和 =jinx-languages= 被标记为自动加载。调用 =jinx-correct= 可以纠正拼写错误。将 =jinx-correct= 绑定到 =M-$= 会接管默认分配给 =ispell-word= 的该键。由于 Jinx 独立于 Ispell 包，=M-$= 可以被重新使用。

#+begin_src emacs-lisp (keymap-global-set "M-$" #'jinx-correct) (keymap-global-set "C-M-$" #'jinx-languages) #+end_src

• =M-$= 触发光标前拼写错误单词的纠正。
• =C-u M-$= 触发整个缓冲区的纠正。
• =C-u C-u M-$= 强制纠正光标处的单词，即使它没有拼写错误。

这里展示了一个使用流行的 =use-package= 宏的示例配置：

#+begin_src emacs-lisp (use-package jinx :hook (emacs-startup . global-jinx-mode) :bind (("M-$" . jinx-correct) ("C-M-$" . jinx-languages))) #+end_src

更多配置技巧请参阅 [[https://github.com/minad/jinx/wiki][Jinx Wiki]]。该 wiki 记录了将拼写错误保存为全局缩写以及支持 Ispell =LocalWords= 的配置。

• 纠正拼写错误

纠正拼写错误最简单的方法是右键单击带有波浪线下划线的单词。然后会打开一个上下文菜单，您可以从中选择建议。 如果您更喜欢使用键盘，可以调用命令 =jinx-correct=。推荐的绑定是 =M-$=，详见配置部分。建议的更正会以补全菜单的形式显示。您可以按显示的数字键快速选择建议。此外，菜单还提供了将单词临时保存到当前会话、个人词典或文件局部变量中的选项。

您可以在更正提示符处输入任意内容，以进行更正或将修改后的单词存储在个人词典中。例如，如果您输入了 =alotriomorpc=，提示符会提供 =@alotriomorpc= 选项，选择后会将此单词添加到您的个人词典中。然后您可以将选项更正为 =@allotriomorphic= 并将其添加到词典中。

在 =jinx-correct= 提示符中，=M-n= 和 =M-p= 键分别绑定到 =jinx-next= 和 =jinx-previous=，允许您移动到下一个和上一个拼写错误的单词。

补全菜单与所有流行的补全 UI 兼容：Vertico、Mct、Icomplete、Ivy、Helm 和默认的补全缓冲区。如果您使用 Vertico，我建议您通过 =vertico-multiform-mode= 为补全类别 =jinx= 调整补全显示。例如，您可以使用网格显示，以便更多建议能够适应屏幕，并启用注释。

#+begin_src emacs-lisp (add-to-list 'vertico-multiform-categories '(jinx grid (vertico-grid-annotate . 20))) (vertico-multiform-mode 1) #+end_src

• 在拼写错误之间导航

使用 =jinx-correct= 更正单词时，移动命令 =jinx-next= 和 =jinx-previous= 分别可通过 =M-n= 和 =M-p= 键使用，以导航到下一个和上一个拼写错误。这些移动命令在 =jinx-correct= 期间的迷你缓冲区内以及在迷你缓冲区上下文之外全局有效。

虽然默认情况下这些命令没有全局绑定，但当光标位于拼写错误的单词覆盖层上时，它们可以通过 =M-n= 和 =M-p= 使用。如果您愿意，可以将它们和其他命令添加到 =jinx-mode-map= 中，使它们始终可用，不受光标位置的影响。如果启用了 Emacs 28 中的 =repeat-mode=，可以使用 =n= 和 =p= 键重复移动。

• Enchant 后端和个人词典

Enchant 为不同的语言使用不同的后端。后端的排序按照个人配置文件 =~/.config/enchant/enchant.ordering= 和系统范围的配置文件 =/usr/share/enchant-2/enchant.ordering= 中的指定顺序排列。Enchant 对大多数语言默认使用 Hunspell 作为后端。有几个例外。对于英语，Enchant 偏好使用 Aspell，而对于芬兰语和土耳其语，则使用名为 Voikko 和 Zemberek 的特殊后端。在某些操作系统上，Enchant 还可能与系统拼写检查器集成。

根据后端的不同，个人词典将从不同的位置获取，例如 =/.aspell.LANG.pws= 或 =/.config/enchant/LANG.dic=。可以通过符号链接不同的个人词典，使它们能够被不同的拼写检查器共享。详情请参阅 [[https://abiword.github.io/enchant/lib/enchant.html][Enchant 手册]]。

• 替代拼写检查包

Emacs 中存在多个替代的拼写检查包，最著名的是内置的 ispell.el 和 flyspell.el 包。Jinx 的主要优势在于自动检查可见文本、高度关注性能以及轻松同时使用多个词典的能力。以下三个替代包的行为最接近 Jinx。

• [[https://github.com/astoff/jit-spell][jit-spell]]：Jinx UI 借鉴了 Augusto Stoffel 的 Jit-spell 的想法。Jit-spell 使用效率较低的 Ispell 进程通信，而不是 Jinx 调用原生 API。由于 Jit-spell 不限制仅对可见文本进行拼写检查，它可能会过于急切地将整个缓冲区排队进行检查。这种情况在滚动或启用隐蔽字体锁定时会发生。因此，在我的测试中，Jit-spell 影响了加载和延迟（[[https://github.com/astoff/jit-spell/issues/9][GitHub 上的问题]]）。

• [[https://codeberg.org/ideasman42/emacs-spell-fu][spell-fu]]：仅检查可见文本中的单词的想法来自 Campbell Barton 的 spell-fu 包。Spell-fu 速度快，但由于其哈希表中的词典而产生高内存开销。对于具有复合词和屈折词形的语言，这种开销会放大（[[https://codeberg.org/ideasman42/emacs-spell-fu/issues/40][Codeberg 上的问题]]）。通过直接访问 Enchant API，Jinx 避免了任何开销。Jinx 还受益于 Enchant 的高级拼写检查算法（词缀、复合词等）。

• flyspell：Flyspell 是一个内置包。Flyspell 在输入时突出显示拼写错误。只检查光标下的单词。相比之下，Jinx 更有效，因为它会自动检查缓冲区中整个可见文本的拼写错误。Flyspell 可以检查整个缓冲区，但必须通过 =flyspell-buffer= 命令指示这样做。

• 贡献

由于这个包是 [[https://elpa.gnu.org/packages/jinx.html][GNU ELPA]] 的一部分，贡献需要向 FSF 进行版权转让。