Coexistence of posh-git and miniconda. Can't suppress warning: "If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked."

[futuremotiondev]

I have miniconda3 and posh-git installed. I've configured my profile to load the conda hook on demand since it impacts loading time of my shell (adds about ~2 seconds compared to an almost instant startup).

Relevant profile bits:

Import-Module posh-git -Force
$GitPromptSettings.DefaultPromptPrefix.Text                  = '$(Get-Date -f "yyyy-MM-dd HH:mm") '
$GitPromptSettings.DefaultPromptPrefix.ForegroundColor       = [ConsoleColor]::DarkGray
$GitPromptSettings.DefaultPromptPath.ForegroundColor         = [ConsoleColor]::Gray
$GitPromptSettings.BeforeStatus.ForegroundColor              = [ConsoleColor]::DarkGray
$GitPromptSettings.DelimStatus.ForegroundColor               = [ConsoleColor]::DarkGray
$GitPromptSettings.AfterStatus.ForegroundColor               = [ConsoleColor]::DarkGray
$GitPromptSettings.BranchColor.ForegroundColor               = [ConsoleColor]::Cyan
$GitPromptSettings.WorkingColor.ForegroundColor              = [ConsoleColor]::Red
$GitPromptSettings.LocalWorkingStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
$GitPromptSettings.BranchBehindStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
$GitPromptSettings.IndexColor.ForegroundColor                = [ConsoleColor]::Green

Set-Alias -Name 'condahook' -Value EnableConda
Set-Alias -Name 'exitconda' -Value DisableConda

function EnableConda {
    If (Test-Path "C:\Python\miniconda3\Scripts\conda.exe") {
        (& "C:\Python\miniconda3\Scripts\conda.exe" "shell.powershell" "hook") | Out-String | ?{$_} | iex
    }
}

function DisableConda {
    Remove-Module -FullyQualifiedName "$Env:_CONDA_ROOT\shell\condabin\Conda.psm1" -ErrorAction Ignore | Out-Null
    # I have to re-import posh-git here because for some unknown reason it fails to work after
    # removing the Conda.psm1 module.
    Import-Module posh-git -Force -WarningAction Ignore | Out-Null
    $GitPromptSettings.DefaultPromptPrefix.Text                  = '$(Get-Date -f "yyyy-MM-dd HH:mm") '
    $GitPromptSettings.DefaultPromptPrefix.ForegroundColor       = [ConsoleColor]::DarkGray
    $GitPromptSettings.DefaultPromptPath.ForegroundColor         = [ConsoleColor]::Gray
    $GitPromptSettings.BeforeStatus.ForegroundColor              = [ConsoleColor]::DarkGray
    $GitPromptSettings.DelimStatus.ForegroundColor               = [ConsoleColor]::DarkGray
    $GitPromptSettings.AfterStatus.ForegroundColor               = [ConsoleColor]::DarkGray
    $GitPromptSettings.BranchColor.ForegroundColor               = [ConsoleColor]::Cyan
    $GitPromptSettings.WorkingColor.ForegroundColor              = [ConsoleColor]::Red
    $GitPromptSettings.LocalWorkingStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
    $GitPromptSettings.BranchBehindStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
    $GitPromptSettings.IndexColor.ForegroundColor                = [ConsoleColor]::Green
}

The condahook alias works as expected and activates the conda base environment, and I can switch envs, etc. The exitconda alias, however, emits a warning:

WARNING: If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked.

As well as a powershell "suggestion":

Suggestion [4,General]: The most similar commands are:

Despite the warning and suggestion text, things seem to work as expected.

1. Why is this warning being generated?
2. How can I suppress this warning?
3. Why is powershell offering a suggestion as if I entered an unknown or unrecognized command?
4. How can I suppress the powershell "suggestion"? (I tried Disable-ExperimentalFeature PSFeedbackProvider and it did nothing)
5. Is there a tried and true method of getting both miniconda and posh-git to co-exist without issue?
6. I'd like to avoid loading conda automatically since it impacts my console startup time so drastically.

Any help would be greatly appreciated. This issue is frustrating the heck out of me right now.

[futuremotiondev]

Adding an update. I took a dive into the posh-git internals and identified that the warning is coming from this code-block in posh-git.psm1:

