env-deploy

Introduce

You may be coding in local, use yourself mysql , mongodb, etc. But in deploy server, the mysql,mongodb's username and password is different. Usually, username and password pass into program through environment. So, this package can auto switch env, if you have a .env file in root of project

Usage

• npm install env-deploy
• add a .env file to your project in root path, write env data use json format in it
• add .env to .gitignore file to ignore it
• coding, commit, push
• to deploy server. pull, checkout
• without .env file to run project

Yeah, you don't to change any code

Example

my project

• project
  • .env
  • index.js
  • .gitignore

.env, now only support json format. allow recursive, join with _

{
    "MONGODB": "localhost",
    "MONGO": {
        "USER": "root",
        "Port": 27017
    }
}

or

# in this format, two kind of comment is supported
# one is prefix line with `#`
// the other is prefix line with `//`
MONGODB = localhost
MONGO_USER = root
MONGO_Port = 27017

in json format, all value would be save as String even if it's a Number. Such as typeof MONGO_PORT return String.

default, all env name will be save as upper case. You can set autoTransformCase as false to turn off this.

index.js - find .env file under __dirname which pass to it. Or it's' default is process.cwd()

require('env-deploy')(__dirname);
console.log(process.env.MONGODB);
console.log(process.env.MONGO_USER);
console.log(process.env.MONGO_PORT);

.gitignore

.env

run with with .env file

localhost
root
27017

in deploy server without .env file, but have environment like MONGODB=111.111.111.111 MONGO_USER=data

111.111.111.111
data
27017

API

env_deploy

• env_deploy([file = process.pwd(),] [config])
  • file {String} filename, relative or absolute path, even directory path contains .env file
  • config {Object}
    • autoTransformCase {Boolean} true to auto transform case to upper, false to disable.

Thanks

thanks for your usage, welcome you to pull request to me.

suggest used in mac os or linux

TODO

[x] support key=value format