feat(uv-env): add plugin for Astral's uv (#13914)

* feat(uv-env): create plugin

This plugin automatically activates/deactivates a uv-managed virtual
environment when you cd into or out of a project directory. It looks
for pyproject.toml and uv.lock to detect a uv project, and reads
UV_PROJECT_ENVIRONMENT to support custom venv locations.

* fix(uv-env): address review feedback from robbyrussell

- Add `local` to venv_dir to prevent leaking into user's shell
- Replace `export` with `typeset -g` for uv_active and uv_dir
- Use `autoload -Uz` to match the style guide
This commit is contained in:
FazleArefin
2026-09-05 11:13:45 -07:00
committed by GitHub
parent 421d95782d
commit 5b5265d677
2 changed files with 36 additions and 0 deletions
+10
View File
@@ -0,0 +1,10 @@
# uv Environment Plugin
This plugin automatically activates the uv virtual environment when you cd into a project directory, and deactivates it when you cd out.
Note: Script looks for pyproject.toml and uv.lock files to determine if it's a uv project
To use it, add `uv-env` to the plugins array in your zshrc file:
```zsh
plugins=(... uv-env)
```
+26
View File
@@ -0,0 +1,26 @@
_toggleUvShell() {
local in_uv_dir=0
if [[ -f "$PWD/pyproject.toml" && -f "$PWD/uv.lock" ]]; then
in_uv_dir=1
fi
if [[ $uv_active -eq 1 ]] && { [[ $in_uv_dir -eq 0 ]] || [[ "$PWD" != "$uv_dir" && "$PWD" != "$uv_dir"/* ]]; }; then
typeset -g uv_active=0
unset uv_dir
(( $+functions[deactivate] )) && deactivate
fi
if [[ $in_uv_dir -eq 1 ]] && [[ $uv_active -ne 1 ]]; then
local venv_dir="${UV_PROJECT_ENVIRONMENT:-$PWD/.venv}"
[[ "$venv_dir" != /* ]] && venv_dir="$PWD/$venv_dir"
if [[ -f "${venv_dir}/bin/activate" ]]; then
typeset -g uv_active=1
typeset -g uv_dir="$PWD"
source "${venv_dir}/bin/activate"
fi
fi
}
autoload -Uz add-zsh-hook
add-zsh-hook chpwd _toggleUvShell
_toggleUvShell