# Install handler for removal/unload of the module
$ExecutionContext.SessionState.Module.OnRemove = {
    $global:VcsPromptStatuses = $global:VcsPromptStatuses | Where-Object { $_ -ne $PoshGitVcsPrompt }

    Reset-WindowTitle

    # Check if the posh-git prompt function itself has been replaced. If so, do not restore the prompt function
    $promptDef = if ($funcInfo = Get-Command prompt -ErrorAction SilentlyContinue) { $funcInfo.Definition }
    if ($promptDef -eq $GitPromptScriptBlock) {
        Set-Item Function:\prompt -Value ([scriptblock]::Create($defaultPromptDef))
        return
    }

    Write-Warning 'If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked.'
}

Which means essentially that if I remove the module from the session, it will ALWAYS print the If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked. warning. Is it possible to implement a way to suppress this?

I'm not sure how to suppress a warning defined within $ExecutionContext.SessionState.Module.OnRemove. I tried Remove-Module posh-git -Force -WarningAction SilentlyContinue -WarningVariable $null and it's still printing the warning.

[futuremotiondev]

SOLUTION

I "solved" my issue with the following steps:

1. Commented out the Write-Warning line from posh-git.psm1.

2. Enabled the PSFeedbackProvider "Experimental Feature" with Enable-ExperimentalFeature -Name PSFeedbackProvider. This suppresses the Suggestion [4,General]: The most similar commands are: output pollution.

3. Modified my Powershell profile to include the following:

function Import-PoshGit {
    Import-Module posh-git -Force -ErrorAction 0 | Out-Null
    $GitPromptSettings.DefaultPromptPrefix.Text                  = '$(Get-Date -f "yyyy-MM-dd HH:mm") '
    $GitPromptSettings.DefaultPromptPrefix.ForegroundColor       = [ConsoleColor]::DarkGray
    $GitPromptSettings.DefaultPromptPath.ForegroundColor         = [ConsoleColor]::Gray
    $GitPromptSettings.BeforeStatus.ForegroundColor              = [ConsoleColor]::DarkGray
    $GitPromptSettings.DelimStatus.ForegroundColor               = [ConsoleColor]::DarkGray
    $GitPromptSettings.AfterStatus.ForegroundColor               = [ConsoleColor]::DarkGray
    $GitPromptSettings.BranchColor.ForegroundColor               = [ConsoleColor]::Cyan
    $GitPromptSettings.WorkingColor.ForegroundColor              = [ConsoleColor]::Red
    $GitPromptSettings.LocalWorkingStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
    $GitPromptSettings.BranchBehindStatusSymbol.ForegroundColor  = [ConsoleColor]::Red
    $GitPromptSettings.IndexColor.ForegroundColor                = [ConsoleColor]::Green
}

Import-PoshGit

Set-Alias -Name 'condahook' -Value EnableConda
Set-Alias -Name 'condaexit' -Value DisableConda

$env:CONDA_IS_ENABLED = $false
function EnableConda {
    if($env:CONDA_IS_ENABLED -eq $false){
        If (Test-Path "C:\Python\miniconda3\Scripts\conda.exe") {
            (& "C:\Python\miniconda3\Scripts\conda.exe" "shell.powershell" "hook") | Out-String | ?{$_} | iex
            $env:CONDA_IS_ENABLED = $true
            return
        }
    }
}
function DisableConda {
    if($env:CONDA_IS_ENABLED -eq $true){
        Remove-Module -FullyQualifiedName "$Env:_CONDA_ROOT\shell\condabin\Conda.psm1" -ErrorAction Ignore | Out-Null
        Remove-Module posh-git -Force -ErrorAction Ignore | Out-Null
        Import-PoshGit
        $env:CONDA_IS_ENABLED = $false
    }
    return
}

1. The condahook alias enables miniconda3 functionality on-demand.
2. The condaexit disables miniconda3 functionality on-demand. (And re-imports posh-git, because for some unknown reason it gets disabled after removing the conda module)
3. Uses $env:CONDA_IS_ENABLED to track the state of whether the miniconda3 module is loaded or unloaded. This prevents the EnableConda function from executing if the environment variable is true, and prevents the DisableConda function from executing if the environment variable is false.
4. The WARNING: If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked. output no longer appears due to the modification to posh-git.psm1
5. The Suggestion [4,General]: The most similar commands are: output no longer appears due to enabling the PSFeedbackProvider experimental feature.

---

I would encourage the developers here to expose a SuppressUnloadWarning boolean as a configuration variable that can be set in your powershell profile. Something like:

$PoshGitPreferences.SuppressUnloadWarning = $true

When set, it would disable the WARNING: If your prompt function uses any posh-git commands, it will cause posh-git to be re-imported every time your prompt function is invoked. from being printed on module unload/load.

Hopefully this helps someone!

[futuremotiondev]

Yet another bit of info to add.

