Improve PowerShell plugin's profile handling functionality #1777
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
* Add support for the `package_commands_sourced_first` config switch. Prior to this change, the rez PowerShell implementation would always source the rez context script after the user/host profile scripts, so profile-level modifications to environment variables like `PATH` were always squashed by the unconditional overrides in the context script. With this change, the relative source order of the shell profile vs. the context script can be properly controlled using the `package_commands_sourced_first` config option, matching the behavior of `SH`-based shells. NOTE: Because this config option defaults to True, this commit also implicitly changes rez's default behavior to source the shell profile *after* the context when using PowerShell. * Support the `norc` shell plugin option, which enables the use of `rez-env --norc` to bypass the sourcing of any profile scripts. Signed-off-by: Nathan Rusch <[email protected]>
nrusch
force-pushed
the
improve_pwsh_profile_handling
branch
from
5b7157b
to
7f3678a
Compare
nrusch
commented
Jun 21, 2024
Comment on lines
+31
to
+33
| '$PROFILE ' | ||
| '| Get-Member -type NoteProperty ' | ||
| '| ForEach-Object { if (Test-Path $PROFILE."$($_.Name)") { . $PROFILE."$($_.Name)" }}') |
There was a problem hiding this comment.
Note that this is a dynamic approach to discovering available profile scripts, but it may be preferable to hardcode iteration over the known profile slots documented here.
This could look something like this (+/- formatting):
foreach ($name in 'AllUsersAllHosts', 'AllUsersCurrentHost', 'CurrentUserAllHosts', 'CurrentUserCurrentHost')
{
if (Test-Path $PROFILE.$name) {
. $PROFILE.$name
}
}
|
This may indirectly "resolve" #1279, since the user's profile will have the final say on any shell customization. |
|
The CLA has been sorted for rez. I'm not sure why this PR's status isn't updating though... |
|
/easycla |
|
@nrusch it should be good now. I manually triggered a refresh and it's now green. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improvements to the PowerShell plugin to support profile-related settings/options.
Add support for the
package_commands_sourced_firstconfig/runtime optionPrior to this change, the rez PowerShell implementation would always source the rez context script after the user/host profile scripts, so profile-level modifications to environment variables like
PATHwere always squashed by the unconditional overrides in the context script.With this change, the relative source order of the shell profile vs. the context script can be properly controlled using the
package_commands_sourced_firstconfig option, matching the behavior ofSH-based shells.NOTE: Because this option defaults to True, this also implicitly changes rez's default behavior to source the shell profile after the context when using PowerShell.
Support the
norcshell plugin option.This enables the use of
rez-env --norcto bypass the sourcing of any profile scripts when using PowerShell.