@jdeighan/env 1.1.6 → 2.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/env",
 	"type": "module",
-	"version": "1.1.6",
+	"version": "2.0.2",
 	"description": "enhanced syntax for .env files",
 	"main": "./src/EnvLoaderEx.js",
 	"exports": {
@@ -31,8 +31,8 @@
 	},
 	"homepage": "https://github.com/johndeighan/env#readme",
 	"dependencies": {
-		"@jdeighan/coffee-utils": "^1.2.20",
-		"@jdeighan/string-input": "^1.1.6",
+		"@jdeighan/coffee-utils": "^2.1.5",
+		"@jdeighan/string-input": "^3.0.3",
 		"coffeescript": "^2.5.1",
 		"cross-env": "^7.0.3"
 	}

package/src/EnvLoaderEx.coffee

@@ -4,8 +4,9 @@ import {strict as assert} from 'assert'
 import {dirname, resolve, parse as parse_fname} from 'path';
 
 import {
-	say, undef, pass, error, rtrim, isArray, isFunction, rtrunc,
+	undef, pass, error, rtrim, isArray, isFunction, rtrunc, escapeStr,
 	} from '@jdeighan/coffee-utils'
+import {log} from '@jdeighan/coffee-utils/log'
 import {debug} from '@jdeighan/coffee-utils/debug'
 import {slurp, pathTo, mkpath} from '@jdeighan/coffee-utils/fs'
 import {PLLParser} from '@jdeighan/string-input'
@@ -14,9 +15,8 @@ import {PLLParser} from '@jdeighan/string-input'
 
 export class EnvLoader extends PLLParser
 
-	constructor: (contents, @hOptions={}) ->
+	constructor: (contents, hOptions={}) ->
 		# --- Valid options:
-		#        hInitialVars - hash of initial env var values
 		#        prefix - load only vars with this prefix
 		#        stripPrefix - remove the prefix before setting vars
 		#        hCallbacks - callbacks to replace:
@@ -24,15 +24,8 @@ export class EnvLoader extends PLLParser
 
 
 		super contents
-
-		@prefix = @hOptions.prefix
-		@stripPrefix = @hOptions.stripPrefix
-
-		@hCallbacks = @hOptions.hCallbacks
+		{@prefix, @stripPrefix, @hCallbacks} = hOptions
 		@checkCallbacks()
-		if @hOptions.hInitialVars
-			for key,value of @hOptions.hInitialVars
-				@setVar key, value
 
 	# ..........................................................
 
@@ -101,15 +94,16 @@ export class EnvLoader extends PLLParser
 
 	dump: () ->
 
-		say "=== Environment Variables: ==="
+		log "=== Environment Variables: ==="
 		for name in @names()
-			say "   #{name} = '#{@getVar(name)}'"
+			log "   #{name} = '#{@getVar(name)}'"
 		return
 
 	# ..........................................................
 
-	mapString: (str) ->
+	mapNode: (str) ->
 
