Remove duplicate modules from completion results (#25538)

MartinGC94 · web-flow · commit e7ee9da1eaec · 2025-05-12T08:18:11.000+05:00
diff --git a/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs b/src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs
@@ -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))
@@ -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));
                 }
             }
 
diff --git a/test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1 b/test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
@@ -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
@@ -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
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -499,11 +499,16 @@ internal static List<CompletionResult> CompleteModuleName(CompletionContext cont`
`499`	`499`	`nestedModulesToFilterOut = new(currentModule.NestedModules);`
`500`	`500`	`}`
`501`	`501`
	`502`	`+ var completedModules = new HashSet<string>(StringComparer.OrdinalIgnoreCase);`
`502`	`503`	`foreach (PSObject item in psObjects)`
`503`	`504`	`{`
`504`	`505`	`var moduleInfo = (PSModuleInfo)item.BaseObject;`
`505`	`506`	`var completionText = moduleInfo.Name;`
`506`		`- var listItemText = completionText;`
	`507`	`+ if (!completedModules.Add(completionText))`
	`508`	`+ {`
	`509`	`+ continue;`
	`510`	`+ }`
	`511`	`+`
`507`	`512`	`if (shortNameSearch`
`508`	`513`	`&& completionText.Contains('.')`
`509`	`514`	`&& !shortNamePattern.IsMatch(completionText.Substring(completionText.LastIndexOf('.') + 1))`
`@@ -526,7 +531,7 @@ internal static List<CompletionResult> CompleteModuleName(CompletionContext cont`
`526`	`531`
`527`	`532`	`completionText = CompletionHelpers.QuoteCompletionText(completionText, quote);`
`528`	`533`
`529`		`- result.Add(new CompletionResult(completionText, listItemText, CompletionResultType.ParameterValue, toolTip));`
	`534`	`+ result.Add(new CompletionResult(completionText, listItemText: moduleInfo.Name, CompletionResultType.ParameterValue, toolTip));`
`530`	`535`	`}`
`531`	`536`	`}`
`532`	`537`