LuaLS / LuaLS/lua-language-server

Add the ability to annotate exceptions @raises

Đang mở
#1,610 3 bình luận 5 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ả

Hello! I have a suggestion to add a new annotation - @raises
I think it would be useful to anyone who has a layer of error classes in their module.

Example:

--- @class NetworkError: cdata
--- @field code number
--- @field body number

--- @raises
---| NetworkError
function some_func() 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ệp hoặc bài kiểm thử nào. Hãy bắt đầu bằng việc xem xét cách các annotation hiện có được phân tích cú pháp và xác thực, sau đó xác định hành vi dự kiến cho @raises và ví dụ NetworkError. Công việc được xem là hoàn tất khi annotation được nhận diện và kiểu ngoại lệ được khai báo cho nó được xử lý nhất quán.

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
32/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.