Skip to content

Add support to show suggestions on CommandNotFound exception#8458

Merged
TravisEz13 merged 6 commits intoPowerShell:masterfrom
SteveL-MSFT:fuzzy-match
Jan 10, 2019
Merged

Add support to show suggestions on CommandNotFound exception#8458
TravisEz13 merged 6 commits intoPowerShell:masterfrom
SteveL-MSFT:fuzzy-match

Conversation

@SteveL-MSFT
Copy link
Member

@SteveL-MSFT SteveL-MSFT commented Dec 13, 2018 •
edited
Loading

PR Summary

Add -UseFuzzyMatching switch to Get-Command to return commands that fuzzy match to the name in order of closest match to least. Integrate this with the suggestion framework so that on a CommandNotFound exception, suggestions are shown for likely commands the user intended. The suggestions are part of the console host and write directly to the console so don't see a way to test that. In the future, we should consider changing that to using information stream.

Example usage

PR Checklist

@SteveL-MSFT SteveL-MSFT force-pushed the fuzzy-match branch 3 times, most recently from c19e787 to 34e954b Compare December 14, 2018 18:32
@SteveL-MSFT SteveL-MSFT mentioned this pull request Dec 14, 2018
Merged
9 tasks
@iSazonov
Copy link
Collaborator

iSazonov commented Dec 14, 2018

We could consider other names of the parameter: -Fuzzy, -FuzzyMatching, -ShowSuggestions, -Suggestions.

We need PowerShell Committee approvement for the new public API.

@SteveL-MSFT SteveL-MSFT added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label Dec 14, 2018
@rjmholt
Copy link
Collaborator

rjmholt commented Dec 17, 2018

We could introduce a test hook to do something like write output to the information stream or to a variable for testing purposes for now

PaulHigin
PaulHigin suggested changes Dec 17, 2018
View reviewed changes
@SteveL-MSFT
Copy link
Member Author

SteveL-MSFT commented Dec 18, 2018

@rjmholt I suggest we defer the test hook as that would make sense for testing suggestions in general and not this specific change.

@iSazonov
Copy link
Collaborator

iSazonov commented Dec 18, 2018

It was good to have a tracking issue if we needed these special tests.

@SteveL-MSFT
Copy link
Member Author

SteveL-MSFT commented Dec 18, 2018

@iSazonov created #8486

rjmholt
rjmholt reviewed Dec 18, 2018
View reviewed changes
@TravisEz13
Copy link
Member

TravisEz13 commented Jan 3, 2019

@SteveL-MSFT Do you want to wait on Rob to review your changes?

@SteveL-MSFT
Copy link
Member Author

SteveL-MSFT commented Jan 4, 2019 •
edited
Loading

@TravisEz13 if @rjmholt has further comments, we can treat it as a separate issue and PR. Would like to get this in for next Preview

@iSazonov
Copy link
Collaborator

iSazonov commented Jan 4, 2019

It would be good to fix some style issues and "s_" before merge.

SteveL-MSFT
SteveL-MSFT commented Jan 5, 2019
View reviewed changes
@SteveL-MSFT
Copy link
Member Author

SteveL-MSFT commented Jan 9, 2019

@PowerShell/powershell-committee reviewed this and is ok with -UseFuzzyMatching

@SteveL-MSFT SteveL-MSFT added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Jan 9, 2019
@SteveL-MSFT
[feature]
bea7335 
support fuzzy matching with get-command and on CommandNotFound exception, show suggestion
@SteveL-MSFT
fix CodeFactor issues
42e8452
@SteveL-MSFT
change algorithm to use Damerau-Levenshtein Distance which is more us…
bef4bc1 
…eful in finding close matches
@SteveL-MSFT
address Paul's feedback
6a21e2a 
removed use of Tuple and created struct
@TravisEz13 TravisEz13 added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Jan 10, 2019
@TravisEz13 TravisEz13 merged commit b87cd1c into PowerShell:master Jan 10, 2019
@SteveL-MSFT SteveL-MSFT deleted the fuzzy-match branch January 10, 2019 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov left review comments

@anmenaga anmenaga Awaiting requested review from anmenaga

@BrucePay BrucePay Awaiting requested review from BrucePay

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw

+2 more reviewers

@rjmholt rjmholt rjmholt approved these changes

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@TravisEz13 TravisEz13

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Committee-Reviewed PS-Committee has reviewed this and made a decision

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@SteveL-MSFT @iSazonov @rjmholt @TravisEz13 @PaulHigin