docs: 📝 Update wiki powershell-snippet

[FallenDeity]

Update powershell-snippet in wiki to play nice with zoxide, yazi etc

With reference to #1467 @spenserblack

[spenserblack]

Thanks! Let me know what you think of this feedback.

[spenserblack]

BTW, I don't have zoxide installed, would you mind posting the output of zoxide init powershell? I'd just like to look into the hook and maybe figure out why z requires the output encoding workaround.

[FallenDeity]

I ran a few variations of the experiment so basically if I do z into some git repo while the function gets triggered onefetch doesn't display anything in console unless, I explicitly pipe it to Write-Host but if I do this Set-Location -LiteralPath ".\VsCodeProjects\profile\" it works as expected without piping.

This leads me to believe this silencing behavior might have something to do with zoxide's command when changing directories.

 zoxide init powershell
# =============================================================================
#
# Utility functions for zoxide.
#

# Call zoxide binary, returning the output as UTF-8.
function global:__zoxide_bin {
    $encoding = [Console]::OutputEncoding
    try {
        [Console]::OutputEncoding = [System.Text.Utf8Encoding]::new()
        $result = zoxide @args
        return $result
    } finally {
        [Console]::OutputEncoding = $encoding
    }
}

# pwd based on zoxide's format.
function global:__zoxide_pwd {
    $cwd = Get-Location
    if ($cwd.Provider.Name -eq "FileSystem") {
        $cwd.ProviderPath
    }
}

# cd + custom logic based on the value of _ZO_ECHO.
function global:__zoxide_cd($dir, $literal) {
    $dir = if ($literal) {
        Set-Location -LiteralPath $dir -Passthru -ErrorAction Stop
    } else {
        if ($dir -eq '-' -and ($PSVersionTable.PSVersion -lt 6.1)) {
            Write-Error "cd - is not supported below PowerShell 6.1. Please upgrade your version of PowerShell."
        }
        elseif ($dir -eq '+' -and ($PSVersionTable.PSVersion -lt 6.2)) {
            Write-Error "cd + is not supported below PowerShell 6.2. Please upgrade your version of PowerShell."
        }
        else {
            Set-Location -Path $dir -Passthru -ErrorAction Stop
        }
    }
}

# =============================================================================
#
# Hook configuration for zoxide.
#

# Hook to add new entries to the database.
$global:__zoxide_oldpwd = __zoxide_pwd
function global:__zoxide_hook {
    $result = __zoxide_pwd
    if ($result -ne $global:__zoxide_oldpwd) {
        if ($null -ne $result) {
            zoxide add -- $result
        }
        $global:__zoxide_oldpwd = $result
    }
}

# Initialize hook.
$global:__zoxide_hooked = (Get-Variable __zoxide_hooked -ErrorAction SilentlyContinue -ValueOnly)
if ($global:__zoxide_hooked -ne 1) {
    $global:__zoxide_hooked = 1
    $global:__zoxide_prompt_old = $function:prompt

    function global:prompt {
        if ($null -ne $__zoxide_prompt_old) {
            & $__zoxide_prompt_old
        }
        $null = __zoxide_hook
    }
}

# =============================================================================
#
# When using zoxide with --no-cmd, alias these internal functions as desired.
#

# Jump to a directory using only keywords.
function global:__zoxide_z {
    if ($args.Length -eq 0) {
        __zoxide_cd ~ $true
    }
    elseif ($args.Length -eq 1 -and ($args[0] -eq '-' -or $args[0] -eq '+')) {
        __zoxide_cd $args[0] $false
    }
    elseif ($args.Length -eq 1 -and (Test-Path $args[0] -PathType Container)) {
        __zoxide_cd $args[0] $true
    }
    else {
        $result = __zoxide_pwd
        if ($null -ne $result) {
            $result = __zoxide_bin query --exclude $result -- @args
        }
        else {
            $result = __zoxide_bin query -- @args
        }
        if ($LASTEXITCODE -eq 0) {
            __zoxide_cd $result $true
        }
    }
}

