Lua Helper Guide

Introduction

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

Feature Summary

Code Editing

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

Code Detection

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

Documentation

告警配置

Feature Detail

Defintion Find/定义跳转

支持局部、全局文件定义查询跳转

Find All References/引用查找

支持基于作用域的各类型引用查找

Document Symbols/文件符号表查询

支持文件域符号表查询，在搜索栏输入@

Workspace Symbols/工程符号表查询

支持工程域符号表查询，在搜索栏输入#

Auto Code Completion/自动代码补全

支持变量、函数的自动输入提示

Reformat Code/代码格式化

支持代码格式化

Hover/代码悬停

支持代码悬停提示

Hightlight Global Var/全局变量着色

支持全局变量高亮着色

Syntax Check/语法检测

提供丰富的语法错误检测类型

Semantic Check/语义检测

支持多种类型的语义检测

Quick Analysis/快速增量分析

支持增量变化分析，分析结果诊断输出

Installation

• 插件搜索安装：

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

• 点击应用市场安装连接 : martket

Acknowledgements

• luago-books, go语言生成lua的AST，修改了源码（对AST的每个节点增加了列的属性，同时也优化了性能）。
• LuaFormatter, c++写的Lua代码格式化库，性能较高。

Contribution

yinfei, Handsome Lee

Support

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

QQ群：747590892