linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-19 21:41:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1 from heitorpolidoro/recursive_dotenv

Browse source 
Enable recursive .env sourcing
This commit is contained in:
Heitor Polidoro 2023-09-29 17:30:37 -03:00 committed by GitHub
commit b3a6992b42
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
plugins/dotenv/README.md
View file

@ -78,6 +78,15 @@ change.
NOTE: if a directory is found in both the allowed and disallowed lists, the disallowed list NOTE: if a directory is found in both the allowed and disallowed lists, the disallowed list
takes preference, _i.e._ the .env file will never be sourced. takes preference, _i.e._ the .env file will never be sourced.
### ZSH_DOTENV_RECURSIVE, ZSH_DOTENV_ROOT
Set `ZSH_DOTENV_RECURSIVE=true` in your zshrc file to enable recursive search for the `ZSH_DOTENV_FILE` up to
`ZSH_DOTENV_ROOT` (default `$HOME`) and source from `$ZSH_DOTENV_ROOT` to `$PWD`.
```zsh
# in ~/.zshrc, before Oh My Zsh is sourced:
ZSH_DOTENV_RECURSIVE=true
ZSH_DOTENV_ROOT=/path/to/root
```
## Version Control ## Version Control
**It's strongly recommended to add `.env` file to `.gitignore`**, because usually it contains sensitive information such as your credentials, secret keys, passwords etc. You don't want to commit this file, it's supposed to be local only. **It's strongly recommended to add `.env` file to `.gitignore`**, because usually it contains sensitive information such as your credentials, secret keys, passwords etc. You don't want to commit this file, it's supposed to be local only.

36
plugins/dotenv/dotenv.plugin.zsh
View file

@ -7,11 +7,13 @@
: ${ZSH_DOTENV_ALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-allowed.list"} : ${ZSH_DOTENV_ALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-allowed.list"}
: ${ZSH_DOTENV_DISALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-disallowed.list"} : ${ZSH_DOTENV_DISALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-disallowed.list"}
: ${ZSH_DOTENV_ROOT:=$HOME}
: ${ZSH_DOTENV_RECURSIVE:=false}
## Functions ## Functions
source_env() { source_env() {
if [[ ! -f "$ZSH_DOTENV_FILE" ]]; then base_dir=${1:=.}
if [[ ! -f "$base_dir/$ZSH_DOTENV_FILE" ]]; then
return return
fi fi
@ -37,7 +39,7 @@ source_env() {
[[ $column -eq 1 ]] || echo [[ $column -eq 1 ]] || echo
# print same-line prompt and output newline character if necessary # print same-line prompt and output newline character if necessary
echo -n "dotenv: found '$ZSH_DOTENV_FILE' file. Source it? ([Y]es/[n]o/[a]lways/n[e]ver) " echo -n "dotenv: found '$base_dir/$ZSH_DOTENV_FILE' file. Source it? ([Y]es/[n]o/[a]lways/n[e]ver) "
read -k 1 confirmation read -k 1 confirmation
[[ "$confirmation" = $'\n' ]] || echo [[ "$confirmation" = $'\n' ]] || echo
@ -52,16 +54,34 @@ source_env() {
fi fi
# test .env syntax # test .env syntax
zsh -fn $ZSH_DOTENV_FILE || { zsh -fn $base_dir/$ZSH_DOTENV_FILE || {
echo "dotenv: error when sourcing '$ZSH_DOTENV_FILE' file" >&2 echo "dotenv: error when sourcing '$base_dir/$ZSH_DOTENV_FILE' file" >&2
return 1 return 1
} }
setopt localoptions allexport setopt localoptions allexport
source $ZSH_DOTENV_FILE source $base_dir/$ZSH_DOTENV_FILE
} }
source_recursive_env() {
curr_dir=$PWD
paths_to_load=()
while [[ "$curr_dir" = "$HOME"* ]]; do
if [[ -f "$curr_dir/$ZSH_DOTENV_FILE" ]]; then
paths_to_load+=("$curr_dir")
fi
curr_dir=${curr_dir%/*}
done
for path_to_load in "${paths_to_load[@]}"; do
source_env "$path_to_load"
done
}
autoload -U add-zsh-hook autoload -U add-zsh-hook
add-zsh-hook chpwd source_env
source_env if [[ "$ZSH_DOTENV_RECURSIVE" = true ]]; then
add-zsh-hook chpwd source_recursive_env
source_recursive_env
else
add-zsh-hook chpwd source_env
source_env
fi