-
-
Notifications
You must be signed in to change notification settings - Fork 402
Description
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Linux
What is the issue affecting?
Annotations, Type Checking
Expected Behaviour
Placing multiple annotations in inline comments like so works fine: the generics are interpreted correctly.
--[[@generic C]]
--[[@param any C]]
--[[@return C]]
local function exampleGeneric(any) return any endSo one would expect grouping them together on the same line (like this) would also work:
--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any endActual Behaviour
In the previous example, the generic seems to be defined, but doesn't carry over properly to the other two annotations. Similarly, adding a line break between the first and second annotation like this
--[[@generic C]]
--[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any endallows the generic to be recognized by the second annotation, but not the third. This behavior is also visible in other annotations that require others to be nearby, such as with classes and fields, and aliases.
Reproduction steps
- Open VSCode
- Paste either of the following examples into an empty lua file:
--[[@class amazingClass]] --[[@field field1 string]] --[[@field field2 number]]--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any endAdditional Notes
While I realize there is little practical use for some of these cases, such as the class definition (as it starts to take up a lot of horizontal space really quickly when defining new fields), this is especially useful when creating a plugin that allows for inline annotation definitions like the following:
local width: integer, height: integer = screen.width, screen.height
local logo: love.Image = textures["logo.png"]which generates inline comments like so in order to preserve syntax coloring, as well as line numbers during runtime:
local width --[[@type integer ]], height --[[@type integer ]] = screen.width, screen.height
local logo --[[@type love.Image ]] = textures["logo.png"]Log File
No response