Completion sometimes returns apparent duplicates

[lzybkr]

This doesn't always repro, but in Emacs mode:

PS> Get-PSReadlineOp<TAB>

Expected - just one completion, actual:

Get-PSReadlineOption    Get-PSReadlineOption

[lzybkr]

This might only repro without TabExpansionPlusPlus loaded.

[erichiller]

I'm seeing this too. I do not have TabExpansionPlusPlus installed.

Here is my output for get-module:

get-module -all

ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     0.0        GitStatusCachePoshClient            {Get-GitStatusCacheStatistics, Get-GitStatusFromCache, Remove-GitStatusCache, Restart-GitStatusCache...}
Binary     3.0.0.0    Microsoft.PowerShell.Commands.Ma... {Add-Content, Clear-Content, Clear-ItemProperty, Join-Path...}
Binary     3.0.0.0    Microsoft.PowerShell.Commands.Ut... {New-Object, Measure-Object, Select-Object, Sort-Object...}
Manifest   3.1.0.0    Microsoft.PowerShell.Management     {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Content...}
Binary     1.0.0.0    Microsoft.PowerShell.PSReadLine     {Get-PSReadlineOption, Set-PSReadlineOption, Set-PSReadlineKeyHandler, Get-PSReadlineKeyHandler...}
Script     0.0        Microsoft.PowerShell.Utility        {ConvertFrom-SddlString, Format-Hex, Get-FileHash, Import-PowerShellDataFile...}
Manifest   3.1.0.0    Microsoft.PowerShell.Utility        {Add-Member, Add-Type, Clear-Variable, Compare-Object...}
Script     0.6.1.2... posh-git                            {Add-SshKey, Enable-GitColors, Get-AliasPattern, Get-GitDirectory...}
Script     1.0.0.0    PSColor
Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlineKeyHandler...}
Script     2.0.0      PSSudo                              {Invoke-ElevatedCommand, Start-Elevated, sudo}

and

get-module

ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     0.0        GitStatusCachePoshClient            {Get-GitStatusCacheStatistics, Get-GitStatusFromCache, Remove-GitStatusCache, Restart-GitStatusCache...}
Manifest   3.1.0.0    Microsoft.PowerShell.Management     {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Content...}
Manifest   3.1.0.0    Microsoft.PowerShell.Utility        {Add-Member, Add-Type, Clear-Variable, Compare-Object...}
Script     0.6.1.2... posh-git                            {Add-SshKey, Enable-GitColors, Get-AliasPattern, Get-GitDirectory...}
Script     1.0.0.0    PSColor
Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlineKeyHandler...}
Script     2.0.0      PSSudo                              {Invoke-ElevatedCommand, Start-Elevated, sudo}

Upon tab:

get-psreadline<tab>
Get-PSReadlineKeyHandler  Get-PSReadlineOption      Get-PSReadlineKeyHandler  Get-PSReadlineOption

Updated as admin with:

powershell -noprofile -command "Install-Module PSReadline -Force -SkipPublisherCheck"

[slumos]

Here's what I get:

29Mar 19:41:57 $HOME> powershell -noprofile
Windows PowerShell
Copyright (C) 2016 Microsoft Corporation. All rights reserved.

PS C:\Users\slumos> Import-Module PSReadline
PS C:\Users\slumos> Get-Module

ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Manifest   3.1.0.0    Microsoft.PowerShell.Management     {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Content...}
Manifest   3.1.0.0    Microsoft.PowerShell.Utility        {Add-Member, Add-Type, Clear-Variable, Compare-Object...}
Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlin...


PS C:\Users\slumos> Set-PSReadlineOption -EditMode Emacs
PS C:\Users\slumos> get-psread
Get-PSReadlineKeyHandler  Get-PSReadlineOption      Get-PSReadlineKeyHandler  Get-PSReadlineOption
PS C:\Users\slumos> get-psread

[erichiller]

Tried debugging this some more. Again, this is on 3 machines all win10x64, but running quite different versions. One is insiders ring. One is Creators Edition. One is last years release (Win10 Enterprise).

If this output helps any:

