LuaHelper Guide

介绍

Lua因其语法简单、使用灵活，在游戏开发中十分流行。但其生态并不完善，IDE开发工具及配套支持较少，一定程度上影响了Lua的开发效率及质量。LuaHelper遵从微软Language Server Protocol协议，是采用go语言开发的一种跨平台Lua代码编辑及检测工具。

相较目前市面其他Lua插件，具有以下改进：

• 1.协程开发，实时检测，毫秒级输出检测结果
• 2.支持大型Lua项目，完美支持1000+文件项目工程的编辑与检测
• 3.全面的错误类型检测，包括：语法检测、语义检测
• 4.多种类引用查找，包括：多文件引用查找、多层引用查找
• 5.丰富的可配置项，包括：多种告警信息配置、可忽略文件设定
• 6.内存消耗低，低性能机器仍可流畅运行

文档

• Background [项目背景]
• Configuration [检查配置]
• Manual [源码介绍]

功能特性

编辑辅助

• Defintion Find [定义跳转]
• Find All References [引用查找]
• Document Symbols [文件符号表查询]
• Workspace Symbols [工程符号表查询]
• Auto Code Completion [自动代码补全]
• Format Code [代码格式化]
• Hover [代码悬停]
• Hightlight Global Var [全局变量着色]

代码检测

• Syntax Check [语法检测]
• Semantic Check [语义检测]
• Quick Analysis [快速增量分析]

代码调试

调试功能集成了腾讯开源LuaPanda的调试组件，采用了Debug Adapter Protocol调试协议。debugger主体使用lua语言开发，调试程序只要引入LuaPanda.lua文件，即可方便开启调试功能。

• 调试原理
• 接入调试方法
• 单文件调试与运行

安装

应用市场安装

• 点击Vs Code应用市场图标
• 在输入框中搜索 luahelper
• 点击安装Lua Helper

应用市场异常

点击应用链接，尝试重新安装

Acknowledgements

• luago-books, go语言生成lua的AST，修改了源码（对AST的每个节点增加了列的属性，同时也优化了性能）。
• LuaFormatter, c++写的Lua代码格式化库，性能较高。
• LuaPanda, 集成了LuaPanda的调试组件，LuaPanda的作者stuartwang也给我们提供了很多帮助。
• EmmyLua, 作者阿唐对我们整个插件的实现提供很多帮助和建议。

Support

如有问题先参阅 FAQ ，如有问题建议使用 issues ，我们会关注和回复。

Email：[email protected]; [email protected]; [email protected]
QQ群：747590892