Refactor GetSourceType method

* Refactor GetSourceType method into SourceType property.
* Make code cleaner.
* Unify SourceType property implementation across all rules.

Author: Haimasker

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -115,7 +115,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.GetType()));
+                        rule.SourceType, rule.GetSourceName(), rule.GetSeverity(), rule.GetType()));
                 }
             }
         }

Engine/Generic/AvoidCmdletGeneric.cs

@@ -77,11 +77,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         /// <returns>The source name of the rule.</returns>
         public abstract string GetSourceName();
 
-        /// <summary>
-        /// GetSourceType: Retrieves the source type of the rule.
-        /// </summary>
-        /// <returns>The source type of the rule.</returns>
-        public abstract  SourceType GetSourceType();
+        public abstract RuleSourceType SourceType { get; }
 
         /// <summary>
         /// GetSeverity: Retrieves the severity of the rule: error, warning of information.

Engine/Generic/AvoidParameterGeneric.cs

@@ -87,11 +87,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         /// <returns>The source name of the rule.</returns>
         public abstract string GetSourceName();
 
-        /// <summary>
-        /// GetSourceType: Retrieves the source type of the rule.
-        /// </summary>
-        /// <returns>The source type of the rule.</returns>
-        public abstract  SourceType GetSourceType();
+        public abstract RuleSourceType SourceType { get; }
 
         /// <summary>
         /// RuleSeverity: Returns the severity of the rule.

Engine/Generic/ConfigurableRule.cs

@@ -103,11 +103,7 @@ public virtual void ConfigureRule(IDictionary<string, object> paramValueMap)
         /// <returns>The source name of the rule.</returns>
         public abstract string GetSourceName();
 
-        /// <summary>
-        /// Retrieves the source type of the rule.
-        /// </summary>
-        /// <returns>The source type of the rule.</returns>
-        public abstract SourceType GetSourceType();
+        public abstract RuleSourceType SourceType { get; }
 
         private void SetDefaultValues()
         {

Engine/Generic/ExternalRule.cs

@@ -42,10 +42,7 @@ public string GetParameter()
             return this.param;
         }
 
-        public SourceType GetSourceType()
-        {
-            return SourceType.Module;
-        }
+        public RuleSourceType SourceType => RuleSourceType.Module;
 
         public string GetParameterType()
         {
@@ -71,7 +68,7 @@ public string GetFullModulePath()
         #endregion
 
         #region Constructors
-        
+
         public ExternalRule()
         {
 

Engine/Generic/IRule.cs

@@ -33,10 +33,10 @@ public interface IRule
         string GetSourceName();
 
         /// <summary>
-        /// GetSourceType: Retrieves the source type of the rule.
+        /// SourceType: Retrieves the source type of the rule.
         /// </summary>
         /// <returns>The source type of the rule.</returns>
-        SourceType GetSourceType();
+        public abstract RuleSourceType SourceType { get; }
 
         /// <summary>
         /// GetSeverity: Retrieves severity of the rule.

Engine/Generic/RuleInfo.cs

@@ -14,7 +14,7 @@ public class RuleInfo
         private string name;
         private string commonName;
         private string description;
-        private SourceType sourceType;
+        private RuleSourceType sourceType;
         private string sourceName;
         private RuleSeverity ruleSeverity;
         private Type implementingType;
@@ -54,7 +54,7 @@ public string Description
         /// </summary>
         ///
         [SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
-        public SourceType SourceType
+        public RuleSourceType SourceType
         {
             get { return sourceType; }
             private set { sourceType = value; }
@@ -98,7 +98,7 @@ public Type ImplementingType
         /// <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>
-        public RuleInfo(string name, string commonName, string description, SourceType sourceType, string sourceName, RuleSeverity severity)
+        public RuleInfo(string name, string commonName, string description, RuleSourceType sourceType, string sourceName, RuleSeverity severity)
         {
             RuleName        = name;
             CommonName  = commonName;
@@ -117,7 +117,7 @@ public RuleInfo(string name, string commonName, string description, SourceType s
         /// <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)
+        public RuleInfo(string name, string commonName, string description, RuleSourceType sourceType, string sourceName, RuleSeverity severity, Type implementingType)
         {
             RuleName        = name;
             CommonName  = commonName;

Engine/Generic/SourceType.cs Engine/Generic/RuleSourceType.csEngine/Generic/SourceType.cs renamed to Engine/Generic/RuleSourceType.cs

@@ -4,9 +4,9 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
 {
     /// <summary>
-    /// Represents a source name of a script analyzer rule.
+    /// Represents a source type of a script analyzer rule.
     /// </summary>
-    public enum SourceType : uint
+    public enum RuleSourceType : uint
     {
         /// <summary>
         /// BUILTIN: Indicates the script analyzer rule is contributed as a built-in rule.

Rules/AlignAssignmentStatement.cs

@@ -481,7 +481,7 @@ var member in enumTypeDefAst.Members.Where(
                 // Next we need to find the location of the equals sign for this
                 // member. We know the line it should be on. We can
                 // search all of the equals signs on that line.
-                // 
+                //
                 // Unlike hashtables, we don't have an extent for the LHS and
                 // RHS of the member. We have the extent of the entire
                 // member, the name of the member, and the extent of the
@@ -699,12 +699,6 @@ public override string GetSourceName()
             return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
         }
 
-        /// <summary>
-        /// Retrieves the type of the rule, Builtin, Managed or Module.
-        /// </summary>
-        public override SourceType GetSourceType()
-        {
-            return SourceType.Builtin;
-        }
+        public override RuleSourceType SourceType => RuleSourceType.Builtin;
     }
 }

Rules/AvoidAlias.cs

@@ -53,7 +53,7 @@ private void SetProperties()
             {
                 return;
             }
-            // Fallback for object from legacy allowlist argument name 
+            // Fallback for object from legacy allowlist argument name
             if (obj == null) {
                 obj = objLegacy;
             }
@@ -260,13 +260,7 @@ public string GetDescription()
             return string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingCmdletAliasesDescription);
         }
 
-        /// <summary>
-        /// GetSourceType: Retrieves the type of the rule, Builtin, Managed or Module.
-        /// </summary>
-        public SourceType GetSourceType()
-        {
-            return SourceType.Builtin;
-        }
+        public RuleSourceType SourceType => RuleSourceType.Builtin;
 
         /// <summary>
         /// GetSeverity: Retrieves the severity of the rule: error, warning of information.