k0204 / luaide

LuaIde

1. author:kangping
2. luaIde 是基于vscode开发的一款用于lua语言开发者使用的插件
3. 目标:致力于做最好的跨平台lua开发工具
4. 更新:luaide 个人开发者开发持续更新 (更新频率为一周一更)
5. 平台支持:win,mac
6. 代码调试:理论上只要支持 luasocket 就能调试 如果你的游戏引擎或 lua框架需要调试 请联系我

LuaIde 更新日志

1. 2017/6/25 0.3.3-0.37 版本

   1. 方法返回值注释:--@returnValue [Model.BaseModel] 修改为 --@return [Model.BaseModel]
   2. 将同文件中的变量由只提示方法内的改为 当前文件全局提示
   3. 修复全局变量无法提示bug
   4. 修改某些情况方法返回值无法提示bug
   5. lua文件修改后在不保存的情况下搜索symbol定位错误
   6. 添加用户在线数量显示,可通过 luaide.showOnLine 进行关闭 5分钟刷新一次
2. 1. 2017/6/15 0.3.2 版本
   2. 修复添加新文件无法 无法在 require 和类型注释中提示的bug
   3. 修复for 循环中的变量错误的解析为全局变量
   4. 修复全局方法返回值 无法提示
   5. 添加注释提示
   6. 添加变量类型注释 --@valueReference [Model.BaseModel] 当输入[ 会列出当前文件中所有的文件
   7. 注释路径添加转到定义
   8. 添加写入初始化信息 文件夹权限不足提示

3. 2017/6/8 0.3.0 版本 2. 增强代码推断能力,与0.2.x 版本用了两套逻辑 所以luaide 版本终结与0.2.1 以后待功能完善后 luaide将更名为luaIdeProfessional 3. 增加了 方法返回值 注释 和父类 类型注释

   1. 方法返回值注释:--@returnValue [Model.BaseModel] 当输入[ 会列出当前文件中所有的文件
   2. 父类类型注释:--@parentClass [Model.BaseModel] 当输入[ 会列出当前文件中所有的文件
   3. 两种注释需要 添加luaide 的配置 "luaide.scriptRoots": ["C:/Users/Administrator/Desktop/t"]

#重要提示

1. LuaDebug 下载地址
2. 文档请直接查看wiki
3. qq群 494653114
4. 调试文件为两个 LuaDebug,LuaDebugjit 添加调试文件时确认一下自己运行时选择对应的调试文件
5. bug 和 问题 请留言 issues
6. 调试视频
7. 历史版本 如果当前版本出现bug 可将 win->:\Users\Administrator.vscode\extensions 和 mac->user/.vscode/extensions 中对应的文件夹删除将历史版本解压重启vscode

#更新记录

1. 0.1.9->0.2.2

   1. 修复模块方法创建 插入位置错误 修改为插入到当前方法结束后
   2. 方法注释 @desc 无法显示bug
   3. 优化 require 时 lua 文件路径提示 兼容 "xxx.xxx.xx" 和 自定义变量 注意如果需要显示"xxx.xxx.xxx" 需要设置 luaide.scriptRoots
   4. 优化二进制lua文件导致的lua解析停止无法进行自动提示bug
   5. 添加最大文件检查限制 luaide.maxFileSize 默认为2048KB
   6. luaide.moduleFunNestingCheck 默认值修改为false -->该检测一定几率会检查错误,该问题将在0.2.1 修复
   7. 添加文件夹右键菜单 [创建模板文件] 模板文件配置 请看 安装 --> luaide.luaTemplatesDir
   8. 修正方法参数无法提示bug
   9. 格式化代码后#与变量名中多出一个空格 修改
   10. 修复由及时检查代码语法引起的 提示错误

2. 0.1.9->0.2.1

   1. 添加 输入 --- 自动生成方法注释
   2. 优化方法信息提示 区分全局函数和局部函数
   3. 优化 require 时 lua 文件路径提示 兼容 "xxx.xxx.xx" 和 自定义变量 注意如果需要显示"xxx.xxx.xxx" 需要设置 luaide.scriptRoots
   4. 优化二进制lua文件导致的lua解析停止无法进行自动提示bug
   5. 添加最大文件检查限制 luaide.maxFileSize 默认为2048KB
   6. luaide.moduleFunNestingCheck 默认值修改为false -->该检测一定几率会检查错误,该问题将在0.2.1 修复
   7. 添加文件夹右键菜单 [创建模板文件] 模板文件配置 请看 安装 --> luaide.luaTemplatesDir
   8. 修正方法参数无法提示bug
   9. 格式化代码后#与变量名中多出一个空格 修改
   10. 修复由及时检查代码语法引起的 提示错误

3. 0.1.8

   1. 根据 guoweidong1987 提供的方法修改lua代码格式化
   2. 添加 luaide.ChangeTextCheck 代码修改时是否检查lua语法是否正确
   3. 添加模块方法 luaide.moduleFunNestingCheck 模块方法嵌套检查,如果在一个方法中出现另外一个模块方法会认为是错误的
   4. 修改self 提示bug 无法提示三级和三级以上的代码 如 self.data.index
   5. 添加 require 时 lua 文件路径提示

4. 0.1.7

   1. 添加显示介绍页面配置 luaide.isShowDest 默认为false 只显示一次,如需重复显示修改为true
   2. 修改代码格式化 换行处理 和 " 转义 bug
   3. 修改代码提示 function 方法中 定义的local 变量 无法提示 二级变量 的bug
   4. 添加数据统计接口 统计在线人数, 如果有反感这一行为的请联系我,后期考虑添加配置
   5. 优化debug 将 lua 和luajit 调试文件进行分离 coocs 和unity 如果使用luajit 的调试文件请使用luaDebugjit.lua 文件进行调试 调试文件地址为luadeubg/LuaDebug.lua or luadebug/Luadebugjit.lua

5. 0.1.6 修改代码格式化bug

6. 将源代码提交至github

捐献

支持LuaIde的开发 可以通过微信

luaide's Issues

请问输入”---“之后的模版如何修改

lua 关键字的提示优先级别高点

一、像if for 这样的，现在在整个队列的最下面。
二、关键字结束需要按ese才能关闭提示，像end 后面会有一堆提示 end
endaa
endbbb 这样子，

自动提示问题

file1

local test1 = {}
function test1:func1()
end
return test1

---

file2使用
mgr.Test1 = require("test1")
mgr.Test1:fun

mgr.Test1:将无法提示

代码支持自定义模板化

https://github.com/love2d-community/love-api

能否将luadebug中的socket连接做得更通用一点？

我们项目没有使用luasocket，接受网络数据在lua中是回调的方式。
我尝试用一个messageQueue缓存接受的消息，然后在debugger_loop中处理逻辑，但是没有成功。

刚声明一个local变量，下一行打这个变量没提示

格式化代码后#与变量名中多出一个空格

具体如下图

函数不能跳转定义处了

更新到最新版后，按Ctrl 函数不能调到定义处了 ，很不方便

断点后，按继续，第二个断点不会断到。

mac。还有断点后再点下一步，如果改方法已经没下一步，不会自动跳到下一个执行的方法

渴望增加自定义api的功能

因为不同平台的需求，我们项目是unity的，有一些代码api都是由C# 提供的，原生api是由unity提供的库提供的，还有一些第三方dll库。如果可以自定义api提示，我们就可以直接自己生成这些api出来，在写代码提示的不会那么累 而且还可以做代码检查 是否使用规范 。

cocos luajit 在主循环里的代码 动态增删断点 容易出现断不住的情况

如题 重现不了可联系我。。qq943100400

自动补全功能有问题

RT
当前自动补全只能提示本文件，而VSCODE自带的自动补全提示是整个项目，期待更新。

删除断点功能失效, 获取断点信息时, 盘符大小写不匹配导致不能正确删除断点.

windows cocos2dx 3.x + lua 工程
luadebug文件: luadebugJit.lua

获取断点信息时, 盘符大小写不匹配导致不能正确删除断点.

输出信息:

**第一次添加断点**
dump from: [string ".\luadebugJit.lua"]:841: in function 'debugger_setBreak'	
      断点信息
- "datas" = {	
-     1 = {	
-         "fileName"   = "LogonScene.lua"	
-         "lines" = {	
-             1 = 261	
-         }	
-         "serverPath" = "d:/RYclient/client/client/src/plaza/views/LogonScene.lua"<===小写盘符
-     }	
- }	
      添加断点结果
dump from: [string ".\luadebugJit.lua"]:869: in function 'debugger_setBreak'	
- "breakInfos" = {	
-     "LogonScene.lua" = {	
-         "d:/RYclient/client/client/src/plaza/views/LogonScene.lua" = {	<===小写盘符
-             "lines" = {	
-                 261 = true	
-             }	
-             "pathNames" = {	
-                 1 = "d:"	
-                 2 = "RYclient"	
-                 3 = "client"	
-                 4 = "client"	
-                 5 = "src"	
-                 6 = "plaza"	
-                 7 = "views"	
-                 8 = "LogonScene.lua"	
-             }	
-         }	
-     }	
- }	
isHook=>true	

**在断点断下后 删除断点**
      断点信息
dump from: [string ".\luadebugJit.lua"]:841: in function 'debugger_setBreak'	
- "datas" = {	
-     1 = {	
-         "fileName"   = "LogonScene.lua"	
-         "lines" = {	
-         }	
-         "serverPath" = "D:/RYclient/client/client/src/plaza/views/LogonScene.lua"<===大写盘符	
-     }	
- }	
      删除断点结果
dump from: [string ".\luadebugJit.lua"]:869: in function 'debugger_setBreak'	
- "breakInfos" = {	
-     "LogonScene.lua" = {	
-         "d:/RYclient/client/client/src/plaza/views/LogonScene.lua" = {	<===不能匹配小写盘符
-             "lines" = {	
-                 261 = true	
-             }	
-             "pathNames" = {	
-                 1 = "d:"	
-                 2 = "RYclient"	
-                 3 = "client"	
-                 4 = "client"	
-                 5 = "src"	
-                 6 = "plaza"	
-                 7 = "views"	
-                 8 = "LogonScene.lua"	
-             }	
-         }	
-     }	
- }	
isHook=>true	

**再次添加断点**
      断点信息
dump from: [string ".\luadebugJit.lua"]:841: in function 'debugger_setBreak'	
- "datas" = {	
-     1 = {	
-         "fileName"   = "LogonScene.lua"	
-         "lines" = {	
-             1 = 261	
-         }	
-         "serverPath" = "D:/RYclient/client/client/src/plaza/views/LogonScene.lua"<==大写盘符	
-     }	
- }	
      添加断点结果
dump from: [string ".\luadebugJit.lua"]:869: in function 'debugger_setBreak'	
- "breakInfos" = {	
-     "LogonScene.lua" = {	
-         "D:/RYclient/client/client/src/plaza/views/LogonScene.lua" = {	<============
-             "lines" = {	
-                 261 = true	
-             }	
-             "pathNames" = {	
-                 1 = "D:"	
-                 2 = "RYclient"	
-                 3 = "client"	
-                 4 = "client"	
-                 5 = "src"	
-                 6 = "plaza"	
-                 7 = "views"	
-                 8 = "LogonScene.lua"	
-             }	
-         }	
-         "d:/RYclient/client/client/src/plaza/views/LogonScene.lua" = {	<============
-             "lines" = {	
-                 261 = true	
-             }	
-             "pathNames" = {	
-                 1 = "d:"	
-                 2 = "RYclient"	
-                 3 = "client"	
-                 4 = "client"	
-                 5 = "src"	
-                 6 = "plaza"	
-                 7 = "views"	
-                 8 = "LogonScene.lua"	
-             }	
-         }	
-     }	
- }	
isHook=>true	

错误提示bug

BUG1:

for i,v in pairs(self.tempTeam) do
       g_DataPool:GetArenaData().defLayout[i] = v
end

这样v有红线

for i,v in pairs(self.tempTeam) do
       g_DataPool:GetArenaData().defLayout = v
end

这样就没有

BUG2
math.floor(x/60%z) 这样会有错误提示
math.floor(x/60 %z) 多个空格, 这样就不会有

语法检查问题

local test1 = 0.2
if 0.1>test1 then
end

if test>0.2 and 0.1>test1 then
end

0.1会报红

local test1 = 10010010
local test2 = test1/100%10

100会报红

格式化功能出现的问题

一直ctrl+是的保存，lua的注释会一直自动加上空格

很感谢这个插件，一个小建议希望自动对齐的时候缩进tab换为空格(2个或4个可以配置)

一般我都用两个空格作为缩进对齐，但是一使用插件自动对齐后全部空格都被替换成tab，下次打开自动检测tab size又有可能变成4个空格。希望能增加自动对齐的缩进配置谢谢。

断点之后没有print输出了.

扩展主机意外终止

使用后一直提示 扩展主机意外中止，请重新加载窗口以恢复。

打开编辑器时,非.lua结尾的lua脚本不能正常解析

FileUtils::getInstance()->fullPathForFilename() 资源目录不对

提示找不到资源，双击EXE运行是OK的，但是如果用debugLua运行，就报错，找不到资源

【错误】调试适配器进程已意外终止

按照视频配置了launch.json,然后启动，调试不了

关键字颜色 and or

if ets and type(ets) == str_table then --希望在此处的and加个颜色
	for k, v in pairs(ets) do
        
	end
end

只要有一个错误，后面的调试信息都不输出了

格式化代码bug

右键点击格式化代码时会将转义字符的反斜杠 \ 删掉
格式化之代码前字符串 : local str = ""%s""
格式化代码之后变成 : local str = ""%s""

语法不规范也会提示错误

local a,b;
提示 没有赋值。。

[建议] 用特殊的颜色标明`全局变量`

建议用特殊的颜色标明全局变量 , 因为有时候会漏写 local 限定并且难以被发现

脚本内有汉字变量，输入---不能自动添加注释脚本

汉字变量提示意外的字符，不能自动添加注释

调试时无法正常的进行"单步跳过"操作

点击单步跳过后, 会直接运行到下个新断点才会停,并不会停在下一行(cocos2dx的lua工程,win系统)

非lua扩展名的lua文件不能正常提示

nice work

可否为方法的参数增加输入补全功能

lua文件修改后在不保存的情况下搜索symbol定位错误

示意图：

调试bug：位于匿名函数中的断点有时无法命中，同时从调用方也StepIn不了

非常感谢作者带来这么棒的插件！
然后代码截图如下：


代码在图1中能成功断点，但StepIn无效，类似于StepOver一样自动略过
代码在图2中有一定几率能断点成功（经测试都在grid=nil的时候能断点，不等于nil的时候无法断点）

lua5.3 非符号提示非法

~0xff 例如这样的写法，十六进制数据前面的非符号会是红色的。不知道这个VS Code问题还是LuaIDE问题？

支持动态变量的智能提示

local data = require "data"

function get_data(id)

  return data

end

local temp_data = get_data(1)

temp_data.init() --这里就没法提示了

调试出错

触发断点后,点击F5继续执行,此后的print都不会再有输出,如果按的是f10,则会有继续的输出.

格式化代码

建议格式化的时候 不要把空行直接格式化掉
程序员都是强迫症患者 可以把多余的空行格式化成一行
再次感谢luaide

mac下面客户端的cocos的c++ log没法输出

在mac下面c++的log没法输出，在cocos中表现为CCLog的输出没有在vscode的调试控制台输出。但是oc的log也就是NSLog倒是可以输出。我尝试了用下面代码，是可以输出log的
var callfile = require('child_process');
var h = callfile.spawn("/Users/nervecell/workspaces/game.app/Contents/MacOS/game");
h.stdout.on('data', function (s) {
console.log(s.toString());
});
h.stdout.on('end', function () {
console.log('ls done');
});

更新后老是弹出luaide介绍怎么关闭

goto语句报错

代码格式化时字符串中有‘\’时仍然会有问题

1:采用[[ string ]]定义字符串时，
2:‘“’。 和”‘“ 会有问题：
3:” \a \x \b“ 之类的一些字符
以上情况格式化时都会出现‘\’数量变化的情况，

在我4月9号提交的pull request中针对解决了上述问题

0.1.8 版本没有代码提示了

0.1.8 版本没有代码提示了

添加新建lua文件功能，并自动生成作者名称，创建时间

在调试过程中，如果lua执行出错，有机会出现错误信息不打印的情况

具体情况差不多和标题一样：在调试过程中，如果lua执行出错，有机会出现错误信息不打印的情况。这边没法截图，我在群里是东郭哈，需要详细情况可以问我。

输入 --- 自动生成方法注释时间不对。

开启粘贴自动格式化后，粘贴内容后会多一个空格

如果粘贴的位置是字符串的双引号之间，则会在结束的引号前多一个空格。选中区域快格式化，无此问题。

建议增加启动参数。

之前用visual studio cocos2d-x lua开发可以增加参数设置启动模拟器大小。

添加skynet的函数内语法识别的支持

比如 函数名
local data = require "data"
data.init() -- 这边是可以支持的
function response.create()
data.init()-- 这边不支持代码提示
end

源码似乎是0.1.9的是么？

感谢作者大大的辛勤劳动
何时能把0.2.1源码上传上来呢？我想加点feature