LuaLS / LuaLS/lua-language-server

An annotation for indicating that a function may error

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

It would be pretty useful to have an indicator of whether the function may error (and thus needs to be handled with pcall or the like).

---@fallible
---@param bar string
---@return string bar
local function assert_is_foobar(bar)
    if bar ~= "foobar" then
        error("bar isn't equal to foobar")
    end
    return bar
end

I'm aware of #1881 but it doesn't fullfill the same purpose as @fallible, the main difference being the fact that @noreturn indicates that the function never returns while this indicates that the function could return an error

The LSP server could also potentially show the user a warning if they don't wrap a @fallible function in a pcall call

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

Trước tiên, hãy xem xét cách language server hiện xử lý annotation @noreturn liên quan và cách nó phân tích việc sử dụng pcall. Issue không nêu tên file hoặc test, và hành vi cảnh báo dự kiến được mô tả là tùy chọn, vì vậy cần làm rõ phạm vi triển khai và tiêu chí hoàn thành trước khi bắt đầu viết code.

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
Cần làm rõ
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.