$( Foreach ($m in Get-Module) { "module=$m" ; Foreach ($c in $m.NestedModules) { echo $c }} ) | grep "Get-PSReadlineKeyHandler" -n -A 10 -B 5
11-Script     0.0        Agnoster                            Write-Theme

12-Script     0.0        omega                               Write-Theme

13-module=posh-git
14-module=PSColor
15-module=PSReadline
16:Binary     3.0.0.0    Microsoft.PowerShell.PSReadLine     {Get-PSReadlineOption, Set-PSReadlineOption, Set-PSReadlineKeyHandler, Get-PSReadlineKeyHandler...}

17-module=PSSudo
18-
19-

$( Foreach ($m in Get-Module) { $m ; Foreach ($c in $m.NestedModules) { echo $c }} ) | grep "Get-PSReadlineKeyHandler" -n
15:Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlineKeyHandler...}

16:Binary     3.0.0.0    Microsoft.PowerShell.PSReadLine     {Get-PSReadlineOption, Set-PSReadlineOption, Set-PSReadlineKeyHandler, Get-PSReadlineKeyHandler...}

$( Foreach ($m in Get-Module) { $m ; Foreach ($c in $m.ExportedFunctions) { echo $c }} ) | grep "Get-PSReadlineKeyHandler" -n
162:Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlineKeyHandler...}

$( Foreach ($m in Get-Module) { $m ; Foreach ($c in $m.ExportedCommands) { echo $c }} ) | grep "Get-PSReadlineKeyHandler" -n
954:Script     1.2        PSReadline                          {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PSReadlineKeyHandler, Set-PSReadlineKeyHandler...}

956:Key   : Get-PSReadlineKeyHandler
957:Value : Get-PSReadlineKeyHandler

[erichiller]

If it helps any; this occurs on 3 machines, running 3 versions of windows 10.
If I open plain powershell, no profile. and tab through, I still get them, just cycles through

Get-PSReadlineKeyHandler
Get-PSReadlineOption
PSReadline\Get-PSReadlineKeyHandler
PSReadline\Get-PSReadlineOption

[lzybkr]

I think we concluded this was a somewhat obscure problem with PowerShell where a nested module name did not match the main module. I'm not sure how many modules this affects, but I think I've seen it with modules other than PSReadline.

When I finally get around to doing something about this, I'll probably just do some filtering on the duplicates. The original design to include module qualified names isn't that useful (even when it's pointing out two commands from different modules), so removing those when there are apparent duplicates seems like the best user experience.

[rkeithhill]

The original design to include module qualified names isn't that useful

Why? Seems like it would be useful for the scenario you mention (multiple commands with the same name). It would let me know there are duplicates and I wouldn't have to go lookup the module name to invoke the command I want.

[lzybkr]

I didn't say it wasn't useful, just not useful enough to put a lot of effort into keeping it working perfectly when this sort of problem comes up. I think I can keep it mostly working, just not perfectly working.

[Weishaupt]

To give you an example, where this happens apart from the PSReadLine module:

> powershell -noprofile
> Set-PSReadlineKeyHandler -Key Tab -Function Complete
> Connect-M<TAB><TAB>
Connect-MsolService  Connect-MsolService
> Get-Command Connect-M*
CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Cmdlet          Connect-MsolService                                1.0        MSOnline
Cmdlet          Connect-MsolService                                1.0        MSOnlineExtended

I'd appreciate a solution for this bug, as it makes tab completion entirely useless for the MSOnline module, as all Commands are included in MSOnlineExtended as well.

[trondhindenes]

Anyone found a workaround to this?

[lzybkr]

I've lived with this longer than anyone so I should be thoroughly annoyed with it, and I guess I am, so if somebody doesn't beat me to it, it will get fixed some day.

My workaround that makes it not so bad - hit Ctrl+Space - the one I want is usually the first, so space or enter after that is usually all it takes.

[lzybkr]

We'll try out this fix - ignoring any item where the menu item text is duplicate. Hopefully it doesn't hide other useful completion results, if it does, there might be other options like changing the menu item text to match the completion text, but I think that will get ugly.