Add rulesuppression class to store rule suppression info

Author: Quoc Truong

Engine/Generic/DiagnosticRecord.cs

@@ -18,6 +18,7 @@ public class DiagnosticRecord
         private string ruleName;
         private DiagnosticSeverity severity;
         private string scriptName;
+        private string ruleSuppressionId;
 
         /// <summary>
         /// Represents a string from the rule about why this diagnostic was created.
@@ -62,7 +63,16 @@ public string ScriptName
         {
             get { return scriptName; }
             //Trim down to the leaf element of the filePath and pass it to Diagnostic Record
-            set { scriptName = System.IO.Path.GetFileName(value); ; }
+            set { scriptName = System.IO.Path.GetFileName(value); }
+        }
+
+        /// <summary>
+        /// Returns the rule id for this record
+        /// </summary>
+        public string RuleSuppressionID
+        {
+            get { return ruleSuppressionId; }
+            set { ruleSuppressionId = value; }
         }
 
         /// <summary>
@@ -81,13 +91,14 @@ public DiagnosticRecord()
         /// <param name="ruleName">The name of the rule that created this diagnostic</param>
         /// <param name="severity">The severity of this diagnostic</param>
         /// <param name="scriptName">The name of the script file being analyzed</param>
-        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptName)
+        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptName, string ruleId = null)
         {
             Message  = string.IsNullOrEmpty(message)  ? string.Empty : message;
             RuleName = string.IsNullOrEmpty(ruleName) ? string.Empty : ruleName;
             Extent   = extent;
             Severity = severity;
             ScriptName = string.IsNullOrEmpty(scriptName) ? string.Empty : scriptName;
+            ruleSuppressionId = ruleId;
         }
     }
 

Engine/Generic/RuleSuppression.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Management.Automation.Language;
+
+namespace Microsoft.Windows.Powershell.ScriptAnalyzer.Generic
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    public class RuleSuppression
+    {
+        /// <summary>
+        /// The start offset of the rule suppression
+        /// </summary>
+        public int StartOffSet
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// The end offset of the rule suppression
+        /// </summary>
+        public int EndOffset
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// Name of the rule being suppressed
+        /// </summary>
+        public string RuleName
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// ID of the violation instance
+        /// </summary>
+        public string RuleSuppressionID
+        {
+            get;
+            set;
+        }
+    }
+}

Engine/Helper.cs

@@ -5,6 +5,7 @@
 using System.Management.Automation;
 using System.Management.Automation.Language;
 using System.Management.Automation.Runspaces;
+using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
 
 namespace Microsoft.Windows.Powershell.ScriptAnalyzer
 {
@@ -604,6 +605,11 @@ public bool HasSpecialVars(string varName)
             return false;
         }
 
+        public RuleSuppression GetRuleSuppression()
+        {
+            return null;
+        }
+
         #endregion
     }
 

Engine/ScriptAnalyzerEngine.csproj

@@ -63,6 +63,7 @@
     <Compile Include="Generic\ITokenRule.cs" />
     <Compile Include="Generic\LoggerInfo.cs" />
     <Compile Include="Generic\RuleInfo.cs" />
+    <Compile Include="Generic\RuleSuppression.cs" />
     <Compile Include="Generic\SkipNamedBlock.cs" />
     <Compile Include="Generic\SkipTypeDefinition.cs" />
     <Compile Include="Generic\SourceType.cs" />