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

[o-l-a-v]

PR Summary

What

I'm experimenting with a way to override PSResourceGet install path for modules and scripts, suggested in my comment #1494 (comment).

This PR already got the basic logic working for getting the path override if present! 🥳

Todo

• Maintainers confirm this is something they want, else more work is for nothing.
• Get env variable PSResourceGetInstallPathOverride if present and use it instead of default paths.
• Create cmdlet Set-PSResourceInstallPathOverride -Path <path> -Scope <CurrentUser|AllUsers>.
  • Barebone functionality, as in set PSResourceGetInstallPathOverride and add it to PSModulePath if not already there.
  • -WhatIf
  • Check if running as admin and scope is current user?
  • ^ Add "-Force" or "-IgnorePermissionsCheck" switch?
• ? Create cmdlet Get-PSResourceGetInstallPathOverride ?
• ? Create cmdlet Remove-PSResourceGetInstallPathOverride ?
• Make sure Get-PSResource searches for all paths in PSModulePath
  • Ref. Get-PSResource does not search in user context environment variable PSModulePath #889
• Document changes.
• Create tests.

Related issues / feature requests

• 2018-10-18 Move PowerShell folder on Windows from ${env:USERPROFILE}\OneDrive\Documents\PowerShell to ${env:USERPROFILE}\.powershell PowerShell#8069
• 2021-06-09 Let's move PSModulePath out of the documents folder PowerShell#15552
• 2022-04-07 User context, don't install to %OneDriveCommercial% if OneDrive for Business Known Folder Move (KFM) is enabled #627
• 2023-01-12 Get-PSResource does not search in user context environment variable PSModulePath #889
• 2023-11-16 Allow to specify custom module path in Install-PSResource #1494
• 2024-06-08: Script installation should require less fiddling with PATH #1661

PR Context

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Documentation needed
    • Issue filed:
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and enumerated concerns in the summary.

[o-l-a-v]

@anamnavi, @alerickson Have you had any time to check out this idea? Any thoughts? 🤔

---

Edit: It's probably better to use powershell.settings.json for this, ref:

• 2021-08-12 Let's move PSModulePath out of the documents folder PowerShell#15552 (comment)
• 2024-08-20 Allow to specify custom module path in Install-PSResource #1494 (comment)
• 2024-08-20 Let's move PSModulePath out of the documents folder PowerShell#15552 (comment)
• 2024-08-22 Allow to specify custom module path in Install-PSResource #1494 (comment)

Whichever solution you want for PSResourceGet, let's make it happen. I can try to do it, but I'd first want to hear what alternative you'd like. 🙂

---

Edit 2: Seems Windows PowerShell does not support powershell.config.json in my limited testing:

• Does Windows PowerShell support powershell.config.json? MicrosoftDocs/PowerShell-Docs#11349