Skip to content

Remove duplicate modules from completion results #25538

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
May 12, 2025
Merged

Remove duplicate modules from completion results #25538

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
319d5b9
Remove duplicate modules from completion results
MartinGC94 May 11, 2025
ee3d8ce
Apply suggestion
MartinGC94 May 11, 2025
5882ffa
Add missing brace
MartinGC94 May 11, 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
9 changes: 7 additions & 2 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 @@ -499,11 +499,16 @@ internal static List<CompletionResult> CompleteModuleName(CompletionContext cont
nestedModulesToFilterOut = new(currentModule.NestedModules);
}

var completedModules = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
foreach (PSObject item in psObjects)
{
var moduleInfo = (PSModuleInfo)item.BaseObject;
var completionText = moduleInfo.Name;
var listItemText = completionText;
if (!completedModules.Add(completionText))
{
continue;
}

if (shortNameSearch
&& completionText.Contains('.')
&& !shortNamePattern.IsMatch(completionText.Substring(completionText.LastIndexOf('.') + 1))
Expand All @@ -526,7 +531,7 @@ internal static List<CompletionResult> CompleteModuleName(CompletionContext cont

completionText = CompletionHelpers.QuoteCompletionText(completionText, quote);

result.Add(new CompletionResult(completionText, listItemText, CompletionResultType.ParameterValue, toolTip));
result.Add(new CompletionResult(completionText, listItemText: moduleInfo.Name, CompletionResultType.ParameterValue, toolTip));
}
}

Expand Down
40 changes: 35 additions & 5 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 @@ -36,13 +36,13 @@ Describe "TabCompletion" -Tags CI {
It 'Should not include duplicate command results' {
$OldModulePath = $env:PSModulePath
$tempDir = Join-Path -Path $TestDrive -ChildPath "TempPsModuleDir"
$ModuleDirs = @(
Join-Path $tempDir "TestModule1\1.0"
Join-Path $tempDir "TestModule1\1.1"
Join-Path $tempDir "TestModule2\1.0"
)
try
{
$ModuleDirs = @(
Join-Path $tempDir "TestModule1\1.0"
Join-Path $tempDir "TestModule1\1.1"
Join-Path $tempDir "TestModule2\1.0"
)
foreach ($Dir in $ModuleDirs)
{
$NewDir = New-Item -Path $Dir -ItemType Directory -Force
Expand All @@ -61,6 +61,36 @@ Describe "TabCompletion" -Tags CI {
finally
{
$env:PSModulePath = $OldModulePath
Remove-Item -LiteralPath $ModuleDirs -Recurse -Force
}
}

It 'Should not include duplicate module results' {
$OldModulePath = $env:PSModulePath
$tempDir = Join-Path -Path $TestDrive -ChildPath "TempPsModuleDir"
try
{
$ModuleDirs = @(
Join-Path $tempDir "TestModule1\1.0"
Join-Path $tempDir "TestModule1\1.1"
)
foreach ($Dir in $ModuleDirs)
{
$NewDir = New-Item -Path $Dir -ItemType Directory -Force
$ModuleName = $NewDir.Parent.Name
Set-Content -Value 'MyTestFunction{}' -LiteralPath "$($NewDir.FullName)\$ModuleName.psm1"
New-ModuleManifest -Path "$($NewDir.FullName)\$ModuleName.psd1" -RootModule "$ModuleName.psm1" -FunctionsToExport "MyTestFunction" -ModuleVersion $NewDir.Name
}

$env:PSModulePath += [System.IO.Path]::PathSeparator + $tempDir
$Res = TabExpansion2 -inputScript 'Import-Module -Name TestModule'
$Res.CompletionMatches.Count | Should -Be 1
$Res.CompletionMatches[0].CompletionText | Should -Be TestModule1
}
finally
{
$env:PSModulePath = $OldModulePath
Remove-Item -LiteralPath $ModuleDirs -Recurse -Force
}
}

Expand Down
Loading