LuaLS / LuaLS/lua-language-server

[Question/Request] Can I recycle common params for differing functions without mass copy+paste?

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

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ả

I would like to be able to recycle a list of parameters (and types), sometimes with an extra parameter or a different set of return values. I only know how to do this via copy+paste of parameters from one function to the next, and edit as needed. However, I am trying to reduce the code volume, clarity, as well as make it easier to enact changes that should cascade to any function which uses those sets of parameters.

Here's an example:

---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table
function foo(blah, barf, puke, thanks)
end

---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table
---@return boolean
function bar(blah, barf, puke, thanks)
    return true
end

I'd like to be able to define a 'defined parameter set' which would allow me to do something like this:

---@parameters hmmm
---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table

---@uses parameters hmmm
function foo(blah, barf, puke, thanks)
end

---@uses parameters hmmm
---@return boolean
function bar(blah, barf, puke, thanks)
    return true
end

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

Issue không nêu tên các tệp triển khai, bài kiểm thử hoặc các điểm vào. Hãy bắt đầu bằng cách xác định cách các chú thích Lua như @param và @return được phân tích, sau đó đánh giá cách một khai báo tập tham số có thể tái sử dụng và việc sử dụng nó sẽ phù hợp với cú pháp đó như thế nào. Được xem là hoàn tất khi các tham số dùng chung có thể được ghi tài liệu một lần, được nhiều hàm tái sử dụng, được mở rộng hoặc kết hợp với các giá trị trả về khác nhau và được kiểm thử.

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ó
5/5
Thời gian dự kiến
Hơn một tuần
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
25/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.