DEV Community
·
为CLI工具创建Neovim插件
💡
原文英文，约1200词，阅读约需5分钟。
📝
内容提要
本文介绍了如何为Neovim构建PHPStan插件。PHPStan是一个开源CLI工具，用于在不运行代码的情况下查找PHP项目中的错误。通过Composer安装PHPStan后，可以使用Lua编写Neovim插件，利用其诊断模块显示错误信息。插件解析PHPStan的JSON输出生成诊断消息，并在文件打开或修改时自动执行，最终代码需在Neovim的初始化文件中调用。
🎯
关键要点
- 本文介绍了如何为Neovim构建PHPStan插件。
- PHPStan是一个开源CLI工具，用于在不运行代码的情况下查找PHP项目中的错误。
- 通过Composer安装PHPStan后，可以使用Lua编写Neovim插件。
- 插件解析PHPStan的JSON输出生成诊断消息。
- 在文件打开或修改时自动执行插件。
- Neovim提供了丰富的Lua API来构建插件。
- 创建Lua插件需要在Neovim的配置文件夹中创建lua/plugin.lua文件。
- 使用nvim_create_namespace()创建命名空间以显示诊断消息。
- 通过执行PHPStan命令并解析输出生成诊断信息。
- 使用plenary.nvim库以异步方式与系统命令交互。
- 解析JSON输出以提取错误信息并生成诊断表。
- 最终代码需要在Neovim的初始化文件中调用以注册自动命令。
❓
延伸问答
如何为Neovim创建PHPStan插件？
可以通过Composer安装PHPStan，然后使用Lua编写Neovim插件，创建lua/plugin.lua文件，并在Neovim的初始化文件中调用。
PHPStan是什么？
PHPStan是一个开源CLI工具，用于在不运行代码的情况下查找PHP项目中的错误。
如何在Neovim中显示诊断消息？
可以使用nvim_create_namespace()创建命名空间，并生成诊断消息表，然后使用vim.diagnostic.set()将其发布到缓冲区。
如何解析PHPStan的JSON输出？
可以使用vim.json.decode()函数将JSON字符串解码为Lua表，并提取错误信息生成诊断表。
如何在文件打开或修改时自动执行插件？
可以使用Neovim的自动命令功能，注册在打开或保存PHP文件时执行分析函数。
使用plenary.nvim库有什么好处？
plenary.nvim库提供了与系统命令异步交互的API，使得执行PHPStan命令更加高效和便捷。
➡️
