commandlineparser / commandlineparser/commandline

SetName specific help text

Aberta
#870 0 comentários 1 reação 0 responsáveis Ver no GitHub
Linguagem predominante
C#
Estrelas
4.8k
Forks
478
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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;
}
}

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece localizando o ponto de entrada da geração do texto de ajuda e o tratamento dos atributos de Option com SetName. Compare a saída atual com o agrupamento proposto de web e ftp, incluindo opções compartilhadas como -r, --help e --version. Está concluído quando a ajuda gerada separar claramente os conjuntos mutuamente exclusivos, mantendo as opções comuns.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp
Domínio
cli
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.