Zoxide Database to PowerShell object.

[josephwhite]

Hi.

Below is a function I wrote to parse a full database dump.

<#
    .Synopsis
    Get the Zoxide Database as a custom object.
    .Description
    A Zoxide Database is data file containing directories and their ranks.
    Utilizes the zoxide query command and PowerShell's native ability to split lines of text.
    .Parameter Keywords
    Part(s) of Directory paths to limit database entries returned.
    Optional.
    .Example
    # Export the Zoxide Database as a CSV file.
    $zdata = Get-ZoxideDatabase
    Export-Csv -InputObject $zdata -Path "C:\foobar\zoxide_database.csv" -NoTypeInformation
    .Example
    # Get entries matching the keyword(s) "nice".
    $zdata_nice = Get-ZoxideDatabase -Keywords "nice"
    # Get entries matching the keyword(s) "nice" and "baz".
    $zdata_nice_baz = Get-ZoxideDatabase -Keywords "nice baz"
    .Outputs
    PSCustomObject[].
    Zoxide Database entries, casted to an array of PowerShell objects.
    Each object has the following properties:
        Path = String representing the path of the directory.
        Score = Double representing the ranking of the directory.
#>
function Get-ZoxideDatabase {
    param(
        [Parameter()]
        [AllowEmptyString()]
        [string]$Keywords
    )
    $zoxide_database_raw = zoxide query --list --all --score $keywords
    $zoxide_database = Foreach ($zod in $zoxide_database_raw) {
        [PSCustomObject]@{
            Path = [string]$zod.Substring(7)
            Score = [double]$zod.Substring(0,7)
        }
    }
    return $zoxide_database;
}

The main goal I had was having a CSV mirror of the database and being able to update it in demand.

[josephwhite]

In case you instead wanted to format the object to something Zoxide can import, use this:

<#
    .Synopsis
    Format Zoxide Database.
    .Description
    Cases for each format to support the various "smart change directory" programs.
    Many of them store their databases as text files.
    .Parameter ZoxideDatabase
    Zoxide Database, represented as a PSCustomObject.
    Validates the objects having the same properties as the output object from Get-ZoxideDatabase.
    See Get-ZoxideDatabase for description of the properties needed.
    .Parameter Format
    Style to format the ZoxideDatabase entries as the following.

    | Value    | Description                      | Applicability
    |:---------|:---------------------------------|:----------------------------------------------
    |"Autojump"| Autojump Database file.          | https://github.com/wting/autojump
    |          |                                  |
    |"Z"       | Z Database file.                 | https://github.com/rupa/z
    |          |                                  | https://github.com/skywind3000/z.lua
    |          |                                  | https://github.com/agkozak/zsh-z
    |          |                                  | https://github.com/jethrokuan/z
    |          |                                  | https://github.com/clvv/fasd
    |          |                                  | https://github.com/quackduck/WarpDrive
    |          |                                  | https://github.com/knl/rh
    |          |                                  |
    |"Jump"    | Jump Scores Database (JSON) file.| https://github.com/gsamokovarov/jump

    .Example
    # Export the Zoxide Database in Autojump format.
    $zdata = Get-ZoxideDatabase
    $zdata_content = Format-ZoxideDatabase -ZoxideDatabase $zdata -Format "Autojump"
    $zdata_content | Out-File -FilePath "C:\foo\zoxide_database_autojump.txt"
    .Example
    # Export the Zoxide Database in Z format to a file.
    $zdata = Get-ZoxideDatabase
    $zdata_content = Format-ZoxideDatabase -ZoxideDatabase $zdata -Format "Z"
    $zdata_content | Out-File -FilePath "C:\foo\zoxide_database_z.txt"
    .Example
    # Export the Zoxide Database in Jump format to a file.
    $zdata = Get-ZoxideDatabase
    $zdata_content = Format-ZoxideDatabase -ZoxideDatabase $zdata -Format "Jump"
    $zdata_content | Out-File -FilePath "C:\foo\zoxide_database_jump_scores.json"
    .Outputs
    String[]
    Zoxide Database in given format.
    .Notes
    Zoxide's Import command only supports Autojump and Z files.
    Convert Jump to Z file.
    https://github.com/ajeetdsouza/zoxide/issues/706

    To see valid values for Format parameter.
    ((Get-Command Format-ZoxideDatabase).Parameters['Format'].Attributes | Where-Object { $_ -is [ValidateSet] }).ValidValues

#>
function Format-ZoxideDatabase {
    [OutputType([String[]])]
    param(
        [Parameter()]
        [ValidateScript({
        $Members = @(
            'Path'
            'Score'
        )
        foreach ($member in $members) {
            if (!(Get-Member -inputobject $_ -name $member -Membertype Properties)) {
                throw "$_ is invalid. Missing $member property."
            }
        }
        $true
        })]
        [Alias("InputObject", "Input")]
        [PSCustomObject[]]$ZoxideDatabase,

        [Parameter()]
        [ValidateSet(
            "Autojump",
            "Z",
            "Jump"
        )]
        [string]$Format = "Z"
    )
    switch($Format) {
        "Autojump" {
            $line_buffer = [string]"{0}|{1}|0";
            $content = ForEach ($entry in $ZoxideDatabase) {
                $line = $line_buffer -f $entry.Path, $entry.Score
                Write-Output $line
            }
        }
        "Z" {
            $line_buffer = [string]"{1}`t{0}";
            $content = ForEach ($entry in $ZoxideDatabase) {
                $line = $line_buffer -f $entry.Path, $entry.Score
                Write-Output $line
            }
        }
        "Jump" {
            $jump_json_db_obj = ForEach ($entry in $ZoxideDatabase) {
                [PSCustomObject]@{
                    Path = $entry.Path
                    Score = @{
                        Weight = $entry.Score
                        Age = (Get-Item $entry.Path).LastAccessTime
                    }
                }
            }
            $content = $jump_json_db_obj | ConvertTo-Json;
        }
    }
    return $content;
}