@jdeighan/env 5.1.10 → 6.0.0

package/package.json

@@ -1,12 +1,11 @@
 {
 	"name": "@jdeighan/env",
 	"type": "module",
-	"version": "5.1.10",
+	"version": "6.0.0",
 	"description": "enhanced syntax for .env files",
 	"main": "./src/EnvLoaderEx.js",
 	"exports": {
-		".": "./src/EnvLoaderEx.js",
-		"./lib": "./src/EnvLib.js"
+		".": "./src/EnvLoaderEx.js"
 	},
 	"engines": {
 		"node": ">=12.0.0"
@@ -32,8 +31,8 @@
 	},
 	"homepage": "https://github.com/johndeighan/env#readme",
 	"dependencies": {
-		"@jdeighan/coffee-utils": "^3.0.7",
-		"@jdeighan/string-input": "^6.0.6",
+		"@jdeighan/coffee-utils": "^4.0.0",
+		"@jdeighan/string-input": "^7.0.0",
 		"coffeescript": "^2.6.1",
 		"cross-env": "^7.0.3"
 	}

package/src/EnvLoaderEx.coffee

@@ -9,8 +9,24 @@ import {
 import {log} from '@jdeighan/coffee-utils/log'
 import {debug} from '@jdeighan/coffee-utils/debug'
 import {slurp, pathTo, mkpath} from '@jdeighan/coffee-utils/fs'
+import {hPrivEnv, hPrivEnvCallbacks} from '@jdeighan/coffee-utils/privenv'
 import {PLLParser} from '@jdeighan/string-input'
 
+hDefCallbacks = {
+	getVar: (name) ->
+		return process.env[name]
+	setVar: (name, value) ->
+		process.env[name] = value
+		return
+	clearVar: (name) ->
+		delete process.env[name]
+		return
+	clearAll: () ->
+		process.env ={}
+	names: () ->
+		return Object.keys(process.env)
+	}
+
 # ---------------------------------------------------------------------------
 
 export class EnvLoader extends PLLParser
@@ -25,7 +41,10 @@ export class EnvLoader extends PLLParser
 
 		super contents
 		{@prefix, @stripPrefix, @hCallbacks} = hOptions
-		@checkCallbacks()
+		if @hCallbacks?
+			@checkCallbacks()
+		else
+			@hCallbacks = hDefCallbacks
 
 	# ..........................................................
 
@@ -44,51 +63,34 @@ export class EnvLoader extends PLLParser
 
 	getVar: (name) ->
 
-		if @hCallbacks
-			return @hCallbacks.getVar(name)
-		else
-			return process.env[name]
-		return
+		return @hCallbacks.getVar(name)
 
 	# ..........................................................
 
 	setVar: (name, value) ->
 
-		if @hCallbacks
-			@hCallbacks.setVar name, value
-		else
-			process.env[name] = value
+		@hCallbacks.setVar name, value
 		return
 
 	# ..........................................................
 
 	clearVar: (name) ->
 
-		if @hCallbacks
-			@hCallbacks.clearVar name
-		else
-			delete process.env[name]
+		@hCallbacks.clearVar name
 		return
 
 	# ..........................................................
 
 	clearAll: () ->
 
-		if @hCallbacks
-			@hCallbacks.clearAll
-		else
-			process.env = {}
+		@hCallbacks.clearAll
 		return
 
 	# ..........................................................
 
 	names: () ->
 
-		if @hCallbacks
-			return @hCallbacks.names()
-		else
-			return Object.keys(process.env)
-		return
+		return @hCallbacks.names()
 
 	# ..........................................................
 
@@ -252,14 +254,6 @@ export class EnvLoader extends PLLParser
 		return
 
 # ---------------------------------------------------------------------------
-# ---------------------------------------------------------------------------
-# Load environment from a file
-
-export loadEnvFile = (filepath, hOptions={}) ->
-
-	debug "LOADENV #{filepath}"
-	return loadEnvString slurp(filepath), hOptions
-
 # ---------------------------------------------------------------------------
 # Load environment from a string
 
@@ -269,7 +263,16 @@ export loadEnvString = (contents, hOptions={}) ->
 	env = new EnvLoader(contents, hOptions)
 	env.load()
 	debug "return from loadEnvString()"
-	return env
+	return
+
+# ---------------------------------------------------------------------------
+# Load environment from a file
+
+export loadEnvFile = (filepath, hOptions={}) ->
+
+	debug "LOADENV #{filepath}"
+	loadEnvString slurp(filepath), hOptions
+	return
 
 # ---------------------------------------------------------------------------
 # Load environment from .env file
@@ -277,6 +280,7 @@ export loadEnvString = (contents, hOptions={}) ->
 export loadEnvFrom = (searchDir, rootName='DIR_ROOT', hOptions={}) ->
 	# --- valid options:
 	#        onefile - load only the first file found
+	#        hCallbacks - getVar, setVar, clearVar, clearAll, names
 
 	debug "enter loadEnvFrom('#{searchDir}', rootName=#{rootName})"
 	path = pathTo('.env', searchDir, "up")
@@ -284,22 +288,40 @@ export loadEnvFrom = (searchDir, rootName='DIR_ROOT', hOptions={}) ->
 		debug "return from loadEnvFrom() - no .env file found"
 		return
 	debug "found .env file: #{path}"
-	lPaths = [path]
 
 	# --- Don't set root directory if it's already defined
 	if rootName && not process.env[rootName]
 		root = mkpath(rtrunc(path, 5))
 		debug "set env var #{rootName} to #{root}"
-		process.env[rootName] = root
+		if hOptions.hCallbacks
+			hOptions.hCallbacks.setVar(rootName, root)
+		else
+			hDefCallbacks.setVar(rootName, root)
 
+	lPaths = [path]    # --- build an array of paths
 	if not hOptions.onefile
 		# --- search upward for .env files, but process top down
 		while path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")
 			debug "found .env file: #{path}"
 			lPaths.unshift path
 
-	hEnv = {}
 	for path in lPaths
-		hEnv = Object.assign(hEnv, loadEnvFile(path, hOptions))
+		loadEnvFile(path, hOptions)
 	debug "return from loadEnvFrom()"
-	return hEnv
+	return
+
+# ---------------------------------------------------------------------------
+# Instead of loading into process.env,
+# this loads into hPrivEnv from '@jdeighan/coffee-utils/privenv'
+
+export loadPrivEnvFrom = (searchDir, rootName='DIR_ROOT', hInit=undef) ->
+
+	hPrivEnvCallbacks.clearAll()
+
+	# --- Load any vars found in hInit
+	if hInit?
+		for name,value of hInit
+			hPrivEnvCallbacks.setVar name, value
+
+	loadEnvFrom(searchDir, rootName, {hCallbacks: hPrivEnvCallbacks})
+	return

package/src/EnvLoaderEx.js

@@ -1,5 +1,7 @@
 // Generated by CoffeeScript 2.6.1
-  // EnvLoaderEx.coffee
+// EnvLoaderEx.coffee
+var hDefCallbacks;
+
 import {
   strict as assert
 } from 'assert';
@@ -35,10 +37,33 @@ import {
   mkpath
 } from '@jdeighan/coffee-utils/fs';
 
+import {
+  hPrivEnv,
+  hPrivEnvCallbacks
+} from '@jdeighan/coffee-utils/privenv';
+
 import {
   PLLParser
 } from '@jdeighan/string-input';
 
+hDefCallbacks = {
+  getVar: function(name) {
+    return process.env[name];
+  },
+  setVar: function(name, value) {
+    process.env[name] = value;
+  },
+  clearVar: function(name) {
+    delete process.env[name];
+  },
+  clearAll: function() {
+    return process.env = {};
+  },
+  names: function() {
+    return Object.keys(process.env);
+  }
+};
+
 // ---------------------------------------------------------------------------
 export var EnvLoader = class EnvLoader extends PLLParser {
   constructor(contents, hOptions = {}) {
@@ -49,7 +74,11 @@ export var EnvLoader = class EnvLoader extends PLLParser {
     //                     getVar, setVar, clearVar, clearAll, names
     super(contents);
     ({prefix: this.prefix, stripPrefix: this.stripPrefix, hCallbacks: this.hCallbacks} = hOptions);
-    this.checkCallbacks();
+    if (this.hCallbacks != null) {
+      this.checkCallbacks();
+    } else {
+      this.hCallbacks = hDefCallbacks;
+    }
   }
 
   // ..........................................................
@@ -72,47 +101,27 @@ export var EnvLoader = class EnvLoader extends PLLParser {
 
   // ..........................................................
   getVar(name) {
-    if (this.hCallbacks) {
-      return this.hCallbacks.getVar(name);
-    } else {
-      return process.env[name];
-    }
+    return this.hCallbacks.getVar(name);
   }
 
   // ..........................................................
   setVar(name, value) {
-    if (this.hCallbacks) {
-      this.hCallbacks.setVar(name, value);
-    } else {
-      process.env[name] = value;
-    }
+    this.hCallbacks.setVar(name, value);
   }
 
   // ..........................................................
   clearVar(name) {
-    if (this.hCallbacks) {
-      this.hCallbacks.clearVar(name);
-    } else {
-      delete process.env[name];
-    }
+    this.hCallbacks.clearVar(name);
   }
 
   // ..........................................................
   clearAll() {
-    if (this.hCallbacks) {
-      this.hCallbacks.clearAll;
-    } else {
-      process.env = {};
-    }
+    this.hCallbacks.clearAll;
   }
 
   // ..........................................................
   names() {
-    if (this.hCallbacks) {
-      return this.hCallbacks.names();
-    } else {
-      return Object.keys(process.env);
-    }
+    return this.hCallbacks.names();
   }
 
   // ..........................................................
@@ -266,13 +275,6 @@ export var EnvLoader = class EnvLoader extends PLLParser {
 };
 
 // ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
-// Load environment from a file
-export var loadEnvFile = function(filepath, hOptions = {}) {
-  debug(`LOADENV ${filepath}`);
-  return loadEnvString(slurp(filepath), hOptions);
-};
-
 // ---------------------------------------------------------------------------
 // Load environment from a string
 export var loadEnvString = function(contents, hOptions = {}) {
@@ -281,15 +283,22 @@ export var loadEnvString = function(contents, hOptions = {}) {
   env = new EnvLoader(contents, hOptions);
   env.load();
   debug("return from loadEnvString()");
-  return env;
+};
+
+// ---------------------------------------------------------------------------
+// Load environment from a file
+export var loadEnvFile = function(filepath, hOptions = {}) {
+  debug(`LOADENV ${filepath}`);
+  loadEnvString(slurp(filepath), hOptions);
 };
 
 // ---------------------------------------------------------------------------
 // Load environment from .env file
 export var loadEnvFrom = function(searchDir, rootName = 'DIR_ROOT', hOptions = {}) {
-  var hEnv, i, lPaths, len, path, root;
+  var i, lPaths, len, path, root;
   // --- valid options:
   //        onefile - load only the first file found
+  //        hCallbacks - getVar, setVar, clearVar, clearAll, names
   debug(`enter loadEnvFrom('${searchDir}', rootName=${rootName})`);
   path = pathTo('.env', searchDir, "up");
   if (path == null) {
@@ -297,13 +306,17 @@ export var loadEnvFrom = function(searchDir, rootName = 'DIR_ROOT', hOptions = {
     return;
   }
   debug(`found .env file: ${path}`);
-  lPaths = [path];
   // --- Don't set root directory if it's already defined
   if (rootName && !process.env[rootName]) {
     root = mkpath(rtrunc(path, 5));
     debug(`set env var ${rootName} to ${root}`);
-    process.env[rootName] = root;
+    if (hOptions.hCallbacks) {
+      hOptions.hCallbacks.setVar(rootName, root);
+    } else {
+      hDefCallbacks.setVar(rootName, root);
+    }
   }
+  lPaths = [path]; // --- build an array of paths
   if (!hOptions.onefile) {
     // --- search upward for .env files, but process top down
     while (path = pathTo('.env', resolve(rtrunc(path, 5), '..'), "up")) {
@@ -311,11 +324,27 @@ export var loadEnvFrom = function(searchDir, rootName = 'DIR_ROOT', hOptions = {
       lPaths.unshift(path);
     }
   }
-  hEnv = {};
   for (i = 0, len = lPaths.length; i < len; i++) {
     path = lPaths[i];
-    hEnv = Object.assign(hEnv, loadEnvFile(path, hOptions));
+    loadEnvFile(path, hOptions);
   }
   debug("return from loadEnvFrom()");
-  return hEnv;
+};
+
+// ---------------------------------------------------------------------------
+// Instead of loading into process.env,
+// this loads into hPrivEnv from '@jdeighan/coffee-utils/privenv'
+export var loadPrivEnvFrom = function(searchDir, rootName = 'DIR_ROOT', hInit = undef) {
+  var name, value;
+  hPrivEnvCallbacks.clearAll();
+  // --- Load any vars found in hInit
+  if (hInit != null) {
+    for (name in hInit) {
+      value = hInit[name];
+      hPrivEnvCallbacks.setVar(name, value);
+    }
+  }
+  loadEnvFrom(searchDir, rootName, {
+    hCallbacks: hPrivEnvCallbacks
+  });
 };

package/src/EnvLib.coffee

@@ -1,41 +0,0 @@
-# EnvLib.coffee
-
-import {strict as assert} from 'assert'
-
-import {undef} from '@jdeighan/coffee-utils'
-import {log} from '@jdeighan/coffee-utils/log'
-import {mkpath, slurp} from '@jdeighan/coffee-utils/fs'
-import {loadEnvFrom} from '@jdeighan/env'
-
-#     NOTE: use by:
-#              1. call loadEnvLibFrom()
-#              2. import hEnv and use directly
-#     NOTE: keys are case sensitive
-export hEnv = {}
-
-# ---------------------------------------------------------------------------
-# Define custom callbacks to use with loadEnvFrom
-
-hCallbacks = {
-	getVar:   (name) ->
-		return hEnv[name]
-	setVar:   (name, value) ->
-		hEnv[name] = value
-		return
-	clearVar: (name) ->
-		delete hEnv[name]
-		return
-	clearAll: () ->
-		hEnv = {}
-		return
-	names:    () ->
-		return Object.keys(hEnv)
-	}
-
-# ---------------------------------------------------------------------------
-
-export loadEnvLibFrom = (searchDir, rootName='DIR_ROOT', hInit={}) ->
-
-	hEnv = hInit    # reset, if there's been a previous call
-	loadEnvFrom(searchDir, rootName, {hCallbacks})
-	return hEnv

package/src/EnvLib.js

@@ -1,57 +0,0 @@
-// Generated by CoffeeScript 2.6.1
-// EnvLib.coffee
-var hCallbacks;
-
-import {
-  strict as assert
-} from 'assert';
-
-import {
-  undef
-} from '@jdeighan/coffee-utils';
-
-import {
-  log
-} from '@jdeighan/coffee-utils/log';
-
-import {
-  mkpath,
-  slurp
-} from '@jdeighan/coffee-utils/fs';
-
-import {
-  loadEnvFrom
-} from '@jdeighan/env';
-
-//     NOTE: use by:
-//              1. call loadEnvLibFrom()
-//              2. import hEnv and use directly
-//     NOTE: keys are case sensitive
-export var hEnv = {};
-
-// ---------------------------------------------------------------------------
-// Define custom callbacks to use with loadEnvFrom
-hCallbacks = {
-  getVar: function(name) {
-    return hEnv[name];
-  },
-  setVar: function(name, value) {
-    hEnv[name] = value;
-  },
-  clearVar: function(name) {
-    delete hEnv[name];
-  },
-  clearAll: function() {
-    hEnv = {};
-  },
-  names: function() {
-    return Object.keys(hEnv);
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var loadEnvLibFrom = function(searchDir, rootName = 'DIR_ROOT', hInit = {}) {
-  hEnv = hInit; // reset, if there's been a previous call
-  loadEnvFrom(searchDir, rootName, {hCallbacks});
-  return hEnv;
-};