fix: Prioritize $HOME when Cygwin or msys2 is detected

twpayne · Feb 14, 2024 · ccde612 · ccde612
1 parent 6788c54
commit ccde612
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 5 deletions.
diff --git a/internal/chezmoi/abspath.go b/internal/chezmoi/abspath.go
@@ -2,7 +2,6 @@ package chezmoi
 
 import (
 	"fmt"
-	"os"
 	"path"
 	"path/filepath"
 	"reflect"
@@ -176,7 +175,7 @@ func (p *AbsPath) UnmarshalText(text []byte) error {
 
 // HomeDirAbsPath returns the user's home directory as an AbsPath.
 func HomeDirAbsPath() (AbsPath, error) {
-	userHomeDir, err := os.UserHomeDir()
+	userHomeDir, err := UserHomeDir()
 	if err != nil {
 		return EmptyAbsPath, err
 	}

diff --git a/internal/chezmoi/chezmoi_unix.go b/internal/chezmoi/chezmoi_unix.go
@@ -4,6 +4,7 @@ package chezmoi
 
 import (
 	"io/fs"
+	"os"
 
 	"golang.org/x/sys/unix"
 )
@@ -26,6 +27,11 @@ func IsExecutable(fileInfo fs.FileInfo) bool {
 	return fileInfo.Mode().Perm()&0o111 != 0
 }
 
+// UserHomeDir on UNIX returns the value of os.UserHomeDir.
+func UserHomeDir() (string, error) {
+	return os.UserHomeDir()
+}
+
 // isPrivate returns if fileInfo is private.
 func isPrivate(fileInfo fs.FileInfo) bool {
 	return fileInfo.Mode().Perm()&0o77 == 0

diff --git a/internal/chezmoi/chezmoi_windows.go b/internal/chezmoi/chezmoi_windows.go
@@ -44,6 +44,17 @@ func IsExecutable(fileInfo fs.FileInfo) bool {
 	})
 }
 
+// UserHomeDir on Windows returns the value of $HOME if it is set and either
+// Cygwin or msys2 is detected, otherwise it falls back to os.UserHomeDir.
+func UserHomeDir() (string, error) {
+	if os.Getenv("CYGWIN") != "" || os.Getenv("MSYSTEM") != "" {
+		if userHomeDir := os.Getenv("HOME"); userHomeDir != "" {
+			return userHomeDir, nil
+		}
+	}
+	return os.UserHomeDir()
+}
+
 // isPrivate returns false on Windows.
 func isPrivate(fileInfo fs.FileInfo) bool {
 	return false

diff --git a/internal/cmd/config.go b/internal/cmd/config.go
@@ -307,7 +307,7 @@ var (
 
 // newConfig creates a new Config with the given options.
 func newConfig(options ...configOption) (*Config, error) {
-	userHomeDir, err := os.UserHomeDir()
+	userHomeDir, err := chezmoi.UserHomeDir()
 	if err != nil {
 		return nil, err
 	}

diff --git a/internal/cmd/upgradecmd_unix.go b/internal/cmd/upgradecmd_unix.go
@@ -230,7 +230,7 @@ func getUpgradeMethod(fileSystem vfs.Stater, executableAbsPath chezmoi.AbsPath)
 
 	// If the executable is in the user's home directory, then always use
 	// replace-executable.
-	switch userHomeDir, err := os.UserHomeDir(); {
+	switch userHomeDir, err := chezmoi.UserHomeDir(); {
 	case errors.Is(err, fs.ErrNotExist):
 	case err != nil:
 		return "", err

diff --git a/internal/cmd/upgradecmd_windows.go b/internal/cmd/upgradecmd_windows.go
@@ -116,7 +116,7 @@ func getUpgradeMethod(fileSystem vfs.Stater, executableAbsPath chezmoi.AbsPath)
 
 	// If the executable is in the user's home directory, then always use
 	// replace-executable.
-	switch userHomeDir, err := os.UserHomeDir(); {
+	switch userHomeDir, err := chezmoi.UserHomeDir(); {
 	case errors.Is(err, fs.ErrNotExist):
 	case err != nil:
 		return "", err