commandlineparser / commandlineparser/commandline

Does the Options attribute class really need to be sealed?

未關閉
#859 3 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視
awaiting response
主要語言
C#
星號
4.8k
分支
478
PR 合併指標
30 天內沒有已合併 PR

描述

I have been using CommandLineParser for a while now (and it's changed how I build tools -- thank you!) including in a program with ~50 Verbs (and growing), and since many of the Verbs take common options, I was hoping to extend `Options` to provide common handling of them.

Simple example: if 15 Verbs take a `LogFile` option, each of which has a long name ("log-file") and a help description, I can do this now by constant strings to keep them consistent, but if I were able to do:

```
[AttributeUsage(AttributeTargets.Property)]
public class LogFileOptionAttribute : OptionAttribute
{
public LogFileOptionAttribute(bool required = false)
: base("log-file") // I don't use short option names for anything
{
HelpText = "Name of the logfile to use for blah blah blah";
Required = required;
}
}
```
and then adorn the actual option with:
```
public class BlahOptions {
...
[LogFileOption]
public string LogFileName {get ; set; }
...
}
```
I have easily a dozen of these common options. It's not a huge deal to create constant strings:
```
[Option(OPTION_LOGFILE_NAME, HelpText = OPTION_LOGFILE_HELPTEXT)]
```
but adding this level of abstraction would be more convenient.

If there's a good reason for this class to be sealed, then so be it, but mine doesn't feel like a ridiculous use case. I may well get to 100 verbs for this tool by the time I'm done.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

未指定檔案或測試。首先定位 C# Options/OptionAttribute 宣告及其 sealed 修飾子,然後檢查屬性如何被使用以及測試涵蓋情況。完成標準是,專案已就是否支援衍生選項屬性作出明確且經過審查的決定;如果決定為 yes,則相應更新 API 和測試。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp
領域
cli
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。