The Suggestion [4,General]: The most similar commands are: output will always appear whenever the $Error variable is populated and the PSFeedbackProvider experimental feature isn't enabled (It's not enabled by default).

In the case of this module, there are two spots in the psm1 that are raising exceptions:

Line 126

$currentPromptDef = if ($funcInfo = Get-Command prompt -ErrorAction SilentlyContinue) { 
    $funcInfo.Definition 
}

Error details:

System.Management.Automation.CommandNotFoundException: The term 'prompt' is not 
recognized as a name of a cmdlet, function, script file, or executable program. 
Check the spelling of the name, or if a path was included, verify that the path 
is correct and try again.

and...

Line 153

# Check if the posh-git prompt function itself has been replaced. If so, do not restore the prompt function
$promptDef = if ($funcInfo = Get-Command prompt -ErrorAction SilentlyContinue) {
    $funcInfo.Definition
}

Error details (Same as previous):

System.Management.Automation.CommandNotFoundException: The term 'prompt' is not 
recognized as a name of a cmdlet, function, script file, or executable program. 
Check the spelling of the name, or if a path was included, verify that the path 
is correct and try again.

It would be a good modification to ensure that an error is not raised if prompt isn't defined. In my case, unloading/loading the module dynamically with Remove-Module pushed the above error entries to $Error. If this is fixed, it will eliminate the erroneous Suggestion [4,General]: The most similar commands are: output in the console despite the module functioning as intended.

[dahlbyk]

Many thanks for your extensive troubleshooting. I wouldn't have expected unloading/reloading the module to be a normal use case.

When you say posh-git stops working after you unload miniconda I assume you mean the custom prompt resets. You might try replacing the Import-Module posh-git -Force with Set-Item Function:\prompt -Value $GitPromptScriptBlock (from here) to recreate the prompt function after miniconda's unloads.

[futuremotiondev]

Hmm, that doesn't seem to be working for me. Example code:

$OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = [System.Text.UTF8Encoding]::new()

Import-Module posh-git -Force -ErrorAction 0 | Out-Null

$GitPromptSettings.DefaultPromptPrefix.Text                  = '$(Get-Date -f "yyyy-MM-dd HH:mm") '

Set-Alias -Name 'err' -Value ShowErrors
Set-Alias -Name 'condahook' -Value EnableConda
Set-Alias -Name 'condaexit' -Value DisableConda

$env:CONDA_IS_ENABLED = $false
function EnableConda {
    if($env:CONDA_IS_ENABLED -eq $false){
        If (Test-Path "C:\Python\miniconda3\Scripts\conda.exe") {
            (& "C:\Python\miniconda3\Scripts\conda.exe" "shell.powershell" "hook") | Out-String | ?{$_} | iex
            $env:CONDA_IS_ENABLED = $true
            return
        }
    }
}
function DisableConda {
    if($env:CONDA_IS_ENABLED -eq $true){
        Remove-Module -FullyQualifiedName "$Env:_CONDA_ROOT\shell\condabin\Conda.psm1" -ErrorAction Ignore | Out-Null
        Set-Item Function:\prompt -Value $GitPromptScriptBlock
        $env:CONDA_IS_ENABLED = $false
    }
    return
}
function ShowErrors { $Error | % { $_ | Format-List * -Force } }

Powershell doesn't like the Set-Item Function:\prompt -Value $GitPromptScriptBlock line. $Error is populated with:

ErrorRecord                 : The term 'prompt' is not recognized as a name of a cmdlet, function, script file, or
                              executable program.
                              Check the spelling of the name, or if a path was included, verify that the path is correct and
                              try again.
