Unverified Commit 634a5093 authored by Maxime Richard's avatar Maxime Richard Committed by GitHub
Browse files

dotenv: add ZSH_DOTENV_PROMPT config (#8624)

parent a6df94d2
...@@ -32,6 +32,8 @@ PORT=3001 ...@@ -32,6 +32,8 @@ PORT=3001
``` ```
You can even mix both formats, although it's probably a bad idea. You can even mix both formats, although it's probably a bad idea.
## Plugin options
### ZSH_DOTENV_FILE ### ZSH_DOTENV_FILE
You can also modify the name of the file to be loaded with the variable `ZSH_DOTENV_FILE`. You can also modify the name of the file to be loaded with the variable `ZSH_DOTENV_FILE`.
...@@ -43,6 +45,10 @@ For example, this will make the plugin look for files named `.dotenv` and load t ...@@ -43,6 +45,10 @@ For example, this will make the plugin look for files named `.dotenv` and load t
ZSH_DOTENV_FILE=.dotenv ZSH_DOTENV_FILE=.dotenv
``` ```
### ZSH_DOTENV_PROMPT
Set `ZSH_DOTENV_PROMPT=false` in your zshrc file if you don't want the confirmation message.
## 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.
......
source_env() { source_env() {
if [[ -f $ZSH_DOTENV_FILE ]]; then if [[ -f $ZSH_DOTENV_FILE ]]; then
# confirm before sourcing .env file
local confirmation if [ "$ZSH_DOTENV_PROMPT" != "false" ]; then
echo -n "dotenv: source '$ZSH_DOTENV_FILE' file in the directory? (Y/n) " # confirm before sourcing file
if read -k 1 confirmation && [[ $confirmation = [nN] ]]; then local confirmation
return echo -n "dotenv: source '$ZSH_DOTENV_FILE' file in the directory? (Y/n) "
if read -k 1 confirmation && [[ $confirmation = [nN] ]]; then
return
fi
fi fi
# test .env syntax # test .env syntax
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment