Idea for ability to optionally override default modules and scripts install path - Duscussion and contribution is welcome!

src/Microsoft.PowerShell.PSResourceGet.psd1

@@ -38,8 +38,8 @@
     FunctionsToExport      = @(
         'Import-PSGetRepository'
     )
-    VariablesToExport = 'PSGetPath'
-    AliasesToExport = @(
+    VariablesToExport      = 'PSGetPath'
+    AliasesToExport        = @(
         'Get-PSResource',
         'fdres',
         'gres',

src/code/GetInstalledPSResource.cs

@@ -89,7 +89,6 @@ protected override void BeginProcessing()
                 {
                     ThrowTerminatingError(new ErrorRecord(
                         new PSArgumentException($"Error: Could not resolve provided Path argument '{Path}' into a single path."),
-
                         "ErrorInvalidPathArgument",
                         ErrorCategory.InvalidArgument,
                         this));
@@ -121,7 +120,7 @@ protected override void BeginProcessing()
 
         protected override void ProcessRecord()
         {
-            var namesToSearch = Utils.ProcessNameWildcards(Name, removeWildcardEntries:false, out string[] errorMsgs, out bool _);
+            var namesToSearch = Utils.ProcessNameWildcards(Name, removeWildcardEntries: false, out string[] errorMsgs, out bool _);
             foreach (string error in errorMsgs)
             {
                 WriteError(new ErrorRecord(

src/code/InstallPSResource.cs

@@ -257,7 +257,7 @@ private enum ResourceFileType
 
         #endregion
 
-        #region Method Overrides
+        #region Method override - Begin
 
         protected override void BeginProcessing()
         {
@@ -266,7 +266,7 @@ protected override void BeginProcessing()
             RepositorySettings.CheckRepositoryStore();
 
             _pathsToInstallPkg = Utils.GetAllInstallationPaths(this, Scope);
-            List<string> pathsToSearch = Utils.GetAllResourcePaths(this, Scope);
+            List<string> pathsToSearch = _pathsToInstallPkg;
             // Only need to find packages installed if -Reinstall is not passed in
             _packagesOnMachine = Reinstall ? new HashSet<string>(StringComparer.CurrentCultureIgnoreCase) : Utils.GetInstalledPackages(pathsToSearch, this);
 
@@ -275,6 +275,9 @@ protected override void BeginProcessing()
             _installHelper = new InstallHelper(cmdletPassedIn: this, networkCredential: networkCred);
         }
 
+        #endregion
+
+        #region Method Override - Process
         protected override void ProcessRecord()
         {
             switch (ParameterSetName)
@@ -359,7 +362,7 @@ protected override void ProcessRecord()
                     catch (Exception)
                     {
                         ThrowTerminatingError(new ErrorRecord(
-                            new ArgumentException($"Argument for parameter -RequiredResourceFile is not in proper json or hashtable format.  Make sure argument is either a valid .json or .psd1 file."),
+                            new ArgumentException($"Argument for parameter -RequiredResourceFile is not in proper json or hashtable format. Make sure argument is either a valid .json or .psd1 file."),
                             "RequiredResourceFileNotInProperJsonFormat",
                             ErrorCategory.InvalidData,
                             this));

src/code/ServerApiCall.cs

@@ -2,11 +2,12 @@
 // Licensed under the MIT License.
 
 using Microsoft.PowerShell.PSResourceGet.UtilClasses;
+using NuGet.Versioning;
 using System;
 using System.IO;
-using System.Net.Http;
-using NuGet.Versioning;
+using System.Management.Automation;
 using System.Net;
+using System.Net.Http;
 using System.Text;
 using System.Runtime.ExceptionServices;
 using System.Management.Automation;
@@ -33,7 +34,7 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
             HttpClientHandler handler = new HttpClientHandler();
             bool token = false;
 
-            if(networkCredential != null)
+            if (networkCredential != null)
             {
                 token = String.Equals("token", networkCredential.UserName) ? true : false;
             };
@@ -45,7 +46,9 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
 
                 _sessionClient = new HttpClient(handler);
                 _sessionClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));
-            } else {
+            }
+            else
+            {
 
                 handler.Credentials = networkCredential;
 

src/code/SetPSResourceGetInstallPathOverride.cs

@@ -0,0 +1,239 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.PowerShell.PSResourceGet.UtilClasses;
+using System;
+using System.Linq;
+using System.Management.Automation;
+using System.Runtime.InteropServices;
+
+namespace Microsoft.PowerShell.PSResourceGet.Cmdlets
+{
+    /// <summary>
+    /// The Set-PSResourceGetInstallPathOverride cmdlet is used to override install path for PS resources.
+    /// </summary>
+    [Cmdlet(VerbsCommon.Set, "PSResourceGetInstallPathOverride", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
+    [Alias("Update-PSResourceGetInstallPathOverride")]
+    [OutputType(typeof(void))]
+
+    public sealed class SetPSResourceGetInstallPathOverride : PSCmdlet
+    {
+        #region Parameters
+
+        /// <summary>
+        /// Specifies the desired path for the override.
+        /// </summary>
+        [Parameter(Position = 0, ValueFromPipeline = true, Mandatory = true, HelpMessage = "Path for the override.")]
+        [ValidateNotNullOrEmpty]
+        public string Path
+        {
+            get
+            {
+                return _path;
+            }
+
+            set
+            {
+                if (WildcardPattern.ContainsWildcardCharacters(value))
+                {
+                    throw new PSArgumentException("Wildcard characters are not allowed in the path.");
+                }
+
+                // This will throw if path cannot be resolved
+                _path = GetResolvedProviderPathFromPSPath(
+                    Environment.ExpandEnvironmentVariables(value),
+                    out ProviderInfo provider
+                ).First();
+            }
+        }
+        private string _path;
+
+        /// <summary>
+        /// Specifies the scope of installation.
+        /// </summary>
+        [Parameter(Position = 1)]
+        public ScopeType Scope { get; set; }
+
+        #endregion
+
+        #region Method override - Begin
+
+        protected override void BeginProcessing()
+        {
+            // Only run on Windows for now, due to env variables on Unix being very different
+            if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                ThrowTerminatingError(
+                    new ErrorRecord(
+                        new PSInvalidOperationException($"Error this only works on Windows for now"),
+                        "OsIsNotWindows",
+                        ErrorCategory.InvalidOperation,
+                        this
+                    )
+                );
+            }
+        }
+
+        #endregion
+
+        #region Method override - Process
+
+        protected override void ProcessRecord()
+        {
+            // Assets
+            EnvironmentVariableTarget EnvScope = (Scope is ScopeType.AllUsers) ? EnvironmentVariableTarget.Machine : EnvironmentVariableTarget.User;
+            string PathForModules = System.IO.Path.Combine(_path, "Modules");
+            string PathForScripts = System.IO.Path.Combine(_path, "Scripts");
+
+            // Set env variable for install path override
+            string PathOverrideCurrentValue = Environment.GetEnvironmentVariable(
+                "PSResourceGetInstallPathOverride",
+                EnvScope
+            );
+            if (!String.IsNullOrEmpty(PathOverrideCurrentValue))
+            {
+                WriteVerbose(
+                    String.Format(
+                        "Current value of PSResourceGetInstallPathOverride in scope '{0}': '{1}'",
+                        EnvScope.ToString(),
+                        PathOverrideCurrentValue
+                    )
+                );
+            }
+            if (
+                !String.IsNullOrEmpty(PathOverrideCurrentValue) &&
+                String.Equals(
+                    Environment.ExpandEnvironmentVariables(PathOverrideCurrentValue),
+                    _path,
+                    StringComparison.Ordinal
+                )
+            )
+            {
+                WriteVerbose(
+                    String.Format(
+                        "PSResourceGetInstallPathOverride in scope '{0}' is already '{1}', no change needed.",
+                        EnvScope.ToString(),
+                        _path
+                    )
+                );
+            }
+            else
+            {
+                if (this.ShouldProcess($"Set environment variable PSResourceGetPathOverride in scope '{EnvScope} to '{_path}"))
+                {
+                    Environment.SetEnvironmentVariable(
+                        "PSResourceGetInstallPathOverride",
+                        _path,
+                        EnvScope
+                    );
+                    WriteVerbose(
+                        String.Format(
+                            "PSResourceGetInstallPathOverride in scope '{0}' was successfully set to: '{1}'",
+                            EnvScope.ToString(),
+                            _path
+                        )
+                    );
+                }
+            }
+
+            // Add install path override for modules to PSModulePath
+            string CurrentPSModulePath = Environment.GetEnvironmentVariable(
+                "PSModulePath",
+                EnvScope
+            );
+            if (String.IsNullOrEmpty(CurrentPSModulePath))
+            {
+                WriteVerbose(String.Format("PSModulePath in scope '{0}' is empty.", EnvScope.ToString()));
+                if (this.ShouldProcess($"Set environment pariable 'PSModulePath' in scope '{EnvScope} to '{PathForModules}"))
+                {
+                    Environment.SetEnvironmentVariable(
+                        "PSModulePath",
+                        PathForModules,
+                        EnvScope
+                    );
+                }
+            }
+            WriteVerbose(string.Format("Current value of PSModulePath in {0} context: '{1}'", EnvScope.ToString(), CurrentPSModulePath));
+            string[] CurrentPSModulePaths = CurrentPSModulePath.Trim(';').Split(';').Select(s => Environment.ExpandEnvironmentVariables(s)).ToArray();
+            if (CurrentPSModulePaths.Contains(PathForModules))
+            {
+                WriteVerbose(String.Format("PSModulePath in scope '{0}' already contains '{1}', no change needed.", EnvScope.ToString(), PathForModules));
+            }
+            else
+            {
+                WriteVerbose(
+                    String.Format(
+                        "PSModulePath in scope '{0}' does not already contain '{1}'",
+                        EnvScope.ToString(),
+                        PathForModules
+                    )
+                );
+                if (this.ShouldProcess($"Add '{PathForModules}' to environment variable 'PSModulePath' in scope '{EnvScope}"))
+                {
+                    Environment.SetEnvironmentVariable(
+                        "PSModulePath",
+                        String.Format("{0};{1}", PathForModules, CurrentPSModulePath),
+                        EnvScope
+                    );
+                    WriteVerbose(
+                        String.Format(
+                            "Successfully added '{0}' to PSModulePath in scope '{1}'",
+                            PathForModules,
+                            EnvScope.ToString()
+                        )
+                    );
+                }
+            }
+
+            // Add install path override for scripts to Path
+            string CurrentPath = Environment.GetEnvironmentVariable(
+                "Path",
+                EnvScope
+            );
+            if (String.IsNullOrEmpty(CurrentPath))
+            {
+                WriteVerbose(String.Format("Path in scope '{0}' is empty.", EnvScope.ToString()));
+                if (this.ShouldProcess($"Set environment pariable 'Path' in scope '{EnvScope} to '{PathForScripts}"))
+                {
+                    Environment.SetEnvironmentVariable(
+                        "Path",
+                        PathForScripts,
+                        EnvScope
+                    );
+                }
+            }
+            WriteVerbose(string.Format("Current value of Path in {0} context: '{1}'", EnvScope.ToString(), CurrentPath));
+            string[] CurrentPaths = CurrentPath.Trim(';').Split(';').Select(s => Environment.ExpandEnvironmentVariables(s)).ToArray();
+            if (CurrentPaths.Contains(PathForScripts))
+            {
+                WriteVerbose(String.Format("Path in scope '{0}' already contains '{1}', no change needed.", EnvScope.ToString(), PathForScripts));
+            }
+            else
+            {
+                WriteVerbose(
+                    String.Format(
+                        "Override install path is not already in Path for scope '{0}'",
+                        EnvScope.ToString()
+                    )
+                );
+                if (this.ShouldProcess($"Add '{PathForScripts}' to environment variable 'Path' in scope '{EnvScope}"))
+                {
+                    Environment.SetEnvironmentVariable(
+                        "Path",
+                        String.Format("{0};{1}", PathForScripts, CurrentPath),
+                        EnvScope
+                    );
+                    WriteVerbose(
+                        String.Format(
+                            "Successfully added '{0}' to Path in scope '{1}'",
+                            PathForScripts,
+                            EnvScope.ToString()
+                        )
+                    );
+                }
+            }
+        }
+
+        #endregion
+    }
+}