treesit-auto 使用教程

treesit-auto 使用教程

1. 项目介绍

treesit-auto 是一个为 Emacs 编辑器设计的插件，它能够自动安装并使用 tree-sitter 的主要模式。tree-sitter 是一个解析器生成器，它可以生成快速和准确的语法解析器。treesit-auto 插件允许 Emacs 用户在打开支持 tree-sitter 的文件时，自动切换到对应的 tree-sitter 模式，如果相应的语法未安装，则会提供回退到原始模式的功能。

2. 项目快速启动

首先，确保你的 Emacs 版本为 29 或更高版本，因为 treesit-auto 依赖于 Emacs 29 中的 tree-sitter 支持。

安装

通过 MELPA 仓库安装 treesit-auto：

M-x package-refresh-contents
M-x package-install RET treesit-auto

或者，如果你想从源代码克隆仓库，可以使用以下命令：

M-x package-vc-install RET https://github.com/renzmann/treesit-auto.git

接下来，在你的 Emacs 配置文件 (~/.emacs.d/init.el) 中添加以下配置：

(use-package treesit-auto
  :config
  (global-treesit-auto-mode))

这将为所有支持 tree-sitter 的文件自动启用 treesit-auto 模式。

3. 应用案例和最佳实践

自动安装语法

当你打开一个文件，其对应的 tree-sitter 语法尚未安装时，treesit-auto 可以自动安装它。要启用此功能，可以在配置中设置 treesit-auto-install 变量：

(use-package treesit-auto
  :custom
  (treesit-auto-install 'prompt)
  :config
  (global-treesit-auto-mode))

这将显示一个提示，询问是否安装缺失的语法。

自定义语言行为

如果你想要为特定语言指定不同的行为，可以通过修改 treesit-auto-recipe-alist 来实现：

(treesit-auto-recipe-remap '(lang . new-mode))

自动添加到 auto-mode-alist

要确保 tree-sitter 模式被添加到 auto-mode-alist，可以使用 treesit-auto-add-to-auto-mode-alist 函数：

(treesit-auto-add-to-auto-mode-alist 'all)

这将自动为所有已安装的 tree-sitter 语法添加对应的模式。

4. 典型生态项目

以下是一些与 treesit-auto 相关的典型生态项目：

• treesit：Emacs 中的 tree-sitter 支持。
• tree-sitter：Tree-sitter 解析器生成器。
• emacs-tree-sitter：Emacs 官方 tree-sitter 支持的仓库。

以上教程介绍了 treesit-auto 的基本使用方法，以及如何在 Emacs 中自动安装和管理 tree-sitter 语法。通过使用 treesit-auto，可以提高 Emacs 中文本编辑的效率和质量。