Skip to content

Exclude redundant parameter aliases from completion results #19382

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

Merged
iSazonov merged 3 commits into from
Mar 22, 2023
Merged

Exclude redundant parameter aliases from completion results #19382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b213888
Exclude redundant parameter aliases from completion results
MartinGC94 Mar 21, 2023
14bbef6
Fix test
MartinGC94 Mar 21, 2023
4415c0c
Update CompletionCompleters.cs
daxian-dbw Mar 21, 2023
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
41 changes: 27 additions & 14 deletions src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,13 +719,21 @@ private static List<CompletionResult> GetParameterCompletionResults(string param
string tooltip = parameterType + matchedParameterName;
result.Add(new CompletionResult(completionText, matchedParameterName, CompletionResultType.ParameterName, tooltip));
}

// Process alias when there is partial input
result.AddRange(from alias in param.Parameter.Aliases
where pattern.IsMatch(alias)
select
new CompletionResult("-" + alias + colonSuffix, alias, CompletionResultType.ParameterName,
parameterType + alias));
else
{
// Process alias when there is partial input
foreach (var alias in param.Parameter.Aliases)
{
if (pattern.IsMatch(alias))
{
result.Add(new CompletionResult(
$"-{alias}{colonSuffix}",
alias,
CompletionResultType.ParameterName,
parameterType + alias));
}
}
}

return result;
}
Expand Down Expand Up @@ -791,15 +799,20 @@ private static List<CompletionResult> GetParameterCompletionResults(
tooltip));
}
}

if (parameterName != string.Empty)
else if (parameterName != string.Empty)
{
// Process alias when there is partial input
listInUse.AddRange(from alias in param.Parameter.Aliases
where pattern.IsMatch(alias)
select
new CompletionResult("-" + alias + colonSuffix, alias, CompletionResultType.ParameterName,
type + alias));
foreach (var alias in param.Parameter.Aliases)
{
if (pattern.IsMatch(alias))
{
listInUse.Add(new CompletionResult(
$"-{alias}{colonSuffix}",
alias,
CompletionResultType.ParameterName,
type + alias));
}
}
}
}

Expand Down
3 changes: 1 addition & 2 deletions test/powershell/Host/TabCompletion/BugFix.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ Describe "Tab completion bug fix" -Tags "CI" {
It "Issue#1345 - 'Import-Module -n<tab>' should work" {
$cmd = "Import-Module -n"
$result = TabExpansion2 -inputScript $cmd -cursorColumn $cmd.Length
$result.CompletionMatches | Should -HaveCount 3
$result.CompletionMatches | Should -HaveCount 2
$result.CompletionMatches[0].CompletionText | Should -BeExactly "-Name"
$result.CompletionMatches[1].CompletionText | Should -BeExactly "-NoClobber"
$result.CompletionMatches[2].CompletionText | Should -BeExactly "-NoOverwrite"
}

It "Issue#11227 - [CompletionCompleters]::CompleteVariable and [CompletionCompleters]::CompleteType should work" {
Expand Down
20 changes: 16 additions & 4 deletions test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -871,6 +871,18 @@ class InheritedClassTest : System.Attribute
$res.CompletionMatches.CompletionText | Should -Contain 'TypeId'
}

it 'Should not complete parameter aliases if the real parameter is in the completion results' {
$res = TabExpansion2 -inputScript 'Get-ChildItem -p'
$res.CompletionMatches.CompletionText | Should -Not -Contain '-proga'
$res.CompletionMatches.CompletionText | Should -Contain '-ProgressAction'
}

it 'Should not complete parameter aliases if the real parameter is in the completion results (Non ambiguous parameters)' {
$res = TabExpansion2 -inputScript 'Get-ChildItem -prog'
$res.CompletionMatches.CompletionText | Should -Not -Contain '-proga'
$res.CompletionMatches.CompletionText | Should -Contain '-ProgressAction'
}

Context "Script name completion" {
BeforeAll {
Setup -f 'install-powershell.ps1' -Content ""
Expand Down Expand Up @@ -1646,15 +1658,15 @@ dir -Recurse `
It "Test completion with exact match" {
$inputStr = 'get-content -wa'
$res = TabExpansion2 -inputScript $inputStr -cursorColumn $inputStr.Length
$res.CompletionMatches | Should -HaveCount 4
[string]::Join(',', ($res.CompletionMatches.completiontext | Sort-Object)) | Should -BeExactly "-wa,-Wait,-WarningAction,-WarningVariable"
$res.CompletionMatches | Should -HaveCount 3
[string]::Join(',', ($res.CompletionMatches.completiontext | Sort-Object)) | Should -BeExactly "-Wait,-WarningAction,-WarningVariable"
}

It "Test completion with splatted variable" {
$inputStr = 'Get-Content @Splat -P'
$res = TabExpansion2 -inputScript $inputStr -cursorColumn $inputStr.Length
$res.CompletionMatches | Should -HaveCount 6
[string]::Join(',', ($res.CompletionMatches.completiontext | Sort-Object)) | Should -BeExactly "-Path,-PipelineVariable,-proga,-ProgressAction,-PSPath,-pv"
$res.CompletionMatches | Should -HaveCount 4
[string]::Join(',', ($res.CompletionMatches.completiontext | Sort-Object)) | Should -BeExactly "-Path,-PipelineVariable,-ProgressAction,-PSPath"
}

It "Test completion for HttpVersion parameter name" {
Expand Down