fix: respect ZDOTDIR env var for zsh completion install#1733
Closed
zons-zhaozhy wants to merge 1 commit into
Closed
fix: respect ZDOTDIR env var for zsh completion install#1733zons-zhaozhy wants to merge 1 commit into
zons-zhaozhy wants to merge 1 commit into
Conversation
Zsh uses $ZDOTDIR/.zshrc instead of $HOME/.zshrc when ZDOTDIR is set. The install_zsh function was always writing to $HOME/.zshrc, ignoring the ZDOTDIR environment variable. Fixes fastapi#171
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
4 participants
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.
Summary
Respect the
ZDOTDIRenvironment variable when installing zsh completion.Problem
When running
--install-completion zsh, Typer always writes to$HOME/.zshrc. However, zsh supports theZDOTDIRenvironment variable to override the directory where.zshrclives. Users who setZDOTDIR(e.g.,export ZDOTDIR=~/.config/zsh) have their completion installed to the wrong file.Fix
In
install_zsh(), checkos.environ.get("ZDOTDIR")and use it as the base directory for.zshrcinstead of always using$HOME. Falls back to$HOMEwhenZDOTDIRis not set.Type of Change
Fixes #171