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

Fix dotenv plugin accepted file format and clarify README (#6093)

Browse source 
* Fix dotenv plugin accepted file format

* clarify README and add disclaimer section
This commit is contained in:
Arthur 2018-07-11 03:31:47 +06:00 committed by Marc Cornellà
parent be342b1bc8
commit 7cb5fa8aea
2 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
plugins/dotenv/README.md
View file

@ -2,19 +2,19 @@
Automatically load your project ENV variables from `.env` file when you `cd` into project root directory. Automatically load your project ENV variables from `.env` file when you `cd` into project root directory.
Storing configuration in the environment is one of the tenets of a [twelve-factor app](http://www.12factor.net). Anything that is likely to change between deployment environments–such as resource handles for databases or credentials for external services–should be extracted from the code into environment variables. Storing configuration in the environment is one of the tenets of a [twelve-factor app](http://www.12factor.net). Anything that is likely to change between deployment environments, such as resource handles for databases or credentials for external services, should be extracted from the code into environment variables.
## Installation ## Installation
Just add the plugin to your `.zshrc`: Just add the plugin to your `.zshrc`:
```sh ```sh
plugins=(git man dotenv) plugins=(... dotenv)
``` ```
## Usage ## Usage
Create `.env` file inside your project directory and put your local ENV variables there. Create `.env` file inside your project root directory and put your ENV variables there.
For example: For example:
```sh ```sh
@ -30,5 +30,16 @@ SECRET_KEY=7c6c72d959416d5aa368a409362ec6e2ac90d7f
MONGO_URI=mongodb://127.0.0.1:27017 MONGO_URI=mongodb://127.0.0.1:27017
PORT=3001 PORT=3001
``` ```
You can even mix both formats, although it's probably a bad idea.
**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 supposed to be local only. ## 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.
## Disclaimer
This plugin only sources the `.env` file. Nothing less, nothing more. It doesn't do any checks. It's designed to be the fastest and simplest option. You're responsible for the `.env` file content. You can put some code (or weird symbols) there, but do it on your own risk. `dotenv` is the basic tool, yet it does the job.
If you need more advanced and feature-rich ENV management, check out these awesome projects:
* [direnv](https://github.com/direnv/direnv)
* [zsh-autoenv](https://github.com/Tarrasch/zsh-autoenv)

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

@ -2,7 +2,13 @@
source_env() { source_env() {
if [[ -f .env ]]; then if [[ -f .env ]]; then
if [[ -o a ]]; then
source .env source .env
else
set -a
source .env
set +a
fi
fi fi
} }