commandlineparser / commandlineparser/commandline

SetName specific help text

オープン
#870 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
4.8k
フォーク
478
PR マージ指標
30日以内にマージされた PR はありません

説明

Propose a smarter help text when SetName exists, prefer separated help text based on SetName, because the current help text doesn't tell users options in different SetNames are exclusive.

we could have help text as below:

**web** command:

--documentroot

--enablejavascript

-r

--help Display this help screen.

--version Display version information.

**ftp** command:

--ftpdirectory

--anonymouslogin

-r

--help Display this help screen.

--version Display version information.

Example option:

public class OptionsMutuallyExclusive
{
//Implement commands in set(group) named web
[Option(SetName = "web")]
public string DocumentRoot
{
get;
set;
}

[Option(SetName = "web")]
public bool EnableJavaScript
{
get;
set;
}

//Implement other commands in set(group) named ftp
[Option(SetName = "ftp")]
public string FtpDirectory
{
get;
set;
}

[Option(SetName = "ftp")]
public bool AnonymousLogin
{
get;
set;
}

//Common option, can be used with any set because it's not included in a set
[Option('r')]
public string UrlAddress
{
get;
set;
}
}

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

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

調査の方向性

まず、ヘルプテキスト生成のエントリーポイントと、SetName を持つ Option 属性の処理を見つけます。現在の出力を、-r、--help、--version などの共通オプションを含む、提案された web と ftp のグループ化と比較します。生成されたヘルプで相互排他的なセットが明確に分離され、共通オプションが維持されていれば完了です。

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

評価

技術スタック
csharp
領域
cli
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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