yaml-to-env

This package adds any desired YAML configuration variables to Node.js' process.env

Example

Importing

// Using Node.js `require()`
const yamlToEnv = require("yaml-to-env");

/* or */

// Using ES6 imports
import yamlToEnv from "yaml-to-env";

Usage

yamlToEnv({
  yamlPath: './app.yaml',
  exposeVariables: [
    'runtime',
    'resources.cpu',
    'env_variables.API_DB_USERNAME',
    'env_variables.API_DB_PASSWORD'
    ]
});

console.log(process.env.runtime); // ==> 'nodejs'

console.log(process.env.cpu); // ==> 1

console.log(process.env.API_DB_USERNAME); // ==> 'crazySecureDbUser'

console.log(process.env.API_DB_PASSWORD); // ==> 'crazySecureDbPass'

The example above assumed the following app.yaml file:

# app.yaml

service: prod-api
runtime: nodejs
env: flex
manual_scaling:
  instances: 1
resources:
  cpu: 1
  memory_gb: 1.5
  disk_size_gb: 10

env_variables:
  NODE_ENV: 'production'
  API_DB_USERNAME: 'crazySecureDbUser'
  API_DB_PASSWORD: 'crazySecureDbPass'
  CONTACT_EMAIL: 
    - '[email protected]'
    - '[email protected]'

Options

| Name | Required | Type | Default Value | Example | | :--- | :---: | :---: | :---: | :--- | | yamlPath | Yes | String | | "./app.yaml" | | exposeVariables | No | Array of Strings | [] | ["service", "resources.cpu"] | | verbose | No | Boolean | false | true |

Above exposeVariable array accepts dot notation paths to make it easier to access the desired properties. According to the example above ["env_variables.API_DB_PASSWORD"] will expose crazySecureDbPass via process.env.API_DB_PASSWORD. You can add as many as dot notation paths you'd like.

NOTE: If you deploy your application on services like Google App Engine, the .yaml file may no longer be available at the deployment time and a notice will be shown without impacting the functionality as the environment variables will be passed in straight from your .yaml file.