bash doctor

Author: ajeetdsouza

templates/bash.txt

@@ -62,6 +62,28 @@ fi
 
 {% endif -%}
 
+# Report common issues.
+function __zoxide_doctor() {
+{%- if hook == InitHook::None %}
+    return 0
+
+{%- else %}
+    [[ ${_ZO_DOCTOR:-1} -ne 0 ]] || return 0
+    [[ ${PROMPT_COMMAND:=} != *'__zoxide_hook'* ]] || return 0
+
+    _ZO_DOCTOR=0
+    \builtin printf '%s\n' \
+        'zoxide: detected a possible configuration issue.' \
+        'Please ensure that zoxide is initialized right at the end of your shell configuration file (usually ~/.bashrc).' \
+        '' \
+        'If the issue persists, consider filing an issue at:' \
+        'https://github.com/ajeetdsouza/zoxide/issues' \
+        '' \
+        'Disable this message by setting _ZO_DOCTOR=0.' \
+        '' >&2
+{%- endif %}
+}
+
 {{ section }}
 # When using zoxide with --no-cmd, alias these internal functions as desired.
 #
@@ -70,6 +92,8 @@ __zoxide_z_prefix='z#'
 
 # Jump to a directory using only keywords.
 function __zoxide_z() {
+    __zoxide_doctor
+
     # shellcheck disable=SC2199
     if [[ $# -eq 0 ]]; then
         __zoxide_cd ~
@@ -93,6 +117,7 @@ function __zoxide_z() {
 
 # Jump to a directory using interactive search.
 function __zoxide_zi() {
+    __zoxide_doctor
     \builtin local result
     result="$(\command zoxide query --interactive -- "$@")" && __zoxide_cd "${result}"
 }
@@ -154,6 +179,6 @@ fi
 {%- endmatch %}
 
 {{ section }}
-# To initialize zoxide, add this to your configuration (usually ~/.bashrc):
+# To initialize zoxide, add this to your shell configuration file (usually ~/.bashrc):
 #
 # eval "$(zoxide init bash)"

templates/zsh.txt

@@ -69,7 +69,7 @@ function __zoxide_doctor() {
         'Please ensure that zoxide is initialized right at the end of your shell configuration file (usually ~/.zshrc).' \
         '' \
         'If the issue persists, consider filing an issue at:' \
-        'https://github.com/ajeetdsouza/zoxide/issues.' \
+        'https://github.com/ajeetdsouza/zoxide/issues' \
         '' \
         'Disable this message by setting _ZO_DOCTOR=0.' \
         '' >&2