Consider an absent `:prog` for command help

オープン 初心者向け
#233 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
74/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
clojure
領域
cli

調査の方向性

issue の再現手順を使い、:prog オプションが指定されていない場合に help 出力をフォーマットする cli/dispatch パスから始めます。生成された Usage 行と Run 行を確認し、その後、プログラムが存在しないケースのリグレッションカバレッジを追加します。両方の行で不要な余分のスペースが省かれ、既存のコマンドヘルプが変更されていなければ完了です。

索引モデルが issue の本文から書いたものです。

説明

Scenario

Sometimes a program does not have a clear usage name.

For example, a program might be invoked via clojure -M:cli <some-command> [some-options].

In these cases, I don't specify :prog as a dispatch option.
bb cli lets me do this, but it results in an (admittedly nitpicky) output formatting issue.

Repro

For example:

(require '[babashka.cli :as cli])

(cli/dispatch {:cmd {"foo" {:fn identity
                            :doc "foo command help"}}}
              ["--help"]
              {:help true})

Outputs:

Usage:  [options] <command>

Commands:
  foo  foo command help

Options:
  -h, --help  Show this help

Run " <command> --help" for more information on a command.

It's a minor quibble, but notice the extra space before [options] in Usage: [options].
And after Run " on the last line.

Proposal

If :prog is not specified, don't display an extra space character in formatted outputs.

Next

Happy to do up a PR if this seems interesting to you.

主要言語
Clojure
スター
293
フォーク
22
平均マージ
13分
マージ済み PR(30日)
11

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

Clojure の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。