fix update zsh issue
This commit is contained in:
parent
c79178dea0
commit
32c56e3f09
@ -39,10 +39,38 @@ If the variable isn't set, the plugin will default to use `.env`.
|
|||||||
For example, this will make the plugin look for files named `.dotenv` and load them:
|
For example, this will make the plugin look for files named `.dotenv` and load them:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### ZSH_DOTENV_PROMPT
|
||||||
|
|
||||||
|
Set `ZSH_DOTENV_PROMPT=false` in your zshrc file if you don't want the confirmation message.
|
||||||
|
You can also choose the `Always` option when prompted to always allow sourcing the .env file
|
||||||
|
in that directory. See the next section for more details.
|
||||||
|
|
||||||
|
### ZSH_DOTENV_ALLOWED_LIST, ZSH_DOTENV_DISALLOWED_LIST
|
||||||
|
|
||||||
|
The default behavior of the plugin is to always ask whether to source a dotenv file. There's
|
||||||
|
a **Y**es, **N**o, **A**lways and N**e**ver option. If you choose Always, the directory of the .env file
|
||||||
|
will be added to an allowed list; if you choose Never, it will be added to a disallowed list.
|
||||||
|
If a directory is found in either of those lists, the plugin won't ask for confirmation and will
|
||||||
|
instead either source the .env file or proceed without action respectively.
|
||||||
|
|
||||||
|
The allowed and disallowed lists are saved by default in `$ZSH_CACHE_DIR/dotenv-allowed.list` and
|
||||||
|
`$ZSH_CACHE_DIR/dotenv-disallowed.list` respectively. If you want to change that location,
|
||||||
|
change the `$ZSH_DOTENV_ALLOWED_LIST` and `$ZSH_DOTENV_DISALLOWED_LIST` variables, like so:
|
||||||
|
|
||||||
|
```zsh
|
||||||
# in ~/.zshrc, before Oh My Zsh is sourced:
|
# in ~/.zshrc, before Oh My Zsh is sourced:
|
||||||
ZSH_DOTENV_FILE=.dotenv
|
ZSH_DOTENV_ALLOWED_LIST=/path/to/dotenv/allowed/list
|
||||||
|
ZSH_DOTENV_DISALLOWED_LIST=/path/to/dotenv/disallowed/list
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The file is just a list of directories, separated by a newline character. If you want
|
||||||
|
to change your decision, just edit the file and remove the line for the directory you want to
|
||||||
|
change.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
## 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.
|
||||||
|
@ -1,5 +1,45 @@
|
|||||||
|
## Settings
|
||||||
|
|
||||||
|
# Filename of the dotenv file to look for
|
||||||
|
: ${ZSH_DOTENV_FILE:=.env}
|
||||||
|
|
||||||
|
# Path to the file containing allowed paths
|
||||||
|
: ${ZSH_DOTENV_ALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-allowed.list"}
|
||||||
|
: ${ZSH_DOTENV_DISALLOWED_LIST:="${ZSH_CACHE_DIR:-$ZSH/cache}/dotenv-disallowed.list"}
|
||||||
|
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
source_env() {
|
source_env() {
|
||||||
if [[ -f $ZSH_DOTENV_FILE ]]; then
|
if [[ -f $ZSH_DOTENV_FILE ]]; then
|
||||||
|
if [[ "$ZSH_DOTENV_PROMPT" != false ]]; then
|
||||||
|
local confirmation dirpath="${PWD:A}"
|
||||||
|
|
||||||
|
# make sure there is an (dis-)allowed file
|
||||||
|
touch "$ZSH_DOTENV_ALLOWED_LIST"
|
||||||
|
touch "$ZSH_DOTENV_DISALLOWED_LIST"
|
||||||
|
|
||||||
|
# early return if disallowed
|
||||||
|
if grep -q "$dirpath" "$ZSH_DOTENV_DISALLOWED_LIST" &>/dev/null; then
|
||||||
|
return;
|
||||||
|
fi
|
||||||
|
|
||||||
|
# check if current directory's .env file is allowed or ask for confirmation
|
||||||
|
if ! grep -q "$dirpath" "$ZSH_DOTENV_ALLOWED_LIST" &>/dev/null; then
|
||||||
|
# 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) "
|
||||||
|
read -k 1 confirmation; [[ "$confirmation" != $'\n' ]] && echo
|
||||||
|
|
||||||
|
# check input
|
||||||
|
case "$confirmation" in
|
||||||
|
[nN]) return ;;
|
||||||
|
[aA]) echo "$dirpath" >> "$ZSH_DOTENV_ALLOWED_LIST" ;;
|
||||||
|
[eE]) echo "$dirpath" >> "$ZSH_DOTENV_DISALLOWED_LIST"; return ;;
|
||||||
|
*) ;; # interpret anything else as a yes
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
# test .env syntax
|
# test .env syntax
|
||||||
zsh -fn $ZSH_DOTENV_FILE || echo "dotenv: error when sourcing '$ZSH_DOTENV_FILE' file" >&2
|
zsh -fn $ZSH_DOTENV_FILE || echo "dotenv: error when sourcing '$ZSH_DOTENV_FILE' file" >&2
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user