+		debug "enter mapNode('#{escapeStr(str)}')"
 		if lMatches = str.match(///^
 				([A-Za-z_\.]+)      # identifier
 				\s*
@@ -122,7 +116,7 @@ export class EnvLoader extends PLLParser
 				return undef
 			if @stripPrefix
 				key = key.substring(@prefix.length)
-			return {
+			result = {
 				type: 'assign',
 				key,
 				value: rtrim(value),
@@ -138,9 +132,9 @@ export class EnvLoader extends PLLParser
 				$///)
 			[_, neg, key] = lMatches
 			if neg
-				return {type: 'if_falsy', key}
+				result = {type: 'if_falsy', key}
 			else
-				return {type: 'if_truthy', key}
+				result = {type: 'if_truthy', key}
 		else if lMatches = str.match(///^
 				if
 				\s+
@@ -158,9 +152,16 @@ export class EnvLoader extends PLLParser
 				(.*)
 				$///)
 			[_, key, op, value] = lMatches
-			return {type: 'compare', key, op, value: value.trim()}
+			result = {
+				type: 'compare',
+				key,
+				op,
+				value: value.trim(),
+				}
 		else
 			error "Invalid line: '#{str}'"
+		debug "return from mapNode():", result
+		return result
 
 	# ..........................................................
 
@@ -197,7 +198,6 @@ export class EnvLoader extends PLLParser
 	procEnv: (tree) ->
 
 		debug "enter procEnv()"
-		debug tree, "TREE:"
 
 		for h in tree
 			switch h.node.type
@@ -244,6 +244,7 @@ export class EnvLoader extends PLLParser
 
 		debug "enter load()"
 		tree = @getTree()
+		debug "TREE", tree
 		assert tree?, "load(): tree is undef"
 		assert isArray(tree), "load(): tree is not an array"
 		@procEnv tree
@@ -252,11 +253,11 @@ export class EnvLoader extends PLLParser
 
 # ---------------------------------------------------------------------------
 # ---------------------------------------------------------------------------
-# Load environment from a string
+# Load environment from a file
 
 export loadEnvFile = (filepath, hOptions={}) ->
 
-	debug "LOAD #{filepath}"
+	debug "LOADENV #{filepath}"
 	return loadEnvString slurp(filepath), hOptions
 
 # ---------------------------------------------------------------------------
@@ -273,35 +274,19 @@ export loadEnvString = (contents, hOptions={}) ->
 # ---------------------------------------------------------------------------
 # Load environment from .env file
 
-export loadEnvFrom = (searchDir, hOptions={}) ->
-	# --- Valid options:
-	#     hInitialVars - set these env vars first
-	#     recurse - load all .env files found by searching up
-	#     rootName - env var name of first .env file found
-	#     any option accepted by EnvLoader
-	#        hInitialVars - hash of initial env var values
-	#        prefix - load only vars with this prefix
-	#        stripPrefix - remove the prefix before setting vars
-	#        hCallbacks - callbacks to replace:
-	#                     getVar, setVar, clearVar, clearAll, names
-
-	debug "enter loadEnvFrom('#{searchDir}')"
-	{rootName, hInitialVars, recurse} = hOptions
+export loadEnvFrom = (searchDir, rootName='DIR_ROOT', hOptions={}) ->
+
+	debug "enter loadEnvFrom('#{searchDir}', rootName=#{rootName})"
 	path = pathTo('.env', searchDir, "up")
 	if not path?
-		return undef
+		return
 	if rootName
-		if not hInitialVars
-			hInitialVars = hOptions.hInitialVars = {}
-		hInitialVars[rootName] = mkpath(rtrunc(path, 5))
-
-	if recurse
-		lPaths = [path]
-		while path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")
-			lPaths.unshift path
-		for path in lPaths
-			env = loadEnvFile path, hOptions
-	else
+		process.env[rootName] = mkpath(rtrunc(path, 5))
+
+	lPaths = [path]
+	while path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")
+		lPaths.unshift path
+	for path in lPaths
 		env = loadEnvFile path, hOptions
 	debug "return from loadEnvFrom()"
 	return env

package/src/EnvLoaderEx.js

@@ -11,16 +11,20 @@ import {
 } from 'path';
 
 import {
-  say,
   undef,
   pass,
   error,
   rtrim,
   isArray,
   isFunction,
-  rtrunc
+  rtrunc,
+  escapeStr
 } from '@jdeighan/coffee-utils';
 
+import {
+  log
+} from '@jdeighan/coffee-utils/log';
+
 import {
   debug
 } from '@jdeighan/coffee-utils/debug';
@@ -37,21 +41,15 @@ import {
 
 // ---------------------------------------------------------------------------
 export var EnvLoader = class EnvLoader extends PLLParser {
-  constructor(contents, hOptions1 = {}) {
-    var key, ref, value;
+  constructor(contents, hOptions = {}) {
+    // --- Valid options:
+    //        prefix - load only vars with this prefix
+    //        stripPrefix - remove the prefix before setting vars
+    //        hCallbacks - callbacks to replace:
+    //                     getVar, setVar, clearVar, clearAll, names
     super(contents);
-    this.hOptions = hOptions1;
-    this.prefix = this.hOptions.prefix;
-    this.stripPrefix = this.hOptions.stripPrefix;
-    this.hCallbacks = this.hOptions.hCallbacks;
+    ({prefix: this.prefix, stripPrefix: this.stripPrefix, hCallbacks: this.hCallbacks} = hOptions);
     this.checkCallbacks();
-    if (this.hOptions.hInitialVars) {
-      ref = this.hOptions.hInitialVars;
-      for (key in ref) {
-        value = ref[key];
-        this.setVar(key, value);
-      }
-    }
   }
 
   // ..........................................................
@@ -120,17 +118,18 @@ export var EnvLoader = class EnvLoader extends PLLParser {
   // ..........................................................
   dump() {
     var i, len, name, ref;
-    say("=== Environment Variables: ===");
+    log("=== Environment Variables: ===");
     ref = this.names();
     for (i = 0, len = ref.length; i < len; i++) {
       name = ref[i];
-      say(`   ${name} = '${this.getVar(name)}'`);
+      log(`   ${name} = '${this.getVar(name)}'`);
     }
   }
 
   // ..........................................................
-  mapString(str) {
-    var _, key, lMatches, neg, op, value;
+  mapNode(str) {
+    var _, key, lMatches, neg, op, result, value;
+    debug(`enter mapNode('${escapeStr(str)}')`);
     if (lMatches = str.match(/^([A-Za-z_\.]+)\s*=\s*(.*)$/)) { // identifier
       [_, key, value] = lMatches;
       if (this.prefix && (key.indexOf(this.prefix) !== 0)) {
@@ -139,7 +138,7 @@ export var EnvLoader = class EnvLoader extends PLLParser {
       if (this.stripPrefix) {
         key = key.substring(this.prefix.length);
       }
-      return {
+      result = {
         type: 'assign',
         key,
         value: rtrim(value)
@@ -147,12 +146,12 @@ export var EnvLoader = class EnvLoader extends PLLParser {
     } else if (lMatches = str.match(/^if\s+(?:(not)\s+)?([A-Za-z_]+)$/)) { // identifier
       [_, neg, key] = lMatches;
       if (neg) {
-        return {
+        result = {
           type: 'if_falsy',
           key
         };
       } else {
-        return {
+        result = {
           type: 'if_truthy',
           key
         };
@@ -160,15 +159,17 @@ export var EnvLoader = class EnvLoader extends PLLParser {
     } else if (lMatches = str.match(/^if\s+([A-Za-z_][A-Za-z0-9_]*)\s*(is|isnt|>|>=|<|<=)\s*(.*)$/)) { // identifier (key)
       // comparison operator
       [_, key, op, value] = lMatches;
-      return {
+      result = {
         type: 'compare',
         key,
         op,
         value: value.trim()
       };
     } else {
-      return error(`Invalid line: '${str}'`);
+      error(`Invalid line: '${str}'`);
     }
+    debug("return from mapNode():", result);
+    return result;
   }
 
   // ..........................................................
@@ -207,7 +208,6 @@ export var EnvLoader = class EnvLoader extends PLLParser {
   procEnv(tree) {
     var h, i, key, len, op, value;
     debug("enter procEnv()");
-    debug(tree, "TREE:");
     for (i = 0, len = tree.length; i < len; i++) {
       h = tree[i];
       switch (h.node.type) {
@@ -256,6 +256,7 @@ export var EnvLoader = class EnvLoader extends PLLParser {
     var tree;
     debug("enter load()");
     tree = this.getTree();
+    debug("TREE", tree);
     assert(tree != null, "load(): tree is undef");
     assert(isArray(tree), "load(): tree is not an array");
     this.procEnv(tree);
@@ -266,9 +267,9 @@ export var EnvLoader = class EnvLoader extends PLLParser {
 
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
-// Load environment from a string
+// Load environment from a file
 export var loadEnvFile = function(filepath, hOptions = {}) {
-  debug(`LOAD ${filepath}`);
+  debug(`LOADENV ${filepath}`);
   return loadEnvString(slurp(filepath), hOptions);
 };
 
@@ -285,40 +286,22 @@ export var loadEnvString = function(contents, hOptions = {}) {
 
 // ---------------------------------------------------------------------------
 // Load environment from .env file
-export var loadEnvFrom = function(searchDir, hOptions = {}) {
-  var env, hInitialVars, i, lPaths, len, path, recurse, rootName;
-  // --- Valid options:
-  //     hInitialVars - set these env vars first
-  //     recurse - load all .env files found by searching up
-  //     rootName - env var name of first .env file found
-  //     any option accepted by EnvLoader
-  //        hInitialVars - hash of initial env var values
-  //        prefix - load only vars with this prefix
-  //        stripPrefix - remove the prefix before setting vars
-  //        hCallbacks - callbacks to replace:
-  //                     getVar, setVar, clearVar, clearAll, names
-  debug(`enter loadEnvFrom('${searchDir}')`);
-  ({rootName, hInitialVars, recurse} = hOptions);
+export var loadEnvFrom = function(searchDir, rootName = 'DIR_ROOT', hOptions = {}) {
+  var env, i, lPaths, len, path;
+  debug(`enter loadEnvFrom('${searchDir}', rootName=${rootName})`);
   path = pathTo('.env', searchDir, "up");
   if (path == null) {
-    return undef;
+    return;
   }
   if (rootName) {
-    if (!hInitialVars) {
-      hInitialVars = hOptions.hInitialVars = {};
-    }
-    hInitialVars[rootName] = mkpath(rtrunc(path, 5));
+    process.env[rootName] = mkpath(rtrunc(path, 5));
   }
-  if (recurse) {
-    lPaths = [path];
-    while (path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")) {
-      lPaths.unshift(path);
-    }
-    for (i = 0, len = lPaths.length; i < len; i++) {
-      path = lPaths[i];
-      env = loadEnvFile(path, hOptions);
-    }
-  } else {
+  lPaths = [path];
+  while (path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")) {
+    lPaths.unshift(path);
+  }
+  for (i = 0, len = lPaths.length; i < len; i++) {
+    path = lPaths[i];
     env = loadEnvFile(path, hOptions);
   }
   debug("return from loadEnvFrom()");