添加 `[help]` 方法属性,这样 `just <recipe> --help` 就可以运行 `just --usage <recipe>`
作者: pygarap创建于 2026年1月24日更新于 2026年7月19日
□ 总结
添加一个新的配方属性[帮助]',使只是 --help' 打印食谱使用量输出(与just --usage <recipe>-'相同)并退出,而不运行食谱。
□动机
just --usage <recipe} 已经生成一个有用的用法块,包括通过 arg (., help=.)] 添加的参数帮助' 。 对于本来要像小型国别倡议那样引用的食谱,更自然地支持`只是-help'的共同模式。
□ 提议的行为
鉴于配有 " [帮助] " 的配方:
只是recipe' -- -- 帮助 ' 行为完全像`只是-usage <recipe'。- 食谱机构没有被执行。
- 退出代码是0。
如果食谱上没有 " [帮助] " 标记,行为不变。
□ 实例
刚刚 [帮助] [arg ("FLAG",长="lag",值="-flag",帮助="可选行为")]. [arg ("MODE",长="mode",值="-mode ",帮助="选择一个模式(例如:快,安全)")]. [arg ("TARGET",长="目标",值="-目标<路径>,帮助="Path to operation on")]. 做事 FLAG=""MODE=""TARGET=": 呼应"运行与QQFLAG" 与QQMODE"TARGET"".
预期:
- `只要做事情 -- -- 帮助 ' 打印出与`只要 -- -- usage do -- -- thing ' 相同的产出,包括`帮助'. ' 说明中的弦。
- " 做点什么 -- -- 模样快 -- -- 目标 -- -- /src -- -- flag " 通常运行食谱。
□ 兼容性注释
这是每个食谱的选择。 用`[帮助]'标出一个配方,保留用于该配方的用法的`-帮助'符号,而不是把它当作一个正常的论证值.内容来源: casey/just