Add CorrectionExtent description to some rules

Author: Kapil Borle

Rules/AvoidAlias.cs

@@ -78,13 +78,15 @@ private List<CorrectionExtent> GetCorrectionExtent(CommandAst cmdAst, string cmd
             var alias = cmdAst.GetCommandName();
             var startColumnNumber = ext.StartColumnNumber + ext.Text.IndexOf(alias);
             var endColumnNumber = startColumnNumber + alias.Length;
+            string description = string.Format("Replace {0} with {1}", alias, cmdletName);
             corrections.Add(new CorrectionExtent(                
                 ext.StartLineNumber,
                 ext.EndLineNumber,
                 startColumnNumber,
                 endColumnNumber,
                 cmdletName,
-                ext.File));
+                ext.File,
+                description));
             return corrections;
         }
 

Rules/AvoidUsingPlainTextForPassword.cs

@@ -73,14 +73,16 @@ private List<CorrectionExtent> GetCorrectionExtent(ParameterAst paramAst)
         {
             IScriptExtent ext = paramAst.Extent;
             var corrections = new List<CorrectionExtent>();            
-            string correctionText = string.Format("{0} {1}", "[SecureString]", paramAst.Name.Extent.Text);
+            string correctionText = string.Format("[SecureString] {0}", paramAst.Name.Extent.Text);
+            string description = string.Format("Set {0} type to SecureString", paramAst.Name.Extent.Text);
             corrections.Add(new CorrectionExtent(
                 ext.StartLineNumber,
                 ext.EndLineNumber,
                 ext.StartColumnNumber,
                 ext.EndColumnNumber,
                 correctionText,
-                ext.File));
+                ext.File,
+                description));
             return corrections;
         }
 

Rules/MisleadingBacktick.cs

@@ -76,14 +76,16 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         /// <returns>Returns a list of suggested corrections</returns>
         private List<CorrectionExtent> GetCorrectionExtent(IScriptExtent violationExtent)
         {           
-            var corrections = new List<CorrectionExtent>();            
+            var corrections = new List<CorrectionExtent>();
+            string description = "Remove trailing whilespace";
             corrections.Add(new CorrectionExtent(                
                 violationExtent.StartLineNumber ,
                 violationExtent.EndLineNumber,
                 violationExtent.StartColumnNumber + 1,
                 violationExtent.EndColumnNumber,
                 String.Empty,
-                violationExtent.File));
+                violationExtent.File,
+                description));
             return corrections;
         }
 

Rules/UseToExportFieldsInManifest.cs

@@ -126,14 +126,16 @@ private List<CorrectionExtent> GetCorrectionExtent(string field, IScriptExtent e
                     break;
                 default:
                     throw new NotImplementedException(string.Format("{0} not implemented", field));
-            }            
+            }
+            string description = string.Format("Replace {0} with {1}", extent.Text, correctionText);
             corrections.Add(new CorrectionExtent(
                 extent.StartLineNumber,
                 extent.EndLineNumber,
                 extent.StartColumnNumber,
                 extent.EndColumnNumber,
                 correctionText,
-                extent.File));
+                extent.File,
+                description));
             return corrections;
         }
 

Tests/Rules/AvoidUsingAlias.tests.ps1

@@ -19,7 +19,10 @@ Describe "AvoidUsingAlias" {
 	It "suggests correction" {
 	   Import-Module .\PSScriptAnalyzerTestHelper.psm1
 	   Test-CorrectionExtent $violationFilepath $violations[0] 1 'iex' 'Invoke-Expression'
+	   $violations[0].SuggestedCorrections[0].Description | Should Be 'Replace iex with Invoke-Expression'
+
 	   Test-CorrectionExtent $violationFilepath $violations[1] 1 'cls' 'Clear-Host'
+	   $violations[1].SuggestedCorrections[0].Description | Should Be 'Replace cls with Clear-Host'
 	}
     }
 

Tests/Rules/AvoidUsingPlainTextForPassword.tests.ps1

@@ -16,6 +16,8 @@ Describe "AvoidUsingPlainTextForPassword" {
 	It "suggests corrections" {
             Import-Module .\PSScriptAnalyzerTestHelper.psm1
 	    Test-CorrectionExtent $violationFilepath $violations[0] 1 '$passphrases' '[SecureString] $passphrases'
+	    $violations[0].SuggestedCorrections[0].Description | Should Be 'Set $passphrases type to SecureString'
+
 	    Test-CorrectionExtent $violationFilepath $violations[1] 1 '$passwordparam' '[SecureString] $passwordparam'
 	    Test-CorrectionExtent $violationFilepath $violations[2] 1 '$credential' '[SecureString] $credential'
 	    Test-CorrectionExtent $violationFilepath $violations[3] 1 '$password' '[SecureString] $password'

Tests/Rules/UseToExportFieldsInManifest.tests.ps1

@@ -44,6 +44,7 @@ Describe "UseManifestExportFields" {
 	    $violations = Run-PSScriptAnalyzerRule $testManifestBadFunctionsWildcardPath
 	    $violationFilepath = Join-path $testManifestPath $testManifestBadFunctionsWildcardPath
 	    Test-CorrectionExtent $violationFilepath $violations[0] 1 "'*'" "@('Get-Foo', 'Get-Bar')"
+	    $violations[0].SuggestedCorrections[0].Description | Should Be "Replace '*' with @('Get-Foo', 'Get-Bar')"
 	}
 
         It "detects FunctionsToExport with null" {