Skip to content

Add -FuzzyMinimumDistance parameter to Get-Command #18261

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
daxian-dbw merged 6 commits into from
Oct 12, 2022
Merged

Add -FuzzyMinimumDistance parameter to Get-Command #18261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
980f487
Add `-FuzzyMinimumDistance` parameter to `Get-Command`
SteveL-MSFT Oct 11, 2022
d15ce02
Update src/System.Management.Automation/engine/GetCommandCommand.cs
SteveL-MSFT Oct 11, 2022
540be8a
Update src/System.Management.Automation/engine/GetCommandCommand.cs
SteveL-MSFT Oct 11, 2022
bd1489a
address Dongbo's feedback
SteveL-MSFT Oct 11, 2022
94786e8
align results with _commandScores
SteveL-MSFT Oct 12, 2022
6363794
Fix one CodeFactor issue
daxian-dbw Oct 12, 2022
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
29 changes: 24 additions & 5 deletions src/System.Management.Automation/engine/GetCommandCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,13 @@ public PSTypeName[] ParameterType
[Parameter(ParameterSetName = "AllCommandSet")]
public SwitchParameter UseFuzzyMatching { get; set; }

private readonly List<CommandScore> _commandScores = new List<CommandScore>();
/// <summary>
/// Gets or sets the minimum fuzzy matching distance.
/// </summary>
[Parameter(ParameterSetName = "AllCommandSet")]
public uint FuzzyMinimumDistance { get; set; } = 5;

private List<CommandScore> _commandScores = new List<CommandScore>();

/// <summary>
/// Gets or sets the parameter that determines if return cmdlets based on abbreviation expansion.
Expand Down Expand Up @@ -501,13 +507,16 @@ private void OutputResultsHelper(IEnumerable<CommandInfo> results)

if (UseFuzzyMatching)
{
results = _commandScores.OrderBy(static x => x.Score).Select(static x => x.Command).ToList();
_commandScores = _commandScores
.Where(x => x.Score <= FuzzyMinimumDistance)
.OrderBy(static x => x.Score)
.ToList();
results = _commandScores.Select(static x => x.Command);
}

int count = 0;
foreach (CommandInfo result in results)
{
count += 1;
// Only write the command if it is visible to the requestor
if (SessionState.IsVisible(origin, result))
{
Expand All @@ -532,11 +541,21 @@ private void OutputResultsHelper(IEnumerable<CommandInfo> results)
}
else
{
// Write output as normal command info object.
WriteObject(result);
if (UseFuzzyMatching)
{
PSObject obj = new PSObject(result);
obj.Properties.Add(new PSNoteProperty("Score", _commandScores[count].Score));
WriteObject(obj);
}
else
{
WriteObject(result);
}
}
}
}

count += 1;
}

#if LEGACYTELEMETRY
Expand Down
9 changes: 9 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Command.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Describe "Get-Command Feature tests" -Tag Feature {
$cmds = Get-Command get-hlp -UseFuzzyMatch
$cmds.Count | Should -BeGreaterThan 0
$cmds[0].Name | Should -BeExactly 'Get-Help' -Because "This should be closest match so shows up first"
$cmds[0].Score | Should -Be 1
}

It "Should match native commands" {
Expand All @@ -20,6 +21,14 @@ Describe "Get-Command Feature tests" -Tag Feature {
$cmds.Count | Should -BeGreaterThan 0
$cmds.Name | Should -Contain $expectedcmd
}

It "Should use minimum distance" {
$cmds = Get-Command get-hlp -UseFuzzyMatch -FuzzyMinimumDistance 3
$cmds.Count | Should -BeGreaterThan 0
foreach ($cmd in $cmds) {
$cmd.Score | Should -BeLessOrEqual 3
}
}
}

Context "-UseAbbreviationExpansion tests" {
Expand Down