feat: support ZDOTDIR in installer

axodotdev · Dec 4, 2023 · 5ed9108 · 5ed9108
1 parent dabcf3e
commit 5ed9108
Show file tree

Hide file tree

Showing 24 changed files with 530 additions and 46 deletions.
diff --git a/cargo-dist/templates/installer/installer.sh.j2 b/cargo-dist/templates/installer/installer.sh.j2
@@ -313,6 +313,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -332,7 +350,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -345,7 +365,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/gallery/dist.rs b/cargo-dist/tests/gallery/dist.rs
@@ -370,6 +370,7 @@ impl DistResult {
             let app_home = tempdir.join(format!(".{app_name}"));
             let _output = script.output_checked(|cmd| {
                 cmd.env("HOME", &tempdir)
+                    .env("ZDOTDIR", &tempdir)
                     .env("MY_ENV_VAR", &app_home)
                     .env_remove("CARGO_HOME")
             })?;

diff --git a/cargo-dist/tests/snapshots/akaikatana_basic.snap b/cargo-dist/tests/snapshots/akaikatana_basic.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/akaikatana_musl.snap b/cargo-dist/tests/snapshots/akaikatana_musl.snap
@@ -306,6 +306,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -325,7 +343,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -338,7 +358,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/akaikatana_repo_with_dot_git.snap b/cargo-dist/tests/snapshots/akaikatana_repo_with_dot_git.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/axolotlsay_basic.snap b/cargo-dist/tests/snapshots/axolotlsay_basic.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.

diff --git a/cargo-dist/tests/snapshots/axolotlsay_edit_existing.snap b/cargo-dist/tests/snapshots/axolotlsay_edit_existing.snap
@@ -296,6 +296,24 @@ install() {
     fi
 }
 
+print_home_for_script() {
+    local script="$1"
+
+    local _home
+    case "$script" in
+        # zsh has a special ZDOTDIR directory, which if set
+        # should be considered instead of $HOME
+        .zsh*)
+            _home="$(zsh -c 'if [ -n "$ZDOTDIR" ]; then echo $ZDOTDIR; else echo $HOME; fi')"
+            ;;
+        *)
+            _home="$HOME"
+            ;;
+    esac
+
+    echo "$_home"
+}
+
 add_install_dir_to_path() {
     # Edit rcfiles ($HOME/.profile) to add install_dir to $PATH
     #
@@ -315,7 +333,9 @@ add_install_dir_to_path() {
         # Find the first file in the array that exists and choose
         # that as our target to write to
         for _rcfile_relative in $_rcfiles; do
-            local _rcfile="$HOME/$_rcfile_relative"
+            local _home
+            _home=$(print_home_for_script "$_rcfile_relative")
+            local _rcfile="$_home/$_rcfile_relative"
 
             if [ -f "$_rcfile" ]; then
                 _target="$_rcfile"
@@ -328,7 +348,8 @@ add_install_dir_to_path() {
         if [ -z "${_target:-}" ]; then
             local _rcfile_relative
             _rcfile_relative="$(echo "$_rcfiles" | awk '{ print $1 }')"
-            _target="$HOME/$_rcfile_relative"
+            _home=$(print_home_for_script "$_rcfile_relative")
+            _target="$_home/$_rcfile_relative"
         fi
 
         # `source x` is an alias for `. x`, and the latter is more portable/actually-posix.