[Powershell] zoxide Does Not Escape Paths

[ditsuke]

Problem

Powershell requires escaping special characters even if they're enclosed in single quotes. So calling Set-Location on, say 'D:\test\[foo] bar\' will fail like:

Set-Location : Cannot find path 'test/[foo] bar' because it does not exist.
At line:1 char:1
+ Set-Location 'test/[foo] bar'
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (test/[foo] bar:String) [Set-Location], ItemNotFoundExcep
   tion
    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.SetLocationCommand

Solution

Path passed to Set-Location should be escaped:

[TeamDman]

I fixed this by adjusting my profile to override the __zoxide_cd

function cd {
    z @args
}

Invoke-Expression (& { (zoxide init powershell | Out-String) })

function global:__zoxide_cd($dir, $literal) {
    # we need to override this so it doesn't pass -LiteralPath
    # https://github.com/ajeetdsouza/zoxide/blob/d99d82f141106c5c9e32fe75ec7695a43b3fcadc/templates/powershell.txt#L29C1-L46C2
    $dir = Set-Location $dir -Passthru -ErrorAction Stop
}

Without overriding the function, I got

❯ zoxide --version
zoxide 0.9.6
❯ ls
a[]b
❯ cd '.\a`[`]b\'
Set-Location:
Line |
  29 |          Set-Location -LiteralPath $dir -Passthru -ErrorAction Stop
     |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Cannot find path '.\a`[`]b\' because it does not exist.

Looks like it from here at least is always passed $true so idk the consequences of changing that but it's working for now

zoxide/templates/powershell.txt

Lines 102 to 124 in d99d82f

	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
	}
	}
	}

[ajeetdsouza]

What is the actual name of your directory?

[TeamDman]

the problem reproduced for me using a dir named a[]b