@quasar/quasar-app-extension-dotenv

Load .env variables into your quasar project

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@quasar/quasar-app-extension-dotenv
7101.1.02 years ago4 years agoMinified + gzip package size for @quasar/quasar-app-extension-dotenv in KB

Readme

Quasar App Extension dotenv
@quasar/quasar-app-extension-dotenv is an official Quasar CLI App Extension for the popular dotenv package.
@quasar/quasar-app-extension-dotenv npm
Now compatible with Quasar v2 beta
The Dotenv App Extension works only for development and production builds. If you need something less-opinionated, go to the @quasar/quasar-app-extension-qenv app extension.

Need some training using app-extension-dotenv? You can watch this video by Luke Diebold. Impressed by this video? You can also find him on twitter and github.

v1.1.0 now supports expanding environmental variables put inside your .env file!
Install
quasar ext add @quasar/dotenv
Quasar CLI will retrieve it from NPM and install the extension.

Prompts

"What is the name of your .env that you will be using for development builds?"
The default is ".env"
"What name would you like to use for your Common Root Object ('none' means to not use one)?"
The default is "none". If a value is set, this value will be appended to process.env.
E.g. If a value is set in .env (e.g. PORT). Without a Common Root Object it will be accessible through process.env.PORT. If a Common Root Object is set (e.g. MyCompany), then it will be accessible through process.env.MyCompany.PORT.
"Create your .env files for you?"
The default is "true" (yes)
If you say "yes" to this question, then your .env files will be automatically created for you.
"For security, would you like your .env files automatically added to .gitignore?"
The default is "true" (yes)
If you say "yes" to this question, then your .env files will automatically be inserted into the .gitignore.
For security purposes, because you may have sensitive data in your .env file, you should not keep it in a repository.
Note: For security reasons, you cannot console.log(process.env). Quasar does this to enhance your own security.
Accessing the Data
Any data in your specified .env file will be placed in process.env at the browser level. DO NOT console.log(process.env) as you will not see anything. For security purposes Quasar abstracts this away from prying eyes. If your env variable is PORT, then you can console.log(process.env.PORT) to see the results.
Tips
If you specified a common root object, say MyData, then the data will be placed at process.env.MyData.
Format
The format of a dotenv file is:
MY_DOTENV_TEST="This should work!"
PORT=4000
SHELL=${SHELL}
Do NOT put spaces between the equal sign.
Using Environment Variables
Environment variable are accessed like this: $MyVar or ${MyVar}. If it exists, then it will be expanded.
Here is an example of something that would be used in production:
NODE_ENV=test
BASIC=basic
BASIC_EXPAND=$BASIC
MACHINE=machine_env
MACHINE_EXPAND=$MACHINE
UNDEFINED_EXPAND=$UNDEFINED_ENV_KEY
ESCAPED_EXPAND=\$ESCAPED
MONGOLAB_DATABASE=heroku_db
MONGOLAB_USER=username
MONGOLAB_PASSWORD=password
MONGOLAB_DOMAIN=abcd1234.mongolab.com
MONGOLAB_PORT=12345
MONGOLAB_URI=mongodb://${MONGOLAB_USER}:${MONGOLAB_PASSWORD}@${MONGOLAB_DOMAIN}:${MONGOLAB_PORT}/${MONGOLAB_DATABASE}

MONGOLAB_USER_RECURSIVELY=${MONGOLAB_USER}:${MONGOLAB_PASSWORD}

MONGOLAB_URI_RECURSIVELY=mongodb://${MONGOLAB_USER_RECURSIVELY}@${MONGOLAB_DOMAIN}:${MONGOLAB_PORT}/${MONGOLAB_DATABASE}

WITHOUT_CURLY_BRACES_URI=mongodb://$MONGOLAB_USER:$MONGOLAB_PASSWORD@$MONGOLAB_DOMAIN:$MONGOLAB_PORT/$MONGOLAB_DATABASE

WITHOUT_CURLY_BRACES_USER_RECURSIVELY=$MONGOLAB_USER:$MONGOLAB_PASSWORD

WITHOUT_CURLY_BRACES_URI_RECURSIVELY=mongodb://$MONGOLAB_USER_RECURSIVELY@$MONGOLAB_DOMAIN:$MONGOLAB_PORT/$MONGOLAB_DATABASE
Uninstall
quasar ext remove @quasar/dotenv
Donate
If you appreciate the work that went into this, please consider donating to Quasar or Jeff.
License
MIT (c) Jeff Galbraith