Refactor to use GetShippedModuleSubDirectory for settings and command data file paths

Author: liamjpeters

Engine/Settings/Settings.cs

@@ -229,7 +229,7 @@ public static string TryAutoDiscover(string path)
         public static string TryResolvePreset(string name)
         {
             // Get the path to the folder of preset settings files shipped with the module
-            var settingsDir = GetShippedSettingsDirectory();
+            var settingsDir = GetShippedModuleSubDirectory("Settings");
 
             // If we can't locate it, return null
             if (settingsDir == null) return null;
@@ -298,10 +298,10 @@ public static string Serialise(SettingsData data, string format)
         }
 
         /// <summary>
-        /// Retrieves the Settings directory from the Module directory structure
+        /// Retrieves a subdirectory from the Module directory structure
         /// </summary>
-        /// <returns>The Settings directory path</returns>
-        public static string GetShippedSettingsDirectory()
+        /// <returns>The subdirectory path</returns>
+        public static string GetShippedModuleSubDirectory(string subDirectoryName)
         {
             // Find the compatibility files in Settings folder
             var path = typeof(Helper).GetTypeInfo().Assembly.Location;
@@ -313,50 +313,19 @@ public static string GetShippedSettingsDirectory()
             // Find the compatibility files in Settings folder adjacent to the assembly.
             // Some builds place binaries in subfolders (coreclr/, PSv3/); in those cases,
             // the Settings folder lives in the parent (module root), so we also probe one level up.
-            var settingsPath = Path.Combine(Path.GetDirectoryName(path), "Settings");
-            if (!Directory.Exists(settingsPath))
+            var subDirectoryPath = Path.Combine(Path.GetDirectoryName(path), subDirectoryName);
+            if (!Directory.Exists(subDirectoryPath))
             {
                 // Probe parent directory (module root) for Settings folder.
                 var parentDir = Path.GetDirectoryName(Path.GetDirectoryName(path));
-                settingsPath = Path.Combine(parentDir ?? string.Empty, "Settings");
-                if (!Directory.Exists(settingsPath))
+                subDirectoryPath = Path.Combine(parentDir ?? string.Empty, subDirectoryName);
+                if (!Directory.Exists(subDirectoryPath))
                 {
                     return null;
                 }
             }
 
-            return settingsPath;
-        }
-
-        /// <summary>
-        /// Retrieves the Settings directory from the Module directory structure
-        /// </summary>
-        /// <returns>The Settings directory path</returns>
-        public static string GetShippedCommandDataFileDirectory()
-        {
-            // Find the compatibility files in Settings folder
-            var path = typeof(Helper).GetTypeInfo().Assembly.Location;
-            if (string.IsNullOrWhiteSpace(path))
-            {
-                return null;
-            }
-
-            // Find the compatibility files in Settings folder adjacent to the assembly.
-            // Some builds place binaries in subfolders (coreclr/, PSv3/); in those cases,
-            // the Settings folder lives in the parent (module root), so we also probe one level up.
-            var commandDataFilesPath = Path.Combine(Path.GetDirectoryName(path), "CommandDataFiles");
-            if (!Directory.Exists(commandDataFilesPath))
-            {
-                // Probe parent directory (module root) for CommandDataFiles folder.
-                var parentDir = Path.GetDirectoryName(Path.GetDirectoryName(path));
-                commandDataFilesPath = Path.Combine(parentDir ?? string.Empty, "CommandDataFiles");
-                if (!Directory.Exists(commandDataFilesPath))
-                {
-                    return null;
-                }
-            }
-
-            return commandDataFilesPath;
+            return subDirectoryPath;
         }
 
         /// <summary>
@@ -367,7 +336,7 @@ public static string GetShippedCommandDataFileDirectory()
         /// </summary>
         public static IEnumerable<string> GetSettingPresets()
         {
-            var settingsPath = GetShippedSettingsDirectory();
+            var settingsPath = GetShippedModuleSubDirectory("Settings");
 
             if (settingsPath == null)
             {

Rules/AvoidOverwritingBuiltInCmdlets.cs

@@ -90,7 +90,7 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
             }
 
             var psVerList = PowerShellVersion;
-            string commandDataFilesPath = Settings.GetShippedCommandDataFileDirectory();
+            string commandDataFilesPath = Settings.GetShippedModuleSubDirectory("CommandDataFiles");
 
             foreach (string reference in psVerList)
             {

Rules/UseCompatibleCmdlets.cs

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