Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Parsing --help needs to return something other than an error

Đang mở
  • Có gì không ổn?
#72 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

@TheMagician23 đang làm issue này rồi.

Từ ngày 13/12/2023.

  • #78 của @TheMagician23 — đang mở

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
lua
Lĩnh vực
cli

Hướng nghiên cứu

Bắt đầu bằng cách lần theo cách văn bản --help được phân tích cú pháp và cách các lỗi phân tích cú pháp cùng mã trả về được cung cấp. Xem lại để so sánh hành vi được mô tả trong issue halp được liên kết và các pull request của busted. Được xem là hoàn thành khi yêu cầu rõ ràng --help tạo ra thông báo trợ giúp với trạng thái thành công mà không yêu cầu bên gọi phải khớp với nội dung thông báo.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The way the --help text is parsed the message is returned in the same field as an actual parsing error, and the return code is the same as if it was a failure case. However a user actually passing --help explicitly should be considered a success.

The only way I came up with to work around this was to test the error string for :match("^Usage:") and switch gears from error handling to closing with a success status after the message. There really should be a more ergonomic way to do this. As it is most lua apps that implement CLIs with this library return a failure code when they should not.

c.f. https://github.com/orhun/halp/issues/20
c.f. https://github.com/sile-typesetter/sile/pull/1737/files
c.f. https://github.com/lunarmodules/busted/pull/732
c.f. https://github.com/lunarmodules/busted/pull/733#discussion_r1429943388

Ngôn ngữ chính
Lua
Star
129
Fork
26
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của lunarmodules/lua_cliargs

Tất cả issue của lunarmodules/lua_cliargs

Issue tương tự

Thêm issue về Lua

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.