Elixir Tools for Neovim 使用教程

Elixir Tools for Neovim 使用教程

elixir-tools.nvimNeovim plugin for Elixir项目地址:https://gitcode.com/gh_mirrors/el/elixir-tools.nvim

1. 项目介绍

elixir-tools.nvim 是一个为 Elixir 开发者提供的 Neovim 插件，旨在提升 Elixir 开发者在 Neovim 中的开发体验。该插件集成了 ElixirLS 和 Next LS，提供了诸如自动补全、语法高亮、代码格式化等功能。此外，它还支持通过 :Elixir 命令进行各种 Elixir 相关的操作，如宏展开、管道操作等。

2. 项目快速启动

安装依赖

在开始之前，请确保你已经安装了以下软件：

• Neovim
• Lua 5.1
• Luarocks
• nvim-test
• plenary.nvim
• stylua

安装插件

你可以使用 packer.nvim 来安装 elixir-tools.nvim：

use({
  "elixir-tools/elixir-tools.nvim",
  tag = "stable",
  requires = { "nvim-lua/plenary.nvim" }
})

配置插件

在 Neovim 配置文件中添加以下配置：

require("elixir").setup({
  nextls = { enable = true },
  elixirls = {
    enable = true,
    settings = {
      dialyzerEnabled = false,
      enableTestLenses = false,
    },
  },
  projectionist = { enable = true },
})

使用示例

以下是一些常用的命令示例：

• 从管道操作转换为函数调用：

:ElixirFromPipe

• 将函数调用转换为管道操作：

:ElixirToPipe

• 展开宏：

:ElixirExpandMacro

3. 应用案例和最佳实践

案例1：使用 ElixirLS 进行代码补全

在 Neovim 中，elixir-tools.nvim 集成了 ElixirLS，提供了强大的代码补全功能。你可以在编写 Elixir 代码时，通过 nvim-cmp 插件来实现自动补全。

案例2：使用 Next LS 进行代码重构

Next LS 提供了多种代码重构工具，如模块别名重构、管道操作转换等。你可以通过 :Elixir nextls alias-refactor 命令来重构代码中的模块别名。

最佳实践

• 配置优化：根据项目需求，合理配置 elixir-tools.nvim 中的各项设置，如是否启用 dialyzer 或 test lenses。
• 快捷键绑定：通过自定义快捷键，提高开发效率。例如，将 :ElixirFromPipe 绑定到 <space>fp。

4. 典型生态项目

nvim-cmp

nvim-cmp 是一个强大的代码补全插件，与 elixir-tools.nvim 结合使用，可以提供更智能的代码补全体验。

nvim-treesitter

nvim-treesitter 提供了语法高亮和代码分析功能，与 elixir-tools.nvim 结合使用，可以进一步提升代码的可读性和开发效率。

plenary.nvim

plenary.nvim 是一个常用的 Neovim 插件库，提供了许多实用功能，如异步任务管理、测试框架等，是 elixir-tools.nvim 的依赖之一。

通过以上模块的介绍和示例，你可以快速上手并充分利用 elixir-tools.nvim 插件，提升 Elixir 开发的效率和体验。

elixir-tools.nvimNeovim plugin for Elixir项目地址:https://gitcode.com/gh_mirrors/el/elixir-tools.nvim