🐛 Respect ZDOTDIR for zsh completion install#1706
Closed
lawrence3699 wants to merge 1 commit intofastapi:masterfrom
Closed
🐛 Respect ZDOTDIR for zsh completion install#1706lawrence3699 wants to merge 1 commit intofastapi:masterfrom
lawrence3699 wants to merge 1 commit intofastapi:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes zsh completion installation so that when ZDOTDIR is set, Typer appends the initialization line to the active zsh config ($ZDOTDIR/.zshrc) instead of always writing to ~/.zshrc, addressing issue #171.
Changes:
- Add
_get_zshrc_path()to choose$ZDOTDIR/.zshrcwhenZDOTDIRexpands to an absolute path, otherwise fall back to~/.zshrc. - Update
install_zsh()to use the new zshrc path resolver. - Add a regression test validating
--install-completion zshrespectsZDOTDIR.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
typer/_completion_shared.py |
Resolve the zsh rc file path via ZDOTDIR (absolute-path cases) for zsh completion installation. |
tests/test_completion/test_completion_install.py |
Add coverage to ensure installation modifies $ZDOTDIR/.zshrc and not $HOME/.zshrc when ZDOTDIR is set. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
svlandeg
reviewed
Apr 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #171
When
ZDOTDIRis set,--install-completion zshwas still writing the init line to~/.zshrc, so the active zsh config never picked it up.This uses
ZDOTDIR/.zshrcwhenZDOTDIRresolves to an absolute path and keeps the existing fallback to~/.zshrc.Validation:
_TYPER_RUN_INSTALL_COMPLETION_TESTS=1 pytest -q tests/test_completion/test_completion_install.py -k 'completion_install_zsh'pytest -q tests/test_completion/test_completion.py -k 'completion_source_zsh'