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

Open o-l-a-v opened this issue 1 year ago • 1 comments

PR Summary

I'm experimenting with a way to override PSResourceGet install path for modules and scripts, suggested in my comment https://github.com/PowerShell/PSResourceGet/issues/1494#issuecomment-2225201194.

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

[ ] Maintainers confirm this is something they want, else more work is for nothing.
[x] Get env variable PSResourceGetInstallPathOverride if present and use it instead of default paths.
[ ] Create cmdlet Set-PSResourceInstallPathOverride -Path <path> -Scope <CurrentUser|AllUsers>.
- [x] Barebone functionality, as in set PSResourceGetInstallPathOverride and add it to PSModulePath if not already there.
- [x] -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. #889
[ ] Document changes.
[ ] Create tests.

[x] 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
- [x] Documentation needed
  - [ ] Issue filed:
User-facing changes
- [ ] Not Applicable
- OR
- [x] 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.

Jul 13 '24 12:07 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:

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:

Aug 21 '24 20:08 o-l-a-v