feat: initial commit

Author: bonnel-n

Diff for: .gitignore

@@ -0,0 +1 @@
+node_modules

Diff for: LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Bonnel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Diff for: README.md

@@ -0,0 +1,34 @@
+# Node Environment Configuration
+This module provides a way to easily override parts of a JS/JSON configuration file
+with environment variables. This module uses [merge-env](https://github.com/bholloway/merge-env) and filters
+environment variables prefixed with `NEC_`.
+
+Keys which are **uppercase alpha-numeric**, with possible **underscore**, are legal environment variables per IEEE Std 1003.1-2001 Shell and Utilities volume. These keys are assumed to describe camel-case fields where single underscore implies camel-case, and double underscore implies a dot (i.e. nested object). Their value must be some non-object.
+
+For example:
+```
+NEC_FOO_BAR = 1
+NEC_BAR__BAZ = true
+```
+
+gives:
+```javascript
+{
+  fooBar: 1,
+  bar: {
+    baz: true
+  }
+}
+```
+
+## Install
+No npm build yet, reference this repository in your package.json file
+
+## Usage
+
+```
+var envConfig = require('env-config')
+var defaultConfig = require('/path/to/config.js')
+var config = envConfig(defaultConfig)
+// You can now use your config object
+```

Diff for: index.js

@@ -0,0 +1,15 @@
+const merge = require('merge-env')
+const pickBy = require('lodash.pickby')
+const mapKeys = require('lodash.mapkeys')
+
+var envVars = pickBy(process.env, function(value, key){
+  return key.startsWith('NEC_')
+});
+
+envVars = mapKeys(envVars, function(value, key){
+  return key.split('NEC_').slice(1).join('_')
+})
+
+module.exports = function(config){
+  return merge(config,envVars)
+}

Diff for: package.json

@@ -0,0 +1,16 @@
+{
+  "name": "env-config",
+  "version": "0.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "lodash.mapkeys": "^4.6.0",
+    "lodash.pickby": "^4.6.0",
+    "merge-env": "^1.0.0"
+  }
+}

Diff for: test.js

@@ -0,0 +1,13 @@
+process.env.NEC_FOO_BAR = 3
+process.env.NEC_BAR__BAZ = true
+
+var envConfig = require('./index')
+var config = envConfig({
+  fooBar: 1,
+  fooBar2: 2,
+  bar: {
+    baz: false
+  }
+})
+
+console.log(config)