Corfu 项目安装与配置指南

Corfu 项目安装与配置指南

corfu :desert_island: corfu.el - COmpletion in Region FUnction 项目地址: https://gitcode.com/gh_mirrors/cor/corfu

1. 项目基础介绍

Corfu 是一个为 Emacs 编辑器提供内联补全功能的开源项目。它通过显示一个小型的补全弹出窗口来增强缓冲区内的补全体验。当前候选的补全项会显示在光标下方或上方的弹出窗口中，用户可以通过上下键来选择。Corfu 是 Vertico 的内联补全界面对应物，专注于提供一个精致的补全用户界面。

主要编程语言：Emacs Lisp

2. 项目使用的关键技术和框架

• Emacs completion facilities：Corfu 依赖于 Emacs 的补全设施，并专注于提供补全用户界面。
• completion-in-region：Corfu 可以钩入 Emacs 的 completion-in-region 功能，实现与用户的交互。
• pluggable backends：Corfu 不包含自己的补全后端，而是依赖 Emacs 内置的补全后端和第三方编程语言包提供的补全后端。
• Orderless：Corfu 支持 Orderless 补全风格，提供比默认补全风格更灵活的过滤方式。

3. 项目安装和配置准备工作

在开始安装前，请确保您的系统中已经安装了以下软件：

• Emacs 编辑器（版本至少为 31，以支持子框架，如果是更老的版本，则需要安装 corfu-terminal 包）

安装步骤

1. 打开 Emacs 编辑器。
2. 在 Emacs 中运行 M-x package-list-packages 命令，这将打开包列表。
3. 在包列表中搜索 corfu，然后标记它进行安装（使用 i 键）。
4. 安装完成后，关闭包列表窗口。
5. 运行 M-x global-corfu-mode 命令来激活全局的 Corfu 模式。
6. 为了使用补全功能，您需要在缓冲区中按下 M-TAB（或者 TAB）键。

配置推荐

Corfu 可以通过 corfu-* 自定义变量进行灵活配置。以下是一个基本的配置示例，您可以在 init.el 文件中添加这些配置：

(use-package corfu
  :init
  (global-corfu-mode)) ; 开启全局 Corfu 模式

如果需要进行更详细的配置，您可以参考项目 README 文件中的示例配置。

完成以上步骤后，您就已经成功安装并配置了 Corfu 项目，可以开始享受更流畅的 Emacs 补全体验了。

corfu :desert_island: corfu.el - COmpletion in Region FUnction 项目地址: https://gitcode.com/gh_mirrors/cor/corfu