nvim-yati 插件使用教程

nvim-yati 插件使用教程

nvim-yati Yet another tree-sitter powered indent plugin for Neovim. 项目地址: https://gitcode.com/gh_mirrors/nv/nvim-yati

1. 项目介绍

nvim-yati 是一个为 Neovim 设计的树状语法分析器（tree-sitter）驱动的缩进插件。它旨在提供更智能、更准确的代码缩进功能，特别是在处理复杂语言结构时。该项目最初创建时，Neovim 内置的缩进模块体验较差，但随着社区支持的改善，内置模块已经有所改进。尽管如此，nvim-yati 仍然提供了一些独特的功能和定制选项，适用于那些对缩进有更高要求的用户。

2. 项目快速启动

安装

使用 packer.nvim 安装

use({
  "yioneko/nvim-yati",
  tag = "*",
  requires = "nvim-treesitter/nvim-treesitter"
})

使用 vim-plug 安装

Plug "nvim-treesitter/nvim-treesitter"
Plug "yioneko/nvim-yati", { 'tag': '*' }

配置

在 Neovim 配置文件中启用 nvim-yati 插件：

require("nvim-treesitter.configs").setup {
  yati = {
    enable = true,
    -- 禁用某些语言的缩进
    disable = { "python" },
    -- 是否启用懒模式（推荐启用以避免频繁的错误缩进）
    default_lazy = true,
    -- 默认的回退缩进方法
    default_fallback = "auto"
  },
  indent = {
    enable = false -- 禁用内置的缩进模块
  }
}

3. 应用案例和最佳实践

案例1：JavaScript 代码缩进

假设你正在编写一个复杂的 JavaScript 函数，其中包含多层嵌套的条件语句。使用 nvim-yati 可以确保每一层的缩进都是正确的，从而提高代码的可读性。

function fun() {
  if (abc) {
    if (cbd) {
      a();
      // 新的缩进将在这里，即使父节点的缩进不正确
    }
  }
}

最佳实践

1. 启用懒模式：对于复杂的代码结构，建议启用懒模式以减少错误缩进的发生频率。
2. 自定义回退方法：根据项目需求，可以自定义回退缩进方法，以确保在无法通过树状语法分析器计算缩进时，仍然能够保持代码的整洁。

4. 典型生态项目

nvim-treesitter

nvim-treesitter 是 nvim-yati 的依赖项目，它为 Neovim 提供了强大的树状语法分析器支持。通过结合使用这两个插件，可以显著提升代码编辑体验。

nvim-autopairs 和 luasnip

为了确保代码的语法树在编辑过程中保持正确，建议使用 nvim-autopairs 和 luasnip 等插件来辅助代码的自动补全和语法校正。

---

通过以上步骤，你可以快速上手并充分利用 nvim-yati 插件，提升 Neovim 中的代码缩进体验。

nvim-yati Yet another tree-sitter powered indent plugin for Neovim. 项目地址: https://gitcode.com/gh_mirrors/nv/nvim-yati