Merge pull request #1250 from JamesWTruher/RuleInfoEnhancement001

Add ImplementingType to RuleInfo object

Author: JamesWTruher

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -116,7 +116,7 @@ protected override void ProcessRecord()
                 foreach (IRule rule in rules)
                 {
                     WriteObject(new RuleInfo(rule.GetName(), rule.GetCommonName(), rule.GetDescription(),
-                        rule.GetSourceType(), rule.GetSourceName(), rule.GetSeverity()));
+                        rule.GetSourceType(), rule.GetSourceName(), rule.GetSeverity(), rule.GetType()));
                 }
             }
         }

Engine/Generic/RuleInfo.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
 using System.Diagnostics.CodeAnalysis;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
@@ -16,6 +17,7 @@ public class RuleInfo
         private SourceType sourceType;
         private string sourceName;
         private RuleSeverity ruleSeverity;
+        private Type implementingType;
 
         /// <summary>
         /// Name: The name of the rule.
@@ -50,7 +52,7 @@ public string Description
         /// <summary>
         /// SourceType: The source type of the rule.
         /// </summary>
-        /// 
+        ///
         [SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
         public SourceType SourceType
         {
@@ -78,6 +80,16 @@ public RuleSeverity Severity
             private set { ruleSeverity = value; }
         }
 
+        /// <summary>
+        /// ImplementingType : The type which implements the rule.
+        /// </summary>
+        [SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
+        public Type ImplementingType
+        {
+            get { return implementingType; }
+            private set { implementingType = value; }
+        }
+
         /// <summary>
         /// Constructor for a RuleInfo.
         /// </summary>
@@ -93,12 +105,32 @@ public RuleInfo(string name, string commonName, string description, SourceType s
             Description = description;
             SourceType  = sourceType;
             SourceName  = sourceName;
-            Severity = severity;      
+            Severity = severity;
+        }
+
+        /// <summary>
+        /// Constructor for a RuleInfo.
+        /// </summary>
+        /// <param name="name">Name of the rule.</param>
+        /// <param name="commonName">Common Name of the rule.</param>
+        /// <param name="description">Description of the rule.</param>
+        /// <param name="sourceType">Source type of the rule.</param>
+        /// <param name="sourceName">Source name of the rule.</param>
+        /// <param name="implementingType">The dotnet type of the rule.</param>
+        public RuleInfo(string name, string commonName, string description, SourceType sourceType, string sourceName, RuleSeverity severity, Type implementingType)
+        {
+            RuleName        = name;
+            CommonName  = commonName;
+            Description = description;
+            SourceType  = sourceType;
+            SourceName  = sourceName;
+            Severity = severity;
+            ImplementingType = implementingType;
         }
 
         public override string ToString()
         {
             return RuleName;
-        }      
+        }
     }
 }

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -177,3 +177,11 @@ Describe "TestWildCard" {
         $rules.Count | Should -Be 4
     }
 }
+
+Describe "TestImplementingType" {
+    It "retrieves rule which have an implementing type" {
+        $rule = Get-ScriptAnalyzerRule PSPlaceCloseBrace
+        $type = $rule.ImplementingType
+        $type.BaseType.Name | Should -Be "ConfigurableRule"
+    }
+}