LuaLS / LuaLS/lua-language-server

Is it possible to annotate nodiscard for fields of a class?

Đang mở
#2,434 0 bình luận 2 reaction 0 người được giao Xem trên GitHub

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?

Windows

What is the issue affecting?

Annotations

Expected Behaviour

I hope there is a way to annotate that a field of a class is a @nodiscard function.

Actual Behaviour

currently there is no way to annotate that a field of a class is @nodiscard

Reproduction steps
  1. Go to your code editor and write a class, for example:
---@class Item
---@field getPosition fun(self: Item): table
Item = {}
  1. Try annotate getPosition field as @nodiscard
Additional Notes

No response

Log File

No response

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách theo dõi cách language server phân tích cú pháp và áp dụng các annotation @class và @field, sau đó so sánh quy trình đó với cách xử lý @nodiscard hiện có. Xác định cú pháp annotation cho một trường của class có kiểu là một hàm, và xác minh rằng các kết quả không được sử dụng từ trường đó tạo ra diagnostic như mong đợi.

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
Tính năng
Độ 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
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.