Parsing --help needs to return something other than an error
评估
调研方向
首先追踪 --help 文本的解析方式,以及解析错误和返回码的公开方式。查看链接的 halp issue 和 busted pull requests 中描述的行为,以作比较。完成的标准是:显式请求 --help 会生成帮助消息并返回成功状态,而无需调用方匹配消息文本。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Lua
- 星标
- 129
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
lunarmodules/lua_cliargs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
lunarmodules/lua_cliargs#85 · 1 条评论 ·
-
Option to accept multiple options not documented可能已有人在做 @copilot-swe-agent 于 77 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 48/100
lunarmodules/lua_cliargs#70 ·
-
难度 3/5 1-2 天 新手友好度 55/100
lunarmodules/lua_cliargs#69 ·
-
难度 3/5 1-2 天 新手友好度 35/100
lunarmodules/lua_cliargs#68 ·
-
难度 3/5 1-2 天 新手友好度 45/100
lunarmodules/lua_cliargs#67 ·
查看 lunarmodules/lua_cliargs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 88/100
jitsi/jitsi-meet#18020 ·
维护者通常 1 天内回复
-
GTK4 apps (Nautilus) aren't blurred: GTK 4.24's ext-background-effect makes Hyprland 0.56 skip blur未关闭
难度 1/5 1 小时以内 新手友好度 94/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 90/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
windwp/nvim-ts-autotag#266 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
folke/sidekick.nvim#362 ·