LuaLS / LuaLS/lua-language-server
Annotations in inline comments do not recognize others on the same line
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
### 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.
```lua
--[[@generic C]]
--[[@param any C]]
--[[@return C]]
local function exampleGeneric(any) return any end
```
So one would expect grouping them together on the same line (like this) would also work:
```lua
--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
### Actual 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
```lua
--[[@generic C]]
--[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
allows 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
1. Open VSCode
2. Paste either of the following examples into an empty lua file:
```lua
--[[@class amazingClass]] --[[@field field1 string]] --[[@field field2 number]]
```
```lua
--[[@generic C]] --[[@param any C]] --[[@return C]]
local function exampleGeneric(any) return any end
```
### Additional 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:
```lua
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:
```lua
local width --[[@type integer ]], height --[[@type integer ]] = screen.width, screen.height
local logo --[[@type love.Image ]] = textures["logo.png"]
```
### Log File
_No response_
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tái hiện vấn đề trong VSCode bằng cách sử dụng các ví dụ về chú thích Lua inline trong báo cáo, sau đó so sánh các chú thích được tách trên nhiều dòng với nhiều chú thích trên cùng một dòng. Theo dõi cách language server liên kết các chú thích có liên quan như generics, tham số, giá trị trả về, lớp, trường và bí danh; được coi là hoàn thành khi các chú thích trên cùng một dòng được diễn giải nhất quán với các chú thích trên các dòng riêng biệt.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua
- Lĩnh vực
- devtools
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100