Skip to content

Improve command-line completion handling. #2719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −4
Open

Improve command-line completion handling. #2719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions src/System.CommandLine/Command.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,13 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con

if (context.WordToComplete is { } textToMatch)
{
// If the text to match is the command name, we should suggest all possible completions (subcommands, options, arguments).
var textToMatchIsCommandName = context.ParseResult.CommandResult.Command.Name.Equals(textToMatch, StringComparison.OrdinalIgnoreCase);
if (textToMatchIsCommandName)
{
textToMatch = null;
}

if (HasSubcommands)
{
var commands = Subcommands;
Expand All @@ -291,7 +298,7 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con
var argument = arguments[i];
foreach (var completion in argument.GetCompletions(context))
{
if (completion.Label.ContainsCaseInsensitive(textToMatch))
if (textToMatch is null || completion.Label.ContainsCaseInsensitive(textToMatch))
{
completions.Add(completion);
}
Expand Down Expand Up @@ -335,7 +342,7 @@ void AddCompletionsFor(Symbol identifier, AliasSet? aliases)
{
if (!identifier.Hidden)
{
if (identifier.Name.ContainsCaseInsensitive(textToMatch))
if (textToMatch is null || identifier.Name.ContainsCaseInsensitive(textToMatch))
{
completions.Add(new CompletionItem(identifier.Name, CompletionItem.KindKeyword, detail: identifier.Description));
}
Expand All @@ -344,7 +351,7 @@ void AddCompletionsFor(Symbol identifier, AliasSet? aliases)
{
foreach (string alias in aliases)
{
if (alias.ContainsCaseInsensitive(textToMatch))
if (textToMatch is null || alias.ContainsCaseInsensitive(textToMatch))
{
completions.Add(new CompletionItem(alias, CompletionItem.KindKeyword, detail: identifier.Description));
}
Expand Down
2 changes: 1 addition & 1 deletion src/System.CommandLine/Completions/CompletionAction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public override int Invoke(ParseResult parseResult)

int position = !string.IsNullOrEmpty(parsedValues) ? int.Parse(parsedValues) : rawInput?.Length ?? 0;

var commandLineToComplete = parseResult.Tokens.LastOrDefault(t => t.Type != TokenType.Directive)?.Value ?? "";
var commandLineToComplete = parseResult.Tokens.Where(t => t.Type != TokenType.Directive).Select(t => t.Value).ToArray();

var completionParseResult = parseResult.RootCommandResult.Command.Parse(commandLineToComplete, parseResult.Configuration);

Expand Down
Loading