fix #192 fix #193

Author: bckohan

.github/workflows/test.yml

@@ -666,7 +666,7 @@ jobs:
       shell: powershell
     - name: Test CMD shell failure
       run: |
-        uv run pytest ./tests/shellcompletion/test_shell_resolution.py::test_get_win_shell_failure
+        uv run pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::test_get_win_shell_failure
       shell: cmd
     - name: Store coverage files
       uses: actions/upload-artifact@v4

doc/source/changelog.rst

@@ -7,6 +7,8 @@ Change Log
 v3.1.0 (2024-03-xx)
 ===================
 
+* Fixed `fish completion installs should respect XDG_CONFIG_HOME <https://github.com/django-commons/django-typer/issues/193>`_
+* Fixed `zsh completion installs should respect ZDOTDIR <https://github.com/django-commons/django-typer/issues/192>`_
 * Implemented `Support Django 5.2 <https://github.com/django-commons/django-typer/issues/188>`_
 * Implemented `Switch poetry -> uv <https://github.com/django-commons/django-typer/issues/185>`_
 * Implemented `Require tests to pass before release action runs. <<https://github.com/django-commons/django-typer/issues/173>`_

src/django_typer/shells/__init__.py

@@ -237,6 +237,14 @@ def uninstall(self):
         Deriving classes must implement this method to uninstall the completion script.
         """
 
+    @abstractmethod
+    def get_user_profile(self) -> Path:
+        """
+        Most shells have a profile script that is sourced when the interactive shell
+        starts. Deriving classes should implement this method to return the location
+        of that script.
+        """
+
     def process_rich_text(self, text: str) -> str:
         """
         Removes rich text markup from a string if color is disabled, otherwise it

src/django_typer/shells/bash.py

@@ -41,9 +41,15 @@ class BashComplete(DjangoTyperShellCompleter):
     by default.
     """
 
+    def get_user_profile(self) -> Path:
+        """
+        Get .bashrc it is always located in the user's home directory.
+        """
+        return Path.home() / ".bashrc"
+
     @cached_property
     def install_dir(self) -> Path:
-        install_dir = Path.home() / ".bash_completions"
+        install_dir = self.get_user_profile().parent / ".bash_completions"
         install_dir.mkdir(parents=True, exist_ok=True)
         return install_dir
 
@@ -84,7 +90,7 @@ def install(self) -> Path:
         assert self.prog_name
         Path.home().mkdir(parents=True, exist_ok=True)
         script = self.install_dir / f"{self.prog_name}.sh"
-        bashrc = Path.home() / ".bashrc"
+        bashrc = self.get_user_profile()
         bashrc_source = bashrc.read_text() if bashrc.is_file() else ""
         source_line = f"source {script}"
         if source_line not in bashrc_source:
@@ -100,7 +106,7 @@ def uninstall(self):
         if script.is_file():
             script.unlink()
 
-        bashrc = Path.home() / ".bashrc"
+        bashrc = self.get_user_profile()
         if bashrc.is_file():
             bashrc_source = bashrc.read_text()
             bashrc.write_text(bashrc_source.replace(f"source {script}\n", ""))

src/django_typer/shells/fish.py

@@ -1,3 +1,4 @@
+import os
 from functools import cached_property
 from pathlib import Path
 
@@ -36,9 +37,19 @@ class FishComplete(DjangoTyperShellCompleter):
     Fish does not support ansi control codes.
     """
 
+    def get_user_profile(self) -> Path:
+        """
+        Get the user's fish config file. It is located in the user's home directory by
+        default unless the ``XDG_CONFIG_HOME`` environment variable is set.
+        """
+        return (
+            Path(os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config"))
+            / "fish/config.fish"
+        )
+
     @cached_property
     def install_dir(self) -> Path:
-        install_dir = Path.home() / ".config/fish/completions"
+        install_dir = self.get_user_profile().parent / "completions"
         install_dir.mkdir(parents=True, exist_ok=True)
         return install_dir
 

src/django_typer/shells/zsh.py

@@ -44,12 +44,19 @@ class ZshComplete(DjangoTyperShellCompleter):
     by default.
     """
 
+    def get_user_profile(self) -> Path:
+        """
+        Get the user's .zshrc file. It is located in the user's home directory by
+        default unless the ``ZDOTDIR`` environment variable is set.
+        """
+        return Path(os.environ.get("ZDOTDIR", Path.home())) / ".zshrc"
+
     @cached_property
     def install_dir(self) -> Path:
         """
         The directory where completer scripts will be installed.
         """
-        install_dir = Path.home() / ".zfunc"
+        install_dir = self.get_user_profile().parent / ".zfunc"
         install_dir.mkdir(parents=True, exist_ok=True)
         return install_dir
 
@@ -60,7 +67,7 @@ def format_completion(self, item: CompletionItem) -> str:
     def install(self) -> Path:
         assert self.prog_name
         Path.home().mkdir(parents=True, exist_ok=True)
-        zshrc = Path.home() / ".zshrc"
+        zshrc = self.get_user_profile()
         zshrc_source = ""
         if zshrc.is_file():
             zshrc_source = zshrc.read_text()
@@ -94,7 +101,7 @@ def uninstall(self):
         if script.is_file():
             script.unlink()
 
-        zshrc = Path.home() / ".zshrc"
+        zshrc = self.get_user_profile()
         if zshrc.is_file():
             zshrc_source = zshrc.read_text()
             zshrc.write_text(