Move settings method from Helper to Settings

Author: Kapil Borle

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -253,7 +253,7 @@ protected override void BeginProcessing()
                     break;
 
                 case SettingsMode.Preset:
-                    settingsFound = Helper.GetSettingPresetFilePath(this.settings as string);
+                    settingsFound = Generic.Settings.GetSettingPresetFilePath(this.settings as string);
                     goto case SettingsMode.File;
 
                 case SettingsMode.File:
@@ -349,7 +349,7 @@ private static bool IsBuiltinSettingPreset(object settingPreset)
             var preset = settingPreset as string;
             if (preset != null)
             {
-                return Helper.GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);
+                return Generic.Settings.GetSettingPresets().Contains(preset, StringComparer.OrdinalIgnoreCase);
             }
 
             return false;
@@ -437,7 +437,7 @@ private SettingsMode FindSettingsMode(out object settingsFound)
                     if (IsBuiltinSettingPreset(settingsFilePath))
                     {
                         settingsMode = SettingsMode.Preset;
-                        settingsFound = Helper.GetSettingPresetFilePath(settingsFilePath);
+                        settingsFound = Generic.Settings.GetSettingPresetFilePath(settingsFilePath);
                     }
                     else
                     {

Engine/Generic/Settings.cs

@@ -17,6 +17,7 @@
 using System.IO;
 using System.Linq;
 using System.Management.Automation.Language;
+using System.Reflection;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
 {
@@ -89,6 +90,71 @@ public Settings(object settings) : this(settings, null)
         {
         }
 
+        /// <summary>
+        /// Retrieves the Settings directory from the Module directory structure
+        /// </summary>
+        public static string GetShippedSettingsDirectory()
+        {
+            // Find the compatibility files in Settings folder
+            var path = typeof(Helper).GetTypeInfo().Assembly.Location;
+            if (String.IsNullOrWhiteSpace(path))
+            {
+                return null;
+            }
+
+            var settingsPath = Path.Combine(Path.GetDirectoryName(path), "Settings");
+            if (!Directory.Exists(settingsPath))
+            {
+                // try one level down as the PSScriptAnalyzer module structure is not consistent
+                // CORECLR binaries are in PSScriptAnalyzer/coreclr/, PowerShell v3 binaries are in PSScriptAnalyzer/PSv3/
+                // and PowerShell v5 binaries are in PSScriptAnalyzer/
+                settingsPath = Path.Combine(Path.GetDirectoryName(Path.GetDirectoryName(path)), "Settings");
+                if (!Directory.Exists(settingsPath))
+                {
+                    return null;
+                }
+            }
+
+            return settingsPath;
+        }
+
+        /// <summary>
+        /// Returns the builtin setting presets
+        ///
+        /// Looks for powershell data files (*.psd1) in the PSScriptAnalyzer module settings directory
+        /// and returns the names of the files without extension
+        /// </summary>
+        public static IEnumerable<string> GetSettingPresets()
+        {
+            var settingsPath = GetShippedSettingsDirectory();
+            if (settingsPath != null)
+            {
+                foreach (var filepath in System.IO.Directory.EnumerateFiles(settingsPath, "*.psd1"))
+                {
+                    yield return System.IO.Path.GetFileNameWithoutExtension(filepath);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Gets the path to the settings file corresponding to the given preset.
+        ///
+        /// If the corresponding preset file is not found, the method returns null.
+        /// </summary>
+        public static string GetSettingPresetFilePath(string settingPreset)
+        {
+            var settingsPath = GetShippedSettingsDirectory();
+            if (settingsPath != null)
+            {
+                if (GetSettingPresets().Contains(settingPreset, StringComparer.OrdinalIgnoreCase))
+                {
+                    return System.IO.Path.Combine(settingsPath, settingPreset + ".psd1");
+                }
+            }
+
+            return null;
+        }
+
         /// <summary>
         /// Recursively convert hashtable to dictionary
         /// </summary>

Engine/Helper.cs

@@ -173,71 +173,6 @@ public void Initialize()
             }
         }
 
-        /// <summary>
-        /// Retrieves the Settings directory from the Module directory structure
-        /// </summary>
-        public static string GetShippedSettingsDirectory()
-        {
-            // Find the compatibility files in Settings folder
-            var path = typeof(Helper).GetTypeInfo().Assembly.Location;
-            if (String.IsNullOrWhiteSpace(path))
-            {
-                return null;
-            }
-
-            var settingsPath = Path.Combine(Path.GetDirectoryName(path), "Settings");
-            if (!Directory.Exists(settingsPath))
-            {
-                // try one level down as the PSScriptAnalyzer module structure is not consistent
-                // CORECLR binaries are in PSScriptAnalyzer/coreclr/, PowerShell v3 binaries are in PSScriptAnalyzer/PSv3/
-                // and PowerShell v5 binaries are in PSScriptAnalyzer/
-                settingsPath = Path.Combine(Path.GetDirectoryName(Path.GetDirectoryName(path)), "Settings");
-                if (!Directory.Exists(settingsPath))
-                {
-                    return null;
-                }
-            }
-
-            return settingsPath;
-        }
-
-        /// <summary>
-        /// Returns the builtin setting presets
-        ///
-        /// Looks for powershell data files (*.psd1) in the PSScriptAnalyzer module settings directory
-        /// and returns the names of the files without extension
-        /// </summary>
-        public static IEnumerable<string> GetSettingPresets()
-        {
-            var settingsPath = GetShippedSettingsDirectory();
-            if (settingsPath != null)
-            {
-                foreach (var filepath in System.IO.Directory.EnumerateFiles(settingsPath, "*.psd1"))
-                {
-                    yield return System.IO.Path.GetFileNameWithoutExtension(filepath);
-                }
-            }
-        }
-
-        /// <summary>
-        /// Gets the path to the settings file corresponding to the given preset.
-        ///
-        /// If the corresponding preset file is not found, the method returns null.
-        /// </summary>
-        public static string GetSettingPresetFilePath(string settingPreset)
-        {
-            var settingsPath = GetShippedSettingsDirectory();
-            if (settingsPath != null)
-            {
-                if (GetSettingPresets().Contains(settingPreset, StringComparer.OrdinalIgnoreCase))
-                {
-                    return System.IO.Path.Combine(settingsPath, settingPreset + ".psd1");
-                }
-            }
-
-            return null;
-        }
-
         /// <summary>
         /// Returns all the rule arguments
         /// </summary>

Rules/UseCompatibleCmdlets.cs

@@ -306,7 +306,7 @@ private void SetupCmdletsDictionary()
                 return;
             }
 
-            string settingsPath = Helper.GetShippedSettingsDirectory();
+            string settingsPath = Settings.GetShippedSettingsDirectory();
 #if DEBUG
             object modeObject;
             if (ruleArgs.TryGetValue("mode", out modeObject))