Merge branch 'release/2.0.0'

Author: keithmorris

.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - "7"
   - "6.0"
   - "5.0"
   - "4.4"

README.md

@@ -89,6 +89,42 @@ Or to specify load options:
 node -r dotenv-extended/config your_script.js dotenv_config_path=./env/.env dotenv_config_defaults=./env/.env.defaults
 ```
 
+### Load Environment Variables and pass to non-NodeJS script
+
+New in 2.0.0, is a feature inspired by [cross-env](https://www.npmjs.com/package/cross-env) to allow you to load environment variables from your `.env` files and then pass them into a non-NodeJS script such as a shell script. This can simplify the process of maintaining variables used in both your Node app and other scripts. To use this command line executable, you will either need to install globally with the `-g` flag, or install `dotenv-extended` in your project and reference it from your npm scripts.
+
+Install Globally:
+
+```
+npm install -g dotenv-extended
+```
+
+Now call your shell scripts through `dotenv-extended` (this uses the defaults):
+
+```
+dotenv-extended myshellscript.sh --whatever-flags-my-script-takes
+```
+
+Configure `dotenv-extended` by passing any of the dotenv-extended options before your command. Preceed each option with two dashes `--`:
+
+```
+dotenv-extended --path=/path/to/.env --defaults=/path/to/.env.defaults --errorOnMissing=true myshellscript.sh --whatever-flags-my-script-takes
+```
+
+The following are the flags you can pass to the `dotenv-extended` cli with their default values. these options detailed later in this document:
+
+```bash
+--encoding=utf8
+--silent=true
+--path=.env
+--defaults=.env.defaults
+--schema=.env.schema
+--errorOnMissing=false     # or --error-on-missing=false
+--errorOnExtra=false       # or --error-on-extra=false
+--assignToProcessEnv=true  # or --assign-to-process-env=true
+--overrideProcessEnv=false # or --override-process-env=true
+```
+
 ## Options
 
 Defaults are shown below:

package.json

@@ -1,14 +1,15 @@
 {
   "name": "dotenv-extended",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "description": "A module for loading .env files and optionally loading defaults and a schema for validating all values are present.",
   "repository": "[email protected]:keithmorris/node-dotenv-extended.git",
   "main": "lib/index.js",
+  "bin": "lib/bin/index.js",
   "scripts": {
-    "test": "./node_modules/.bin/gulp unittest",
-    "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls",
+    "test": "gulp unittest",
+    "coveralls": "cat ./coverage/lcov.info | coveralls",
     "lint": "gulp lint",
-    "prepublish": "./node_modules/.bin/gulp build"
+    "prepublish": "gulp build"
   },
   "keywords": [
     "dotenv",
@@ -17,24 +18,26 @@
   "author": "Keith Morris <[email protected]> (http://standupbass.wordpress.com/)",
   "license": "MIT",
   "devDependencies": {
-    "babel-eslint": "^6.0.4",
+    "babel-eslint": "^7.2.3",
     "babel-plugin-transform-object-rest-spread": "^6.8.0",
     "babel-preset-es2015": "^6.5.0",
     "chai": "^3.5.0",
     "coveralls": "^2.11.6",
     "del": "^2.2.0",
     "eslint": "^3.2.2",
-    "eslint-config-standard": "^5.1.0",
-    "eslint-plugin-promise": "^2.0.0",
-    "eslint-plugin-standard": "^2.0.0",
+    "eslint-config-standard": "^10.2.1",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-node": "^4.2.2",
+    "eslint-plugin-promise": "^3.5.0",
+    "eslint-plugin-standard": "^3.0.1",
     "gulp": "^3.9.1",
     "gulp-babel": "^6.1.2",
     "gulp-eslint": "^3.0.1",
-    "gulp-istanbul": "^1.0.0",
+    "gulp-istanbul": "^1.1.1",
     "gulp-mocha": "^3.0.0",
-    "mockery": "^1.4.0",
+    "mockery": "^2.0.0",
     "run-sequence": "^1.1.5",
-    "sinon": "^1.17.3",
+    "sinon": "^2.1.0",
     "sinon-chai": "^2.8.0"
   },
   "babel": {
@@ -46,7 +49,11 @@
     ]
   },
   "dependencies": {
-    "dotenv": "^2.0.0",
+    "auto-parse": "^1.3.0",
+    "camelcase": "^4.1.0",
+    "cross-spawn": "^5.1.0",
+    "dotenv": "^4.0.0",
+    "is-windows": "^1.0.0",
     "lodash": "^4.3.0"
   }
 }

src/bin/index.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+/**
+ * Created by Keith Morris on 4/26/17.
+ *
+ * This bin script is inspired by and borrows heavily from CrossEnv
+ * https://github.com/kentcdodds/cross-env
+ */
+
+import  {config} from '..';
+import {parseCommand} from './parse-command';
+import {spawn} from 'cross-spawn';
+
+function loadAndExecute(args) {
+    const [dotEnvConfig, command, commandArgs] = parseCommand(args);
+    if (command) {
+        const proc = spawn(command, commandArgs, {
+            stdio: 'inherit',
+            shell: true,
+            env: config(dotEnvConfig),
+        });
+
+        process.on('SIGTERM', () => proc.kill('SIGTERM'));
+        process.on('SIGINT', () => proc.kill('SIGINT'));
+        process.on('SIGBREAK', () => proc.kill('SIGBREAK'));
+        process.on('SIGHUP', () => proc.kill('SIGHUP'));
+        proc.on('exit', process.exit);
+
+        return proc;
+    }
+}
+
+loadAndExecute(process.argv.slice(2));

src/bin/parse-command.js

@@ -0,0 +1,32 @@
+/**
+ * Created by Keith Morris on 4/26/17.
+ */
+import autoParse from 'auto-parse';
+import camelcase from 'camelcase';
+
+const dotEnvFlagRegex = /^--(.+)=(.+)/;
+
+/**
+ * First parses config variables for dotenv-extended then selects the next item as the command and everything after that
+ * are considered arguments for the command
+ *
+ * @param args
+ * @returns {[Object,String,Array]}
+ */
+export const parseCommand = (args) => {
+    const config = {};
+    let command = null;
+    let commandArgs = [];
+    for (let i = 0; i < args.length; i++) {
+        const match = dotEnvFlagRegex.exec(args[i]);
+        if (match) {
+            config[camelcase(match[1])] = autoParse(match[2]);
+        } else {
+            // No more env setters, the rest of the line must be the command and args
+            command = args[i];
+            commandArgs = args.slice(i + 1);
+            break;
+        }
+    }
+    return [config, command, commandArgs];
+};

test/test.spec.js

@@ -41,7 +41,7 @@ describe('dotenv-extended tests', function () {
 
     it('Should load .env file into process.env and override process.env properties with overrideProcessEnv set to true', function () {
         process.env.TEST_ONE = 'original';
-        dotenvex.load({ overrideProcessEnv: true });
+        dotenvex.load({overrideProcessEnv: true});
         expect(process.env.TEST_ONE).to.equal('overridden');
     });
 
@@ -103,7 +103,43 @@ describe('dotenv-extended tests', function () {
     });
 
     it('Should log an error when silent is set to false and .env.defaults is missing', function () {
-        dotenvex.load({ silent: false });
+        dotenvex.load({silent: false});
         expect(console.error).to.have.been.calledOnce;
     });
 });
+
+describe('CLI supporting libraries tests', function () {
+    var parseCommand = require('../lib/bin/parse-command').parseCommand;
+    var cliArgs = [
+        '--encoding=utf8',
+        '--silent=true',
+        '--path=test/.env.override',
+        '--defaults=test/.env.defaults.example',
+        '--schema=test/.env.schema.example',
+        '--error-on-missing=false',
+        '--error-on-extra=false',
+        '--assignToProcessEnv=true',
+        '--overrideProcessEnv=false',
+        'testing.sh',
+        '--jump',
+        '--dive=true',
+        'I was here'
+    ];
+
+    it('Should parse command line arguments correctly', function () {
+        var parsed = parseCommand(cliArgs);
+        expect(parsed[0]).to.eql({
+            encoding: 'utf8',
+            silent: true,
+            path: 'test/.env.override',
+            defaults: 'test/.env.defaults.example',
+            schema: 'test/.env.schema.example',
+            errorOnMissing: false,
+            errorOnExtra: false,
+            assignToProcessEnv: true,
+            overrideProcessEnv: false
+        });
+        expect(parsed[1]).to.eql('testing.sh');
+        expect(parsed[2]).to.eql(['--jump', '--dive=true', 'I was here'])
+    });
+});