Write errors to the terminal when there are rule suppression errors

Author: Quoc Truong

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -291,6 +291,17 @@ private void AnalyzeFile(string filePath)
 
             Dictionary<string, List<RuleSuppression>> ruleSuppressions = Helper.Instance.GetRuleSuppression(ast);
 
+            foreach (List<RuleSuppression> ruleSuppressionsList in ruleSuppressions.Values)
+            {
+                foreach (RuleSuppression ruleSuppression in ruleSuppressionsList)
+                {
+                    if (!String.IsNullOrWhiteSpace(ruleSuppression.Error))
+                    {
+                        WriteError(new ErrorRecord(new ArgumentException(ruleSuppression.Error), ruleSuppression.Error, ErrorCategory.InvalidArgument, ruleSuppression));
+                    }
+                }
+            }
+
             #region Run VariableAnalysis
             try
             {

Engine/Generic/RuleSuppression.cs

@@ -3,6 +3,7 @@
 using System.Management.Automation.Language;
 using System.Collections.Generic;
 using System.Text.RegularExpressions;
+using System.Globalization;
 
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer.Generic
 {
@@ -11,6 +12,8 @@ namespace Microsoft.Windows.Powershell.ScriptAnalyzer.Generic
     /// </summary>
     public class RuleSuppression
     {
+        private string _ruleName;
+
         /// <summary>
         /// The start offset of the rule suppression
         /// </summary>
@@ -34,8 +37,24 @@ public int EndOffset
         /// </summary>
         public string RuleName
         {
-            get;
-            set;
+            get
+            {
+                return _ruleName;
+            }
+
+            set
+            {
+                _ruleName = value;
+                if ((ScriptAnalyzer.Instance.ScriptRules != null
+                        && ScriptAnalyzer.Instance.ScriptRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0)
+                    && (ScriptAnalyzer.Instance.TokenRules != null
+                        && ScriptAnalyzer.Instance.TokenRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0)
+                    && (ScriptAnalyzer.Instance.ExternalRules != null
+                        && ScriptAnalyzer.Instance.ExternalRules.Count(item => String.Equals(item.GetName(), _ruleName, StringComparison.OrdinalIgnoreCase)) == 0))
+                {
+                    Error = String.Format(Strings.RuleSuppressionRuleNameNotFound, _ruleName);
+                }
+            }
         }
 
         /// <summary>
@@ -212,6 +231,12 @@ public RuleSuppression(AttributeAst attrAst, int start, int end)
 
             StartOffset = start;
             EndOffset = end;
+
+            if (!String.IsNullOrWhiteSpace(Error))
+            {
+                Error = String.Format(CultureInfo.CurrentCulture, Strings.RuleSuppressionErrorFormat, attrAst.Extent.StartLineNumber,
+                    System.IO.Path.GetFileName(attrAst.Extent.File), Error);
+            }
         }
 
         /// <summary>

Engine/Strings.Designer.cs

@@ -162,11 +162,17 @@
   <data name="RulesNotFound" xml:space="preserve">
     <value>Cannot find analyzer rules.</value>
   </data>
+  <data name="RuleSuppressionErrorFormat" xml:space="preserve">
+    <value>Suppression Message Attribute error at line {0} in {1} : {2}</value>
+  </data>
+  <data name="RuleSuppressionRuleNameNotFound" xml:space="preserve">
+    <value>Rule {0} cannot be found.</value>
+  </data>
   <data name="StringConstantArgumentsSuppressionAttributeError" xml:space="preserve">
-    <value>All the arguments of the suppression message attribute should be string constants.</value>
+    <value>All the arguments of the should be string constants.</value>
   </data>
   <data name="TargetWithoutScopeSuppressionAttributeError" xml:space="preserve">
-    <value>For Suppression Message Attribute, if Target is specified, Scope must be specified.</value>
+    <value>If Target is specified, Scope must be specified.</value>
   </data>
   <data name="VerboseFileMessage" xml:space="preserve">
     <value>Analyzing file: {0}</value>