LuaLS / LuaLS/lua-language-server

Feature Request: Do not diagnose unused-local for function parameters

Đang mở
#3,166 4 bình luận 0 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ả

This is a feature request for a new setting for LLS which would not diagnose unused-local for variables which are parameters of a function. Something like

"Lua.diagnostics.unusedLocalExcludeFuncParam": true

The reason I'd like this feature is because we have a Lua codebase that heavily relies on something similar to virtual functions, where there are many tables that have functions defined that share the same name and list of parameters, but some of these functions don't need to use all of the parameters. Think of something like this

function menu1:on_select_item(item, mouse_button) do_something_with_item(item) end
function menu2:on_select_item(item, mouse_button) do_something_with_mouse_button(mouse_button) end

Of course this could be changed to appeal to the current unused-local diagnostics by changing it to

function menu1:on_select_item(item) do_something_with_item(item) end
function menu2:on_select_item(_, mouse_button) do_something_with_mouse_button(mouse_button) end

but, besides doing the fixup being a lot of work, it makes maintenance of the code base worse because a programmer can't easily know anymore what those _ parmeters are supposed to be. Another alternative would be to add all known function parameter names to "Lua.diagnostics.unusedLocalExclude" (introduced via #619) but of course that also would be sub-optimal, because ignoring generic names like item could defeat the purpose of the diagnostic.

Besides function parameters, having an option to ignore for-loop variables would also be very neat. It's often easier there to substitute the name for _ but still, sometimes that loses important information on what the key/value of a for-loop over pairs(...) is. So something like

"Lua.diagnostics.unusedLocalExcludeForLoopVars": true

would also be very appreciated.

Thank you for your consideration, and of course for making LLS, it's awesome!

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 xác định chẩn đoán unused-local và thiết lập hiện có Lua.diagnostics.unusedLocalExclude. Xác định cách các tham số hàm và biến của vòng lặp for được nhận diện, sau đó định nghĩa và kiểm thử hai tùy chọn được yêu cầu để các thiết lập đã bật chỉ loại bỏ những chẩn đoán đó, trong khi các biến cục bộ không được sử dụng khác vẫn tiếp tục được báo cáo.

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.