zoxide/templates/fish.txt

{%- let section = "# =============================================================================\n#" -%}
{%- let not_configured = "# -- not configured --" -%}

{{ section }}
# Utility functions for zoxide.
#

# pwd based on the value of _ZO_RESOLVE_SYMLINKS.
function __zoxide_pwd
{%- if resolve_symlinks %}
    builtin pwd -P
{%- else %}
    builtin pwd -L
{%- endif %}
end

# A copy of fish's internal cd function. This makes it possible to use
# `alias cd=z` without causing an infinite loop.
if ! builtin functions -q __zoxide_cd_internal
    if builtin functions -q cd
        builtin functions -c cd __zoxide_cd_internal
    else
        alias __zoxide_cd_internal="builtin cd"
    end
end

# cd + custom logic based on the value of _ZO_ECHO.
function __zoxide_cd
    __zoxide_cd_internal $argv
{%- if echo %}
    and __zoxide_pwd
{%- endif %}
    and builtin commandline -f repaint
end

{{ section }}
# Hook configuration for zoxide.
#

# Initialize hook to add new entries to the database.
if test "$__zoxide_hooked" != 1
    set __zoxide_hooked 1
{%- match hook %}
{%- when InitHook::None %}
    function __zoxide_hook
{%- when InitHook::Prompt %}
    function __zoxide_hook --on-event fish_prompt
{%- when InitHook::Pwd %}
    function __zoxide_hook --on-variable PWD
{%- endmatch %}
        command zoxide add -- (__zoxide_pwd)
    end
end

{{ section }}
# When using zoxide with --no-aliases, alias these internal functions as
# desired.
#

# Jump to a directory using only keywords.
function __zoxide_z
    set argc (count $argv)
    if test $argc -eq 0
        __zoxide_cd $HOME
    else if test "$argv" = -
        __zoxide_cd -
    else if begin
            test $argc -eq 1; and test -d $argv[1]
        end
        __zoxide_cd $argv[1]
    else
        set -l __zoxide_result (command zoxide query --exclude (__zoxide_pwd) -- $argv)
        and __zoxide_cd $__zoxide_result
    end
end

# Jump to a directory using interactive search.
function __zoxide_zi
    set -l __zoxide_result (command zoxide query -i -- $argv)
    and __zoxide_cd $__zoxide_result
end

{{ section }}
# Convenient aliases for zoxide. Disable these using --no-aliases.
#

{%- match cmd %}
{%- when Some with (cmd) %}

# Remove definitions.
function __zoxide_unset
    set --erase $argv >/dev/null 2>&1
    abbr --erase $argv >/dev/null 2>&1
    builtin functions --erase $argv >/dev/null 2>&1
end

__zoxide_unset {{cmd}}
alias {{cmd}}="__zoxide_z"

__zoxide_unset {{cmd}}i
alias {{cmd}}i="__zoxide_zi"

{%- when None %}

{{ not_configured }}

{%- endmatch %}

{{ section }}
# To initialize zoxide, add this to your configuration (usually
# ~/.config/fish/config.fish):
#
# zoxide init fish | source