Use ZIM_DATA_DIR and install to XDG_DATA_HOME by default

README.md

@@ -42,13 +42,13 @@ Installing Zim is easy. If you have a different shell framework installed (like
 
 1. In a Zsh shell, clone the repository:
   ```
-  git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-${HOME}}/.zim
+  git clone --recursive https://github.com/Eriner/zim.git "${XDG_DATA_HOME:-"${HOME}/.local/share"}/zim"
   ```
 
 2. Paste this into your terminal to prepend the initialization templates to your configs:
   ```
   setopt EXTENDED_GLOB
-  for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
+  for template_file ( ${ZIM_DATA_DIR}/templates/* ); do
     user_file="${ZDOTDIR:-${HOME}}/.${template_file:t}"
     touch ${user_file}
     ( print -rn "$(<${template_file})$(<${user_file})" >! ${user_file} ) 2>/dev/null
@@ -81,7 +81,7 @@ For more information about the `zmanage` tool, see the [meta module][meta-module
 Uninstalling
 ------------
 
-The best way to remove zim is to manually delete `~/.zim`, `~/.zimrc`, and
+The best way to remove zim is to manually delete `~/.local/share/zim`, `~/.zimrc`, and
 remove the initialization lines from your `~/.zshrc`.
 
 However, there are some **experimental** convenience functions to remove zim:

init.zsh

@@ -9,7 +9,14 @@ if ! is-at-least 5.2; then
 fi
 
 # Define zim location
-(( ! ${+ZIM_HOME} )) && export ZIM_HOME="${ZDOTDIR:-${HOME}}/.zim"
+(( ! ${+ZIM_DATA_DIR} )) && \
+  if [[ -d "${XDG_DATA_HOME:-"${HOME}/.local/share"}/zim" ]]; then
+    export ZIM_DATA_DIR="${XDG_DATA_HOME:-"${HOME}/.local/share"}/zim"
+  elif [[ -d "${ZDOTDIR:-${HOME}}/.zim" ]]; then
+    export ZIM_DATA_DIR="${ZDOTDIR:-${HOME}}/.zim"
+  else
+    export ZIM_DATA_DIR="${XDG_DATA_HOME:-"${HOME}/.local/share"}/zim"
+  fi
 
 # Source user configuration
 if [[ -s "${ZDOTDIR:-${HOME}}/.zimrc" ]]; then
@@ -20,9 +27,9 @@ load_zim_module() {
   local wanted_module
 
   for wanted_module (${zmodules}); do
-    if [[ -s "${ZIM_HOME}/modules/${wanted_module}/init.zsh" ]]; then
+    if [[ -s "${ZIM_DATA_DIR}/modules/${wanted_module}/init.zsh" ]]; then
-      source "${ZIM_HOME}/modules/${wanted_module}/init.zsh"
+      source "${ZIM_DATA_DIR}/modules/${wanted_module}/init.zsh"
-    elif [[ ! -d "${ZIM_HOME}/modules/${wanted_module}" ]]; then
+    elif [[ ! -d "${ZIM_DATA_DIR}/modules/${wanted_module}" ]]; then
       print "No such module \"${wanted_module}\"." >&2
     fi
   done
@@ -33,12 +40,12 @@ load_zim_function() {
   local mod_function
 
   # autoload searches fpath for function locations; add enabled module function paths
-  fpath=(${${zmodules}:+${ZIM_HOME}/modules/${^zmodules}/functions(/FN)} ${fpath})
+  fpath=(${${zmodules}:+${ZIM_DATA_DIR}/modules/${^zmodules}/functions(/FN)} ${fpath})
 
   function {
     setopt LOCAL_OPTIONS EXTENDED_GLOB
 
-    for mod_function in ${ZIM_HOME}/modules/${^zmodules}/functions/${~function_glob}; do
+    for mod_function in ${ZIM_DATA_DIR}/modules/${^zmodules}/functions/${~function_glob}; do
       autoload -Uz ${mod_function}
     done
   }

modules/custom/functions/example_function

@@ -1,4 +1,4 @@
 # this is an example function
 # running 'example_function' in a zsh session will execute the code below
 
-print "executed example function: ${ZIM_HOME}/modules/custom/functions/example_function!"
+print "executed example function: ${ZIM_DATA_DIR}/modules/custom/functions/example_function!"

modules/debug/functions/trace-zim

@@ -43,9 +43,9 @@ cp ${ZDOTDIR:-${HOME}}/.zshrc /tmp/ztrace/.zshrc.orig
 cp ${ZDOTDIR:-${HOME}}/.zimrc /tmp/ztrace/.zimrc
 # rsync will allow us to not have to copy the .git folder; use if available 
 if (( ${+commands[rsync]} )); then
-  rsync -az --exclude .git ${ZIM_HOME} /tmp/ztrace/
+  rsync -az --exclude .git ${ZIM_DATA_DIR} /tmp/ztrace/
 else
-  cp -R ${ZIM_HOME} /tmp/ztrace/
+  cp -R ${ZIM_DATA_DIR} /tmp/ztrace/
 fi
 
 # create a modified .zshrc to produce a trace log

modules/meta/functions/zmanage

@@ -16,7 +16,7 @@ if (( ${#} != 1 )); then
 fi
 
 local tools
-tools="${ZIM_HOME}/tools"
+tools="${ZIM_DATA_DIR}/tools"
 
 case ${1} in
   update)      zsh ${tools}/zim_update
@@ -33,7 +33,7 @@ case ${1} in
                ;;
   reset)       zsh ${tools}/zim_reset
                ;;
-  debug)       zsh ${ZIM_HOME}/modules/debug/functions/trace-zim
+  debug)       zsh ${ZIM_DATA_DIR}/modules/debug/functions/trace-zim
                ;;
   *)           print ${usage}
                ;;

templates/zlogin

@@ -17,7 +17,7 @@
     fi
   }
 
-  zim_mods=${ZIM_HOME}/modules
+  zim_mods=${ZIM_DATA_DIR}/modules
   setopt EXTENDED_GLOB
 
   # zcompile the completion cache; siginificant speedup.

templates/zshrc

@@ -4,11 +4,11 @@
 # User configuration sourced by interactive shells
 #
 
-# Change default zim location 
+# Define zim location 
-export ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim
+(( ! ${+ZIM_DATA_DIR} )) && export ZIM_DATA_DIR="${XDG_DATA_HOME:-"${HOME}/.local/share"}/zim"
 
 # Source zim
-if [[ -s ${ZIM_HOME}/init.zsh ]]; then
+if [[ -s "${ZIM_DATA_DIR}/init.zsh" ]]; then
-  source ${ZIM_HOME}/init.zsh
+  source "${ZIM_DATA_DIR}/init.zsh"
 fi
 

tools/zim_build_cache

@@ -2,4 +2,4 @@
 # zim_build_cache - rebuilds the zim cache
 #
 
-source ${ZIM_HOME}/templates/zlogin
+source ${ZIM_DATA_DIR}/templates/zlogin

tools/zim_clean_cache

@@ -2,7 +2,7 @@
 # zim_clean_cache - removes all zcompiled files
 #
 
-find ${ZIM_HOME} -iname '*.zwc' | xargs rm
+find ${ZIM_DATA_DIR} -iname '*.zwc' | xargs rm
 rm -f ${ZDOTDIR:-${HOME}}/.{zshrc.zwc,zcompdump,zcompdump.zwc}
 
 print 'To rebuild the completion cache, please restart your terminal'

tools/zim_info

@@ -2,7 +2,7 @@
 # zim_info - prints zim and system info
 #
 
-cd ${ZIM_HOME}
+cd ${ZIM_DATA_DIR}
 
 print "Zim commit ref:   $(command git rev-parse --short HEAD)"
 print "Zsh version:      $(command zsh --version)"

tools/zim_issue

@@ -24,7 +24,7 @@ if ! waiter_func; then
 fi
 
 # for convenience, this is our new home
-cd ${ZIM_HOME}
+cd ${ZIM_DATA_DIR}
 
 # collect sys info
 git_dirty=$(command git status --porcelain 2>/dev/null | tail -n1)
@@ -64,7 +64,7 @@ done
 
 # if we have a dirty git, report it
 if [[ -n ${git_dirty} ]]; then
-  print "${ZIM_HOME} has a dirty git working tree."
+  print "${ZIM_DATA_DIR} has a dirty git working tree."
   print "here is the diff:"
   print '```'
   print $(command git diff)

tools/zim_remove

@@ -10,4 +10,4 @@ sed '/# The following code helps/,/) &!/d' ${ZDOTDIR:-${HOME}}/.zlogin
 rm -f ${ZDOTDIR:-${HOME}}/.zimrc
 
 # not forcing this one, as it is recursive. It's possible something went wrong.
-rm -r ${ZIM_HOME}
+rm -r ${ZIM_DATA_DIR}

tools/zim_reset

@@ -2,5 +2,5 @@
 # zim_reset - resets the zim repository to latest commit
 #
 
-cd ${ZIM_HOME}
+cd ${ZIM_DATA_DIR}
 git reset --hard

tools/zim_update

@@ -2,7 +2,7 @@
 # zim_update - update the zim repository
 #
 
-cd ${ZIM_HOME}
+cd ${ZIM_DATA_DIR}
 
 # this is the cleanest way I know how to update a repository
 git remote update -p