lua-tags

Lua IntelliSense for Visual Studio Code.

Features

• Hover
• Lint(luacheck)
• Signature Helps
• Document Symbol
• Auto Completion
• Workspace Symbol
• Go To Definition

Configure & Usage

Download and installation are available at Visual Studio Code Extension Marketplace.

Once installed, all configure options details are at extension Contributions page

Hot configure reload NOT support, restart Visual Studio Code to activate new configure after configure changed

luacheck

lua-tags already integret with luacheck(win32 and linux)，if using MacOS or other platform, specify luaCheckPath at configure or add luacheck to os excuate PATH

export global symbols

ctrl + shift + p: "lua-tags: export global symbols" can export all global symbols to file(lua-tags-global-symbols) in workspace root directory.

It may help to set .luacheckrc.

multi-root workspaces

This extension does NOT support multi-root workspaces. If it is activated at multi-root workspaces, only the first folder works.

@param @return hightlight

Just like other language, @param、@return in comment will be hightlight by grammars injection

注解（Annotation）

尽量兼容emmylua和luals，但不完全兼容，并且做了很多精简。

• 数据类型 所有的Lua类型(string、number、function等等)，还支持自定义的class，table会被自动当作一个类型。

EXAMPLE = {
    a = 1,
    b = 2
}

-- @field a number 成员变量a
-- @field b string 成员变量b
-- @field c EXAMPLE 成员变量c，自动把EXAMPLE当作一个类型

• @param定义函数类型，@return定义返回类型

-- @param a number 参数a
-- @param b boolean 参数b
-- @return string 返回类型为string
function bar(a, b)
    return "str"
end

• @class声明一个类

-- @class Foo 类名
-- @field a number 成员变量a
-- @field b string 成员变量b
-- @field c Foo[] 可嵌套其他类型

• []定义数组

-- @type Foo[] 指定a的类型为Foo的数组
local a = {}

• table<k, v>定义hash

-- @type table<number, Foo>
local a = {}

• func(a:number, b:string):boolean定义函数

-- @type func(a:number, b:string):boolean
local a = function(a, b)
    return true
end

-- 没有返回时，可以不写返回，或者返回void
-- @type func(a:number, b:string)
local a = function(a, b)
end

• @alias定义别名 类似于C++的typedef和using，当一个类型太复杂时，可以定义一个别名。

-- @alias Foo func(a:number, b:string):boolean

-- @type Foo
local a = function(a, b)
    return true
end

• @type指定一个变量的类型

-- @type Foo 指定a的类型为Foo
local a = get_obj()

规则

1. parseSymbol.ts已经把所有注释解析出来，在这些注释中搜索上面的格式
2. 要注意排除不合法的格式，同时要兼容一些缺省写法 下面的@class缺少类名，那它就不是一个合法的类定义，直接忽略掉

-- 如果是一个类，要注释好@class

下面的table和func虽然没写参数，但仍采用

-- @type table 没详细写table<number, string>
local a = {}

-- @type func 没详细写func(a:boolean)
local b = function(a)
end

3. 文件结构 annotation.ts负责缓存注解符号并提供接口 parseAnnotation.ts负责解析注解符号，并把符号放到annotation.ts

4. 类型追踪 有了注解，就可以确定一个变量的类型，或者一个函数返回的类型。那么在进行hover、autoCompletion、signature、gotoDefinition 等功能时就可以获取对应的类型。例如

-- @class Foo
-- @field a number

-- @return Foo
local function test()
end

local f = test()
f.a -- 由于注解指明test返回的类型为Foo，因此应当能识别f的类型为Foo，并自动识别f.a为Foo.a

5. 数据和注解同时存在时互补，如果冲突则以数据为准

EXAMPLE = {
    a = 1,
}

-- @class EXAMPLE EXP类
-- @field a number 变量a

上面的例子中，存在数据EXAMPLE这个类，同时又用注解声明了EXAMPLE，但数据里的a变量没有注释，这时候显示变量a时，应该同时显示数据中a 的常量值1，又要同时显示类定义中的注释变量a

a = 1 -- 变量a

6. 把注解数据整合到原有的hover、autoCompletion、signature、gotoDefinition中去

7. 写测试用例 原来有一套测试用例在src/test/sample中，当前新增的测试用例弄一个sample2，不要和之前的混在一起。

Thanks

• https://github.com/fstirlitz/luaparse

• https://github.com/farzher/fuzzysort

• https://github.com/mpeterv/luacheck

• https://www.cockos.com/licecap/