cppcxy/emmyluaanalyzer

a new EmmyLua Language Server

EmmyLuaAnalyzer

Introduction

The EmmyLuaAnalyzer project is a static analyzer and language service for the Lua language implemented in C#. It mainly consists of two parts:

1. Lua code analysis core that supports EmmyLua Doc. It is an independent Lua code analysis library that can be used to analyze Lua code, generate abstract syntax trees, provide semantic analysis, and other functions.
2. EmmyLua language service, which is a Lua language server based on the above code analysis core. It provides the main language service functions, including code hints, code completion, refactoring, and other features.

Features

• Supports mainstream Lua versions, including Lua 5.1, Lua 5.2, Lua 5.3, Lua 5.4, LuaJIT.
• Supports EmmyLua Doc comments and is compatible with the Doc format of Lua-Language-Server (abbreviated as LuaLs).
• Supports all language service features (not all are supported yet, currently supports the main ones that will be used).
• Formatting is not supported yet (EmmyLuaCodeStyle, which I also wrote, has its own independent language service).

Documentation

• TODO

Usage

Use EmmyLuaAnalyzer's analysis core through nuget

TODO

Use EmmyLuaAnalyzer's language service through the VSCode plugin

You can currently use EmmyLuaAnalyzer's language service by checking Use EmmyLuaAnalyzer in VSCode-EmmyLua.

Testing

Currently in beta, everyone is welcome to test and make suggestions. There is still a lot of work in progress and needs to be improved.

LICENSE

MIT

emmyluaanalyzer's Issues

Possible improvements to analyzer

I gave the new EmmyLuaAnalyzer a whirl and here's some things I found:

Bugs

• Hover state does not show class fields
  

• "Read more" arrow always shows, even with subwindow is empty
  

• ---@deprecated does not appear in hover. Calls to deprecated methods should be striken().
  

• Clicking EmmyLua in status bar results in "emmy.stopServer not found" error message.
  

