Provide suggestions when command not found (#18984)

* register command not found handler

* can search from file

* new schema for command mapping file

* all features

* fuzzysharp

* refactor; 3rd party notice

* cutoff=90; no limit; rewrite messages

* Include oob migration

* format url

* resource strings (wip)

* regen designer.cs

* refactor

* strong name sign FuzzySharp.dll

* changelog; dict index

Author: isra-fel

LICENSE.txt

@@ -301,5 +301,39 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
+
+
+***************
+
+
+
+The software includes the FuzzySharp library.  The MIT License set out below is provided for informational purposes only. It is not the license that governs any part of the software.
+
+Provided for Informational Purposes Only
+
+FuzzySharp
+
+MIT License
+
+Copyright (c) 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
 -------------END OF THIRD PARTY NOTICE----------------------------------------
 

src/Accounts/Accounts/Accounts.csproj

@@ -41,6 +41,7 @@
 
   <ItemGroup>
     <EmbeddedResource Include="AzureRmAlias\Mappings.json" />
+    <EmbeddedResource Include="Utilities\CommandMappings.json" />
   </ItemGroup>
 
   <ItemGroup>
@@ -49,6 +50,12 @@
     <ProjectReference Include="..\Authenticators\Authenticators.csproj" />  
   </ItemGroup>
 
+  <ItemGroup>
+    <Reference Include="FuzzySharp">
+      <HintPath>..\..\lib\FuzzySharp.dll</HintPath>
+    </Reference>
+  </ItemGroup>
+   
   <ItemGroup>
     <Compile Update="Properties\Resources.Designer.cs">
       <DesignTime>True</DesignTime>

src/Accounts/Accounts/Az.Accounts.psd1

@@ -79,7 +79,8 @@ RequiredAssemblies = 'Microsoft.Azure.PowerShell.Authentication.Abstractions.dll
                'Microsoft.WindowsAzure.Storage.DataMovement.dll', 
                'Microsoft.Azure.PowerShell.Clients.Aks.dll', 
                'Microsoft.Azure.PowerShell.Strategies.dll', 
-               'Microsoft.Azure.PowerShell.Common.Share.dll'
+               'Microsoft.Azure.PowerShell.Common.Share.dll',
+               'FuzzySharp.dll'
 
 # Script files (.ps1) that are run in the caller's environment prior to importing this module.
 # ScriptsToProcess = @()

src/Accounts/Accounts/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Supported giving suggestions if an Azure PowerShell command cannot be found, for example when there is a typo in command name.
 
 ## Version 2.9.0
 * Supported exporting and importing configurations by `Export-AzConfig` and `Import-AzConfig`.

src/Accounts/Accounts/Properties/Resources.Designer.cs

@@ -540,4 +540,35 @@
   <data name="SubscriptionNotFouldPleaseCheckConfig" xml:space="preserve">
     <value>If a subscription is not specified, please check the configs by `Get-AzConfig`.</value>
   </data>
+  <data name="CommandNotFoundAzureRM" xml:space="preserve">
+    <value>The command {0} is in the AzureRM PowerShell module, which is outdated. See {1} for instructions to migrate to Az.</value>
+    <comment>0: command name; 1: link to AzureRM migration guide</comment>
+  </data>
+  <data name="CommandNotFoundDeprecated" xml:space="preserve">
+    <value>The command {0} has been deprecated in {1}.</value>
+    <comment>0: deprecated command name; 1: release name</comment>
+  </data>
+  <data name="CommandNotFoundReplaced" xml:space="preserve">
+    <value>The command {0} has been deprecated and replaced by {1} in {2}.</value>
+    <comment>0: deprecated command name; 1: command that replaced the deprecated one; 2: release name</comment>
+  </data>
+  <data name="SeeMigrationGuide" xml:space="preserve">
+    <value>Please refer to the migration guide {0}.</value>
+    <comment>0: link to migration guide</comment>
+  </data>
+  <data name="CommandNotFoundFuzzyStringPlural" xml:space="preserve">
+    <value>{0} is not found. The most similar Azure PowerShell commands are:</value>
+    <comment>0: command name</comment>
+  </data>
+  <data name="CommandNotFoundFuzzyStringSingle" xml:space="preserve">
+    <value>{0} is not found. The most similar Azure PowerShell command is:</value>
+    <comment>0: command name</comment>
+  </data>
+  <data name="AzureRMToAzMigrationGuideLink" xml:space="preserve">
+    <value>https://go.microsoft.com/fwlink/?linkid=2202029</value>
+  </data>
+  <data name="CommandNotFoundModuleNotInstalled" xml:space="preserve">
+    <value>The command {0} is part of Azure PowerShell module "{1}" and it is not installed. Run "Install-Module {1}" to install it.</value>
+    <comment>0: command being not found; 1: its module</comment>
+  </data>
 </root>