# Jump to a directory using interactive search.
function global:__zoxide_zi {
    $result = __zoxide_bin query -i -- @args
    if ($LASTEXITCODE -eq 0) {
        __zoxide_cd $result $true
    }
}

# =============================================================================
#
# Commands for zoxide. Disable these using --no-cmd.
#

Set-Alias -Name z -Value __zoxide_z -Option AllScope -Scope Global -Force
Set-Alias -Name zi -Value __zoxide_zi -Option AllScope -Scope Global -Force

# =============================================================================
#
# To initialize zoxide, add this to your configuration (find it by running
# `echo $profile` in PowerShell):
#
# Invoke-Expression (& { (zoxide init powershell | Out-String) })

[FallenDeity]

Edit: I played around with zoxide's script a bit and fixed both issues

• Reason for no output was because they were reassigning any output from Set-Location to a variable $dir and not returning it.

function global:__zoxide_cd($dir, $literal) {
    $dir = if ($literal) {
        Set-Location -LiteralPath $dir -Passthru -ErrorAction Stop
    } else {
        if ($dir -eq '-' -and ($PSVersionTable.PSVersion -lt 6.1)) {
            Write-Error "cd - is not supported below PowerShell 6.1. Please upgrade your version of PowerShell."
        }
        elseif ($dir -eq '+' -and ($PSVersionTable.PSVersion -lt 6.2)) {
            Write-Error "cd + is not supported below PowerShell 6.2. Please upgrade your version of PowerShell."
        }
        else {
            Set-Location -Path $dir -Passthru -ErrorAction Stop
        }
    }
    #  This fixes it
    return $dir
}

• Reason for garbled characters, they are changing the default console output encoding in the finally block back from utf-8

function global:__zoxide_bin {
    # default encoding utf-8
    $encoding = [System.Text.Encoding]::UTF8
    try {
        [Console]::OutputEncoding = [System.Text.Utf8Encoding]::new()
        $result = zoxide @args
        return $result
    } finally {
        [Console]::OutputEncoding = $encoding
    }
}

onefetch setup

$global:lastRepository = $null

function Check-DirectoryForNewRepository {
    $currentRepository = git rev-parse --show-toplevel 2>$null
    if ($currentRepository -and ($currentRepository -ne $global:lastRepository)) {
        onefetch
    }
    $global:lastRepository = $currentRepository
}

function Set-Location {
    Microsoft.PowerShell.Management\Set-Location @args  
    Check-DirectoryForNewRepository
}

I believe they silence the output because -PassThru they use returns a dictionary which they don't really wanna log, so maybe a sort of configurable option there would be nice

So to summarize the current stuff not printing is more of a zoxide issue 😔 and the this pr fixes the path not changing issue due to other required params not being propagated through the Set-Location, and adds a workaround to prevent unintentional silencing by other scripts

[spenserblack]

I believe they silence the output because -PassThru they use returns a dictionary which they don't really wanna log, so maybe a sort of configurable option there would be nice

Without looking more into it, I'm not really sure why zoxide is using -PassThru at all. If they don't want output, simply excluding -PassThru can achieve that. Discarding the output of -PassThru is like doing some-tool --verbose > /dev/null 😅

Maybe -PassThru behaves differently on older versions of PowerShell 🤷

[spenserblack]

🤔 Also, as a workaround when onefetch is wrapped by a tool/function/alias that might consume output (like z), it might make sense to redirect onefetch's output to stderr. This is a somewhat common practice to separate text meant for humans from text meant for machines.

[FallenDeity]

I don't think it would be a good idea to redirect onefetch's output to stderr in case of powershell

onefetch | Write-Error
onefetch | Write-Error : TSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSX   FallenDeity ~ git version 2.48.1.windows.1
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

onefetch | Write-Error : TSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSXTSX   ------------------------------------------
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

wouldnt want this 😭, also afaik piping to stderr might mess with onefetch styles since a lot of terminals/or terminal config frameworks apply custom ansi styles to error text for theming

[spenserblack]

Alright, that makes sense, then I think your PR is good as it is 👍

[spenserblack]

@o2sh This will need an admin to merge because the required CI jobs won't run with the ignored paths.