Set SuggestedCorrection property in AvoidAlias rule

Author: Kapil Borle

Rules/AvoidAlias.cs

@@ -40,17 +40,27 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             {
                 CommandAst cmdAst = (CommandAst)foundAst;
                 string aliasName = cmdAst.GetCommandName();
+
                 // Handles the exception caused by commands like, {& $PLINK $args 2> $TempErrorFile}.
                 // You can also review the remark section in following document,
                 // MSDN: CommandAst.GetCommandName Method
-                if (aliasName == null) continue;
+                if (aliasName == null)
+                {
+                    continue;
+                }
 
                 string cmdletName = Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.Instance.GetCmdletNameFromAlias(aliasName);
 
                 if (!String.IsNullOrEmpty(cmdletName))
                 {
-                    yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingCmdletAliasesError, aliasName, cmdletName),
-                        cmdAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName, aliasName);
+                    yield return new DiagnosticRecord(
+                        string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingCmdletAliasesError, aliasName, cmdletName),
+                        cmdAst.Extent, 
+                        GetName(), 
+                        DiagnosticSeverity.Warning, 
+                        fileName, 
+                        aliasName, 
+                        cmdletName);
                 }
             }
         }

Tests/Rules/AvoidUsingAlias.tests.ps1

@@ -14,6 +14,11 @@ Describe "AvoidUsingAlias" {
         It "has the correct description message" {
             $violations[1].Message | Should Match $violationMessage
         }
+
+		It "suggests correction" {
+			$violations[0].SuggestedCorrection | Should Be 'Invoke-Expression'
+			$violations[1].SuggestedCorrection | Should Be 'Clear-Host'
+		}
     }
 
     Context "When there are no violations" {