Skip to content

Improvements to [suggest] directive #2718

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

Closed
wants to merge 2 commits into from
Closed

Improvements to [suggest] directive #2718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29a6475
Improve completion logic to support suggestion of subcommands.
rvuistin Nov 7, 2025
391ff81
Generate completions in the context of the command being executed.
rvuistin Nov 7, 2025
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: 7 additions & 6 deletions src/System.CommandLine/Command.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,10 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con
if (HasSubcommands)
{
var commands = Subcommands;
var textToMatchIsCommandName = context.ParseResult.CommandResult.Command.Name.IndexOfCaseInsensitive(textToMatch) >= 0;
for (int i = 0; i < commands.Count; i++)
{
AddCompletionsFor(commands[i], commands[i]._aliases);
AddCompletionsFor(commands[i], commands[i]._aliases, textToMatchIsCommandName ? null : textToMatch);
}
}

Expand All @@ -279,7 +280,7 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con
var options = Options;
for (int i = 0; i < options.Count; i++)
{
AddCompletionsFor(options[i], options[i]._aliases);
AddCompletionsFor(options[i], options[i]._aliases, textToMatch);
}
}

Expand Down Expand Up @@ -314,7 +315,7 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con

if (option.Recursive)
{
AddCompletionsFor(option, option._aliases);
AddCompletionsFor(option, option._aliases, textToMatch);
}
}
}
Expand All @@ -331,11 +332,11 @@ public override IEnumerable<CompletionItem> GetCompletions(CompletionContext con
.OrderBy(item => item.SortText.IndexOfCaseInsensitive(context.WordToComplete))
.ThenBy(symbol => symbol.Label, StringComparer.OrdinalIgnoreCase);

void AddCompletionsFor(Symbol identifier, AliasSet? aliases)
void AddCompletionsFor(Symbol identifier, AliasSet? aliases, string? textToMatch)
{
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 +345,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
4 changes: 2 additions & 2 deletions src/System.CommandLine/Completions/CompletionAction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ public override int Invoke(ParseResult parseResult)
string? parsedValues = parseResult.GetResult(_directive)!.Values.SingleOrDefault();
string? rawInput = parseResult.CommandLineText;

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

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

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

var completions = completionParseResult.GetCompletions(position);

Expand Down
Loading