LuaLS / LuaLS/lua-language-server
@overload does not cooperate with @alias
Đang mở
Chưa có ai nhận issue này.
enhancement
feat/LuaCats Annotations
- 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?
Windows
What is the issue affecting?
Annotations, Diagnostics/Syntax Checking
Expected Behaviour
When I define an @alias, an @overload command should be able to use it.
Actual Behaviour
I receive the error:
`fun` expected. Lua Syntax Check.(luadoc-miss-fun-after-overload)
Reproduction steps
---@alias what fun():"ok"
---@class huh
---@overload what
local huh = {}
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
Bắt đầu với việc xử lý chú thích tài liệu Lua cho @alias và @overload, sử dụng reproduction trong issue làm trường hợp đầu tiên cần chạy. Truy vết lý do @overload tạo ra chẩn đoán luadoc-miss-fun-after-overload. Được xem là hoàn tất khi overload dựa trên alias được chấp nhận mà không có chẩn đoán đó, trong khi cú pháp overload hiện có vẫn hợp lệ.
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ó
- 3/5
- Thời gian dự kiến
- 1-2 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