Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#72 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@TheMagician23 已经在做这个了。

开始于 2023年12月13日。

  • #78 来自 @TheMagician23 —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
lua
领域
cli

调研方向

首先追踪 --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,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

lunarmodules/lua_cliargs 的其他 Issue

查看 lunarmodules/lua_cliargs 的全部 Issue

相似的 Issue

更多 Lua Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。