• Putting an invalid path (e.g. "fakedir" into workspace.library in emmyrc.json caused crash on startup. If you change/add this mid-session EmmyLua becomes non-responsive (and stop is broken).
  

• #12
  
  

• Completions for ---@ should should only be type annotation related [@class,@param,@return,etc]
  

• #13
  

• Duplicate functions (with different params) inside a ---@meta are not suggested as multiple options (first wins?)
  

• Types on ... are not properly checked and ...? is displayed as... in function signatures.
  

• Class field descriptions do not appear as part of extended suggestion, but are present in the hover window.
  

• #14
  

• Assignments to optional returns (e.g. string? or string|nil do not preserve their nullability in types. This should be _File? or _File?.
  

• workspace.library in .emmyrc.json only works with relative paths. 0.6.15 changelog here says:

  Now all places where paths can be filled support relative paths, absolute paths, and ${workspaceFolder} to represent the workspace, ~ to represent the user directory
  Tildes do not expanded properly (~/proj becomes /proj). Absolute paths are wrongly concatenated as paths under workspaceFolder. ${workspaceFolder}/../whatever works as designed.

• Assignments should preserve transitive comment annotations.
  

• Quote handling for @alias types is not right (duplicated double quotes): "". Dunno if the EmmyLua types need to updated. Here is how LuaLS defines them for reference.
  
  

Settings

• Please increase the default for workspace.preloadFileSize. Maybe 5120000?

• .emmyrc.json: It'd be sweet to have a JSON schema. Then if you set "$schema" to the url users get config validation for free in VSCode. Are you intending to support .laurc.json as well? You're close enough to the LuaLS .luarc.json schema that I think you could implement proper superset of what it supports.

• .emmyrc.json: Please add support for runtime.nonstandardSymbol. Here's what I use for Playdate Development: ["+=", "-=", "*=", "/=", "//=", "%=", "<<=", ">>=", "&=", "|=", "^="]

Future suggested capabilities

• Add colors/tokenize type/names inside comment annotations. fun(), | and : get fancy colorization, but everything else is just a comment (green).
  

• Analyzer should warn on duplicate assignments (unless inside ---@meta file)
  

• Analyzer should warn when assigning incorrect types.
  

• Analyzer should warn/error when nullable types are not checked for nil before calling. E.g. err:len() should have warning.
  

• Analyzer should warn when assigning to constants (this will fail at runtime)
  

---

Steps to reproduce:

1. Create a folder with an .emmyrc.json:

{
    "workspace": {
        "preloadFileSize": 5120000,
        "library": [
            "../playdate-luacats"
        ]
    }
}

2. Checkout https://github.com/notpeter/playdate-luacats/
3. Profit?

Completion suggestions inside a comment are really bad. It shouldn't attempt to autocomplete to any "word" found anywhere in the docs.

语法解析错误

function f()end

数组类型字段，读取其中元素时类型推断不正确

---@type Talent[]
self._talents = {}

for i = 1, self._talents do
local talent = self._talents[i]
end

此时循环中的local talent类型无法推断出是Talent类型，而是unknown

索引查找bug

---@field a number
---@field b number
local A = {
    a = 1,
    aa = 2
}

function A:print()

end

---@generic V
---@param super any
---@param name `V`
---@return V
function inherit(super, name)
    local newClass = {}
    newClass.__index = newClass
    return setmetatable(newClass, super)
end

---@class B : A
local B = inherit(A, "B")

function B:print()
    local sf = self
    sf.a = 10
end

如上代码，期望倒数第二行sf.a可以查到找基类A中a字段的定义，基类A中查找field a的引用可以查找到sf.a=10的代码行。
目前测试下来，a的定义和引用极大概率查找不成功，小概率成功

插件刷新有问题

这种提示刷新有问题, 就算改完, 在git上提交了, 依旧会出现.
点了提示后会跳到git提交前的文件, 只有关了vscode, 重启服务才能解决

:语法调用导致泛型模板类型诊断错误问题

local A = {
a = 1,
aa = 2
}

---@generic T
---@param sf T
---@param ina number
---@return T
function A.new(sf, ina)
end

local a = A:new(3)
local b = A.new(A, 3)

以上代码倒数第二行A:new(3) 参数3将会错误的推断为A.new中的第一个参数，并且a类型返回推断错误

参数提示负号显示位置不对

Partial parsing while typing a field name pulls the next valid statement into the suggestion window. Incorrectly incorrectly identifies next token (see: kTextAlignment is white, but should be red)

Incomplete member variable prompts

1. class嵌套三层以上，获取的代码补全不全。
2. 代码结尾的渲染不正常。

BUG Report

Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'path1')
at System.ArgumentNullException.Throw(String paramName)
at System.IO.Path.Combine(String path1, String path2)
at EmmyLua.CodeAnalysis.Workspace.Module.ModuleGraph.AddPackageRoot(String packageRoot) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\Module\ModuleGraph.cs:line 42
at EmmyLua.CodeAnalysis.Workspace.LuaWorkspace.LoadMainWorkspace(String workspace) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\LuaWorkspace.cs:line 119
at EmmyLua.LanguageServer.Server.ServerContext.StartServer(String workspacePath) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\Server\ServerContext.cs:line 43
at Program.<>c__DisplayClass0_1.<

$>b__4(ILanguageServer server, CancellationToken _) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 102
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.b__80_0(OnLanguageServerStartedDelegate handler, CancellationToken ct)
at OmniSharp.Extensions.LanguageServer.Protocol.LanguageProtocolEventingHelper.<>c__DisplayClass0_12.<Run>b__2(CancellationToken ct) at System.Reactive.Linq.QueryLanguage.StartAsyncImpl(Func2 actionAsync, Value& options)
--- End of stack trace from previous location ---
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.Initialize(CancellationToken token)
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.From(LanguageServerOptions options, IServiceProvider outerServiceProvider, CancellationToken cancellationToken)
at Program.$(String[] args) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 37
at Program.(String[] args)
[Info - 09:50:00] Connection to server got closed. Server will restart.
true
[Error - 09:50:00] Server process exited with code 3762504530.
Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'path1')
at System.ArgumentNullException.Throw(String paramName)
at System.IO.Path.Combine(String path1, String path2)
at EmmyLua.CodeAnalysis.Workspace.Module.ModuleGraph.AddPackageRoot(String packageRoot) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\Module\ModuleGraph.cs:line 42
at EmmyLua.CodeAnalysis.Workspace.LuaWorkspace.LoadMainWorkspace(String workspace) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\LuaWorkspace.cs:line 119
at EmmyLua.LanguageServer.Server.ServerContext.StartServer(String workspacePath) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\Server\ServerContext.cs:line 43
at Program.<>c__DisplayClass0_1.<$>b__4(ILanguageServer server, CancellationToken _) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 102
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.b__80_0(OnLanguageServerStartedDelegate handler, CancellationToken ct)
at OmniSharp.Extensions.LanguageServer.Protocol.LanguageProtocolEventingHelper.<>c__DisplayClass0_12.<Run>b__2(CancellationToken ct) at System.Reactive.Linq.QueryLanguage.StartAsyncImpl(Func2 actionAsync, Value& options)
--- End of stack trace from previous location ---
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.Initialize(CancellationToken token)
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.From(LanguageServerOptions options, IServiceProvider outerServiceProvider, CancellationToken cancellationToken)
at Program.$(String[] args) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 37
at Program.(String[] args)
[Info - 09:50:02] Connection to server got closed. Server will restart.
true
[Error - 09:50:02] Server process exited with code 3762504530.
Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'path1')
at System.ArgumentNullException.Throw(String paramName)
at System.IO.Path.Combine(String path1, String path2)
at EmmyLua.CodeAnalysis.Workspace.Module.ModuleGraph.AddPackageRoot(String packageRoot) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\Module\ModuleGraph.cs:line 42
at EmmyLua.CodeAnalysis.Workspace.LuaWorkspace.LoadMainWorkspace(String workspace) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\LuaWorkspace.cs:line 119
at EmmyLua.LanguageServer.Server.ServerContext.StartServer(String workspacePath) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\Server\ServerContext.cs:line 43
at Program.<>c__DisplayClass0_1.<$>b__4(ILanguageServer server, CancellationToken _) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 102
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.b__80_0(OnLanguageServerStartedDelegate handler, CancellationToken ct)
at OmniSharp.Extensions.LanguageServer.Protocol.LanguageProtocolEventingHelper.<>c__DisplayClass0_12.<Run>b__2(CancellationToken ct) at System.Reactive.Linq.QueryLanguage.StartAsyncImpl(Func2 actionAsync, Value& options)
--- End of stack trace from previous location ---
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.Initialize(CancellationToken token)
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.From(LanguageServerOptions options, IServiceProvider outerServiceProvider, CancellationToken cancellationToken)
at Program.$(String[] args) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 37
at Program.(String[] args)
[Info - 09:50:03] Connection to server got closed. Server will restart.
true
[Error - 09:50:03] Server process exited with code 3762504530.
Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'path1')
at System.ArgumentNullException.Throw(String paramName)
at System.IO.Path.Combine(String path1, String path2)
at EmmyLua.CodeAnalysis.Workspace.Module.ModuleGraph.AddPackageRoot(String packageRoot) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\Module\ModuleGraph.cs:line 42
at EmmyLua.CodeAnalysis.Workspace.LuaWorkspace.LoadMainWorkspace(String workspace) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\LuaWorkspace.cs:line 119
at EmmyLua.LanguageServer.Server.ServerContext.StartServer(String workspacePath) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\Server\ServerContext.cs:line 43
at Program.<>c__DisplayClass0_1.<$>b__4(ILanguageServer server, CancellationToken _) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 102
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.b__80_0(OnLanguageServerStartedDelegate handler, CancellationToken ct)
at OmniSharp.Extensions.LanguageServer.Protocol.LanguageProtocolEventingHelper.<>c__DisplayClass0_12.<Run>b__2(CancellationToken ct) at System.Reactive.Linq.QueryLanguage.StartAsyncImpl(Func2 actionAsync, Value& options)
--- End of stack trace from previous location ---
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.Initialize(CancellationToken token)
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.From(LanguageServerOptions options, IServiceProvider outerServiceProvider, CancellationToken cancellationToken)
at Program.$(String[] args) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 37
at Program.(String[] args)
[Info - 09:50:03] Connection to server got closed. Server will restart.
true
[Error - 09:50:03] Server process exited with code 3762504530.
Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'path1')
at System.ArgumentNullException.Throw(String paramName)
at System.IO.Path.Combine(String path1, String path2)
at EmmyLua.CodeAnalysis.Workspace.Module.ModuleGraph.AddPackageRoot(String packageRoot) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\Module\ModuleGraph.cs:line 42
at EmmyLua.CodeAnalysis.Workspace.LuaWorkspace.LoadMainWorkspace(String workspace) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua\CodeAnalysis\Workspace\LuaWorkspace.cs:line 119
at EmmyLua.LanguageServer.Server.ServerContext.StartServer(String workspacePath) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\Server\ServerContext.cs:line 43
at Program.<>c__DisplayClass0_1.<$>b__4(ILanguageServer server, CancellationToken _) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 102
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.b__80_0(OnLanguageServerStartedDelegate handler, CancellationToken ct)
at OmniSharp.Extensions.LanguageServer.Protocol.LanguageProtocolEventingHelper.<>c__DisplayClass0_12.<Run>b__2(CancellationToken ct) at System.Reactive.Linq.QueryLanguage.StartAsyncImpl(Func2 actionAsync, Value& options)
--- End of stack trace from previous location ---
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.Initialize(CancellationToken token)
at OmniSharp.Extensions.LanguageServer.Server.LanguageServer.From(LanguageServerOptions options, IServiceProvider outerServiceProvider, CancellationToken cancellationToken)
at Program.$(String[] args) in D:\a\EmmyLuaAnalyzer\EmmyLuaAnalyzer\EmmyLua.LanguageServer\LanguageServer.cs:line 37
at Program.(String[] args)
[Error - 09:50:04] The EmmyLua plugin for vscode. server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information.
[Error - 09:50:04] Server process exited with code 3762504530.

Name matching is so fuzzy it's distracting.

全局变量分析问题

程序启动时会声明

---@type UIManager
UIMgr = require("UIManager").New()

在程序关闭时,会在特定方法里执行

UIMgr = nil

一旦写了后面的赋值代码后, 就会提示UIMgr是nil

代码提示问题

旧版本 使用

---@class AAA
local AAA = Class("AAA")

local a = AAA()

可以将a识别为AAA这个类型, 新版本不行, 而且没发提示__call

模板类型推断问题

local A = {
a = 1,
aa = 2
}

---@class B
local B = {
}

---@generic T : B
---@param base? T
---@return T
function A:GetBB(base)
end

local x = A:GetBB()
local y = A:GetBB(B)

如上代码，期望倒数第二行x的类型推断为B，实际推断为T