cfg-manager - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

 'use strict';
 
+var objectAssign = require('object-assign');
+
 module.exports = {
@@ -25,11 +27,12 @@
    */
-  init: function(defaultConfig, options = {}) {
-    let prefix = options.prefix || this.prefix;
-    let config = Object.assign({}, defaultConfig || {});
-    let env = process.env;
+  init: function(defaultConfig, options) {
+    options = options || {};
+    var prefix = options.prefix || this.prefix;
+    var config = objectAssign({}, defaultConfig || {});
+    var env = process.env;
 
-    for (let key in env) {
-      let realKey = key.substr(prefix.length);
+    for (var key in env) {
+      var realKey = key.substr(prefix.length);
       if (key.indexOf(prefix) === 0 && config[realKey] !== undefined) {
-        let value = env[key];
+        var value = env[key];
         // Convert string into number if it's a number
@@ -36,0 +39,0 @@ config[realKey] = this._isNumeric(value) ? parseFloat(value) : value;

package.json

 {
   "name": "cfg-manager",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Ricky Chien <[e-mail]>",
@@ -15,4 +15,6 @@ "description": "Managing config and environment variables",
   "readme": "README.md",
+  "dependencies": {
+    "object-assign": "^3.0.0"
+  },
   "devDependencies": {
-    "babel": "^5.6.23",
     "mocha": "^2.2.5"
@@ -19,0 +21,0 @@ },

README.md

@@ -19,9 +19,13 @@ # Cfg-manager
 
-The cfg-manager can treat user input parameters as ENVs and merge it with a given default configuration.
+The cfg-manager can treat user input parameters as ENVs and merge it with a given default configuration. Easily access config from modules by parsing pre-stored environment variable.
 
 ### Example
 
+You can simply initialize config from an entry module and access it from sub-modules without re-initializing again.
 Initialize and generate merged config which is also stored in environment varialbe with the name CONFIG_MANAGER_ENVS.
 
+In entry.js, simply use:
+
 ```javascript
+var subModule = require('sub-modules');
 var cfgManager = require('cfg-manager');
@@ -34,4 +38,6 @@
 
-Get config once you already init / store your config as an environment variable
+Simply access config with getConfig() once you already init() in your config from entry module.
 
+In sub-modules.js:
+
 ```javascript
@@ -42,2 +48,24 @@ var cfgManager = require('cfg-manager');
 
+### APIs
+
+#### init(defaultConfig, [options])
+
+Initialize config object by merging given confg object and given environment variables.
+
+options: ```Object```
+
+return: ```Object```
+
+##### options.prefix
+
+Environment variable prefix. Cfg-manager only parse environment variables if they begin with given prefix.
+
+type: ```string```
+
+default: ```'APP_'```
+
+#### getConfig()
+
+Return config object directly if config has been initialized and existed in environment variable CONFIG_MANAGER_ENVS.
+
 ## Development
@@ -44,0 +72,0 @@

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5438

increased by19.49%

Dev dependency count

1

decreased by-50%

Lines of code

96

increased by2.13%

Number of lines in readme file

75

increased by59.57%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of low supply chain risk alerts

3

increased by200%

Dependency changes

• + Addedobject-assign@^3.0.0

• + Addedobject-assign@3.0.0(transitive)