Affe.el 开源项目教程

Affe.el 开源项目教程

affe :monkey: affe.el - Asynchronous Fuzzy Finder for Emacs 项目地址: https://gitcode.com/gh_mirrors/af/affe

1. 项目介绍

Affe.el 是一个用于 Emacs 的异步模糊查找器，类似于命令行中的 fzf 模糊查找器，但完全用 Elisp 编写。它通过在后台启动一个生产者进程（如 find 或 grep）来生成输出，并通过外部异步 Emacs 进程进行过滤。这使得 Emacs 的 UI 始终保持响应，因为工作被卸载到其他进程中。结果通过 Consult 在 minibuffer 中显示，允许用户快速从可用项目中进行选择。

2. 项目快速启动

安装

Affe.el 可以通过 MELPA 安装。首先，确保你的 Emacs 配置中启用了 MELPA 包管理器：

(require 'package)
(add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t)
(package-initialize)

然后，使用 package-install 命令安装 Affe：

(package-install 'affe)

配置

安装完成后，你可以通过 use-package 进行配置。例如，设置 affe-grep 的手动预览键：

(use-package affe
  :config
  ;; 手动预览键
  (consult-customize affe-grep :preview-key "M-."))

使用

安装并配置完成后，你可以使用以下命令进行模糊查找：

• affe-grep: 过滤当前目录下所有文本文件的内容，类似于 consult-grep。
• affe-find: 过滤当前目录下所有文件的路径，类似于 consult-find。

3. 应用案例和最佳实践

应用案例

1. 快速查找文件内容：在大型项目中，使用 affe-grep 可以快速查找包含特定字符串的文件内容，而不会阻塞 Emacs 的 UI。
2. 文件路径查找：使用 affe-find 可以快速查找项目中的文件路径，特别是在文件结构复杂的情况下。

最佳实践

• 使用 Orderless 进行高级匹配：为了获得更好的匹配效果，建议配置 Orderless 作为 affe-regexp-compiler：

(defun affe-orderless-regexp-compiler (input _type _ignorecase)
  (setq input (cdr (orderless-compile input)))
  (cons input (apply-partially #'orderless--highlight input t)))

(setq affe-regexp-compiler #'affe-orderless-regexp-compiler)

• 自定义生产者进程：你可以通过调整 affe-find-command 和 affe-grep-command 变量来自定义生产者进程的命令。

4. 典型生态项目

Affe.el 依赖于以下项目，并与之配合使用效果最佳：

• Consult：提供有用的搜索和导航命令（Affel 的依赖项）。
• Marginalia：在 minibuffer 中显示文件注释。
• Embark：在 minibuffer 中对文件执行操作。
• Orderless：高级完成样式，可以与 Affe 结合使用。
• Vertico 或 Mct：垂直完成系统。

这些项目共同构成了一个强大的 Emacs 开发环境，特别是在处理大型项目时，能够显著提高工作效率。

affe :monkey: affe.el - Asynchronous Fuzzy Finder for Emacs 项目地址: https://gitcode.com/gh_mirrors/af/affe