Cape 使用教程

Cape 使用教程

cape 🦸cape.el - Completion At Point Extensions 项目地址: https://gitcode.com/gh_mirrors/cape3/cape

1. 项目介绍

Cape 是一个为 Emacs 编辑器提供的 Completion At Point（CAPF）扩展库。它允许用户将不同的补全后端（称为 CAPFs）整合到 Emacs 的补全机制中，无论是与 Corfu、Company 还是默认的补全界面一起使用。Cape 提供了一系列预定义的 CAPFs，例如代码片段补全、历史记录补全、文件名补全等，并且支持将 Company 补丁后端转换为 CAPF。

2. 项目快速启动

首先，确保你的 Emacs 系统已经安装了以下依赖项：

• Emacs 26.1 或更高版本
• Corfu（可选，用于更好的补全界面体验）

接下来，你可以通过以下步骤快速启动 Cape：

;; 安装 Corfu（如果尚未安装）
(use-package corfu
  :init
  (global-corfu-mode))

;; 安装 Cape
(use-package cape
  :bind
  ("C-c p" . cape-prefix-map) ; 绑定前缀键，按下 C-c p 可访问 Cape 命令
  :init
  (add-hook 'completion-at-point-functions #'cape-dabbrev) ; 添加字典补全
  (add-hook 'completion-at-point-functions #'cape-file)   ; 添加文件名补全
  (add-hook 'completion-at-point-functions #'cape-elisp-block)) ; 添加 Elisp 代码块补全

将以上代码片段加入到你的 Emacs 配置文件中（通常是 ~/.emacs 或 ~/.emacs.d/init.el），然后重启 Emacs。

3. 应用案例和最佳实践

以下是一些使用 Cape 的案例和最佳实践：

• 代码片段补全：使用 cape-line 可补全当前缓冲区中的整行代码，这对于快速复用代码模板非常有用。
• 历史记录补全：在 Shell 或 Comint 模式下，cape-history 允许你补全历史命令。
• 文件名补全：cape-file 提供了类似于命令行中的文件名补全功能，非常方便。

你可以通过绑定快捷键来直接调用这些功能，例如：

(define-key cape-prefix-map "l" 'cape-line)
(define-key cape-prefix-map "h" 'cape-history)
(define-key cape-prefix-map "f" 'cape-file)

4. 典型生态项目

Cape 作为 Emacs 的一个扩展库，其生态中还包括了以下一些项目：

• Corfu：一个基于 cape 的补全用户界面，提供了更为流畅的补全体验。
• Company：一个补全框架，虽然与 Cape 是独立的，但可以通过 Cape 的适配器与 Cape 集成。
• various completion backends：各种补全后端，如 Company 的后端，可以与 Cape 一起使用，以提供更多种类的补全功能。

通过以上教程，你应该能够开始使用 Cape 并探索其功能。享受 Emacs 的补全体验吧！

cape 🦸cape.el - Completion At Point Extensions 项目地址: https://gitcode.com/gh_mirrors/cape3/cape