Add IncludeDefaultRules to settings file

Author: Kapil Borle

Engine/Settings.cs

@@ -28,13 +28,15 @@ internal enum SettingsMode { None = 0, Auto, File, Hashtable, Preset };
     /// </summary>
     public class Settings
     {
+        private bool includeDefaultRules;
         private string filePath;
         private List<string> includeRules;
         private List<string> excludeRules;
         private List<string> severities;
         private List<string> customRulePath;
         private Dictionary<string, Dictionary<string, object>> ruleArguments;
 
+        public bool IncludeDefaultRules => includeDefaultRules;
         public string FilePath => filePath;
         public IEnumerable<string> IncludeRules => includeRules;
         public IEnumerable<string> ExcludeRules => excludeRules;
@@ -406,6 +408,15 @@ private void parseSettingsHashtable(Hashtable settingsHashtable)
                         customRulePath = GetData(val, key);
                         break;
 
+                    case "includedefaultrules":
+                        if (!(val is bool))
+                        {
+                            throw new InvalidDataException(string.Format(CultureInfo.CurrentCulture, "Not a boolean"));
+                        }
+
+                        includeDefaultRules = (bool)val;
+                        break;
+
                     case "rules":
                         try
                         {

Tests/Engine/Settings.tests.ps1

@@ -138,4 +138,32 @@ Describe "Settings Class" {
             0..($rulePaths.Count - 1) | ForEach-Object { $settings.CustomRulePath[$_] | Should be $rulePaths[$_] }
         }
     }
+
+    Context "When IncludeDefaultRules parameter is provided" {
+        It "Should correctly set the value if a boolean is given - true" {
+            $settingsHashtable = @{
+                IncludeDefaultRules = $true
+            }
+
+            $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
+            $settings.IncludeDefaultRules | Should Be $true
+        }
+
+        It "Should correctly set the value if a boolean is given - false" {
+            $settingsHashtable = @{
+                IncludeDefaultRules = $false
+            }
+
+            $settings = New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable
+            $settings.IncludeDefaultRules | Should Be $false
+        }
+
+        It "Should throw if a non-boolean value is given" {
+            $settingsHashtable = @{
+                IncludeDefaultRules = "some random string"
+            }
+
+            { New-Object -TypeName $settingsTypeName -ArgumentList $settingsHashtable } | Should Throw
+        }
+    }
 }