CommandName                 : prompt
WasThrownFromThrowStatement : False
TargetSite                  : System.Collections.ObjectModel.Collection`1[System.Management.Automation.PSObject]
                              Invoke(System.Collections.IEnumerable)
Message                     : The term 'prompt' is not recognized as a name of a cmdlet, function, script file, or
                              executable program.
                              Check the spelling of the name, or if a path was included, verify that the path is correct and
                              try again.
Data                        : {[System.Management.Automation.Interpreter.InterpretedFrameInfo,
                              System.Management.Automation.Interpreter.InterpretedFrameInfo[]]}
InnerException              :
HelpLink                    :
Source                      : System.Management.Automation
HResult                     : -2146233087
StackTrace                  :    at System.Management.Automation.Runspaces.PipelineBase.Invoke(IEnumerable input)
                                 at Microsoft.PowerShell.Executor.ExecuteCommandHelper(Pipeline tempPipeline, Exception&
                              exceptionThrown, ExecutionOptions options)


PSMessageDetails      :
Exception             : System.Management.Automation.CommandNotFoundException: The term 'prompt' is not recognized as a name
                        of a cmdlet, function, script file, or executable program.
                        Check the spelling of the name, or if a path was included, verify that the path is correct and try
                        again.
                           at System.Management.Automation.Runspaces.PipelineBase.Invoke(IEnumerable input)
                           at Microsoft.PowerShell.Executor.ExecuteCommandHelper(Pipeline tempPipeline, Exception&
                        exceptionThrown, ExecutionOptions options)
TargetObject          : prompt
CategoryInfo          : ObjectNotFound: (prompt:String) [], CommandNotFoundException
FullyQualifiedErrorId : CommandNotFoundException
ErrorDetails          :
InvocationInfo        : System.Management.Automation.InvocationInfo
ScriptStackTrace      : at <ScriptBlock>, <No file>: line 1
PipelineIterationInfo : {}

Am I doing something wrong?

Edit:

Set-Item -Path Function:prompt -Value $GitPromptScriptBlock also doesn't work. Same error.

[futuremotiondev]

More troubleshooting...

function DisableConda {
    if($env:CONDA_IS_ENABLED -eq $true){
        Remove-Module -FullyQualifiedName "$Env:_CONDA_ROOT\shell\condabin\Conda.psm1" -ErrorAction Ignore | Out-Null
        $env:CONDA_IS_ENABLED = $false
    }
}

Simply unloading the Conda.psm1 file causes all this:

However, I can run the snippet you gave me earlier to get my posh-git prompt back:

Set-Item Function:\prompt -Value $GitPromptScriptBlock

BUT... it only works if I type it in manually into the terminal.

If I modify the DisableConda function to call the same thing in my profile, it doesn't work:

function DisableConda {
    if($env:CONDA_IS_ENABLED -eq $true){
        Remove-Module -FullyQualifiedName "$Env:_CONDA_ROOT\shell\condabin\Conda.psm1" -ErrorAction Ignore | Out-Null
        Set-Item Function:\prompt -Value $GitPromptScriptBlock
        $env:CONDA_IS_ENABLED = $false
    }
    return
}

So I'm at a loss. No idea what miniconda is doing behind the scenes. Maybe it's a scope issue? I tried Set-Item $global:Function:\prompt -Value $GitPromptScriptBlock but it errors out.

All of this is a pain :)

Thanks for all you guys do with this module though, it's amazing. Hopefully I don't come across as too critical or anything. I just want to get conda and posh-git to play nice together.

[dahlbyk]

Try adding something like this before the Set-Item?

posh-git/src/posh-git.psm1

Lines 136 to 137 in bbc5ac3

	# HACK: If prompt is missing, create a global one we can overwrite with Set-Item
	function global:prompt { ' ' }

[dahlbyk]

Or another option would be to try patching posh-git's OnRemove to avoid the warning. I would guess removing miniconda removes prompt altogether, which we can probably detect to suppress the warning:

    # If prompt is missing, let PowerShell recreate one
    if (!($funcInfo = Get-Command prompt -ErrorAction SilentlyContinue)) { return }

    # Check if the posh-git prompt function itself has been replaced. If so, do not restore the prompt function
    if ($funcInfo.Definition -eq $GitPromptScriptBlock) {
        Set-Item Function:\prompt -Value ([scriptblock]::Create($defaultPromptDef))
        return
    }

[futuremotiondev]

Try adding something like this before the Set-Item?

posh-git/src/posh-git.psm1

Lines 136 to 137 in bbc5ac3
HACK: If prompt is missing, create a global one we can overwrite with Set-Item
function global:prompt { ' ' }

That totally did it! Thank you so much! Such a way better solution.

[futuremotiondev]

Or another option would be to try patching posh-git's OnRemove to avoid the warning. I would guess removing miniconda removes prompt altogether, which we can probably detect to suppress the warning:

# If prompt is missing, let PowerShell recreate one
if (!($funcInfo = Get-Command prompt -ErrorAction SilentlyContinue)) { return }

# Check if the posh-git prompt function itself has been replaced. If so, do not restore the prompt function
if ($funcInfo.Definition -eq $GitPromptScriptBlock) {
    Set-Item Function:\prompt -Value ([scriptblock]::Create($defaultPromptDef))
    return
}

That would be awesome if you could patch posh-git to avoid this workaround since what I'm doing is essentially just a hack. I would be much appreciative! Right now I'm happy your previous suggestion worked though as it doesn't involve the overhead of re-importing posh-git every time I switch between miniconda3 activation and back.

Let me know if you decide to patch posh-git so I can install the new version immediately.