@jdeighan/coffee-utils 7.0.31 → 7.0.34

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "7.0.31",
+	"version": "7.0.34",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {

package/src/coffee_utils.coffee

@@ -5,6 +5,14 @@ export sep_eq = '='.repeat(42)
 `export const undef = undefined`
 LOG = (lArgs...) -> console.log lArgs...   # synonym for console.log()
 
+export doHaltOnError = false
+
+# ---------------------------------------------------------------------------
+
+export haltOnError = () ->
+
+	doHaltOnError = true
+
 # ---------------------------------------------------------------------------
 #   pass - do nothing
 
@@ -15,16 +23,62 @@ export pass = () ->
 
 export error = (message) ->
 
+	if doHaltOnError
+		console.trace("ERROR: #{message}")
+		process.exit()
 	throw new Error(message)
 
+# ---------------------------------------------------------------------------
+
+getCallers = (stackTrace, lExclude=[]) ->
+
+	iter = stackTrace.matchAll(///
+			at
+			\s+
+			(?:
+				async
+				\s+
+				)?
+			([^\s(]+)
+			///g)
+	if !iter
+		return ["<unknown>"]
+
+	lCallers = []
+	for lMatches from iter
+		[_, caller] = lMatches
+		if (caller.indexOf('file://') == 0)
+			break
+		if caller not in lExclude
+			lCallers.push caller
+
+	return lCallers
+
 # ---------------------------------------------------------------------------
 #   assert - mimic nodejs's assert
+#   return true so we can use it in boolean expressions
 
 export assert = (cond, msg) ->
 
 	if ! cond
-		error(msg)
-	return
+		try
+			throw new Error()
+		catch e
+			stackTrace = e.stack
+		lCallers = getCallers(stackTrace, ['assert'])
+
+#		console.log 'STACK'
+#		console.log stackTrace
+		console.log '--------------------'
+		console.log 'CALL STACK:'
+		for caller in lCallers
+			console.log "   #{caller}"
+		console.log '--------------------'
+		console.log "ERROR: #{msg} (in #{lCallers[0]}())"
+		if doHaltOnError
+			process.exit()
+		error msg
+	return true
 
 # ---------------------------------------------------------------------------
 #   croak - throws an error after possibly printing useful info
@@ -85,9 +139,16 @@ export isArray = (x) ->
 
 # ---------------------------------------------------------------------------
 
-export isHash = (x) ->
+export isHash = (x, lKeys) ->
 
-	return (getClassName(x) == 'Object')
+	if ! x || (getClassName(x) != 'Object')
+		return false
+	if defined(lKeys)
+		assert isArray(lKeys), "isHash(): lKeys not an array"
+		for key in lKeys
+			if ! x.hasOwnProperty(key)
+				return false
+	return true
 
 # ---------------------------------------------------------------------------
 
@@ -383,15 +444,16 @@ export replaceVars = (line, hVars={}, rx=/__(env\.)?([A-Za-z_]\w*)__/g) ->
 
 	replacerFunc = (match, prefix, name) =>
 		if prefix
-			result = process.env[name]
-		else if ! hVars[name]?
-			result = 'undef'
+			return process.env[name]
 		else
-			result = hVars[name]
-			if ! isString(result)
-				result = JSON.stringify(result)
-		return result
-
+			value = hVars[name]
+			if defined(value)
+				if isString(value)
+					return value
+				else
+					return JSON.stringify(value)
+			else
+				return "__#{name}__"
 	return line.replace(rx, replacerFunc)
 
 # ---------------------------------------------------------------------------

package/src/coffee_utils.js

@@ -1,6 +1,7 @@
 // Generated by CoffeeScript 2.6.1
-// coffee_utils.coffee
-var LOG;
+  // coffee_utils.coffee
+var LOG, getCallers,
+  indexOf = [].indexOf;
 
 export var sep_dash = '-'.repeat(42);
 
@@ -12,6 +13,12 @@ LOG = function(...lArgs) {
   return console.log(...lArgs); // synonym for console.log()
 };
 
+export var doHaltOnError = false;
+
+// ---------------------------------------------------------------------------
+export var haltOnError = function() {
+  return doHaltOnError = true;
+};
 
 // ---------------------------------------------------------------------------
 //   pass - do nothing
@@ -20,15 +27,62 @@ export var pass = function() {};
 // ---------------------------------------------------------------------------
 //   error - throw an error
 export var error = function(message) {
+  if (doHaltOnError) {
+    console.trace(`ERROR: ${message}`);
+    process.exit();
+  }
   throw new Error(message);
 };
 
+// ---------------------------------------------------------------------------
+getCallers = function(stackTrace, lExclude = []) {
+  var _, caller, iter, lCallers, lMatches;
+  iter = stackTrace.matchAll(/at\s+(?:async\s+)?([^\s(]+)/g);
+  if (!iter) {
+    return ["<unknown>"];
+  }
+  lCallers = [];
+  for (lMatches of iter) {
+    [_, caller] = lMatches;
+    if (caller.indexOf('file://') === 0) {
+      break;
+    }
+    if (indexOf.call(lExclude, caller) < 0) {
+      lCallers.push(caller);
+    }
+  }
+  return lCallers;
+};
+
 // ---------------------------------------------------------------------------
 //   assert - mimic nodejs's assert
+//   return true so we can use it in boolean expressions
 export var assert = function(cond, msg) {
+  var caller, e, i, lCallers, len, stackTrace;
   if (!cond) {
+    try {
+      throw new Error();
+    } catch (error1) {
+      e = error1;
+      stackTrace = e.stack;
+    }
+    lCallers = getCallers(stackTrace, ['assert']);
+    //		console.log 'STACK'
+    //		console.log stackTrace
+    console.log('--------------------');
+    console.log('CALL STACK:');
+    for (i = 0, len = lCallers.length; i < len; i++) {
+      caller = lCallers[i];
+      console.log(`   ${caller}`);
+    }
+    console.log('--------------------');
+    console.log(`ERROR: ${msg} (in ${lCallers[0]}())`);
+    if (doHaltOnError) {
+      process.exit();
+    }
     error(msg);
   }
+  return true;
 };
 
 // ---------------------------------------------------------------------------
@@ -77,8 +131,21 @@ export var isArray = function(x) {
 };
 
 // ---------------------------------------------------------------------------
-export var isHash = function(x) {
-  return getClassName(x) === 'Object';
+export var isHash = function(x, lKeys) {
+  var i, key, len;
+  if (!x || (getClassName(x) !== 'Object')) {
+    return false;
+  }
+  if (defined(lKeys)) {
+    assert(isArray(lKeys), "isHash(): lKeys not an array");
+    for (i = 0, len = lKeys.length; i < len; i++) {
+      key = lKeys[i];
+      if (!x.hasOwnProperty(key)) {
+        return false;
+      }
+    }
+  }
+  return true;
 };
 
 // ---------------------------------------------------------------------------
@@ -413,18 +480,21 @@ export var replaceVars = function(line, hVars = {}, rx = /__(env\.)?([A-Za-z_]\w
   var replacerFunc;
   assert(isHash(hVars), "replaceVars() hVars is not a hash");
   replacerFunc = (match, prefix, name) => {
-    var result;
+    var value;
     if (prefix) {
-      result = process.env[name];
-    } else if (hVars[name] == null) {
-      result = 'undef';
+      return process.env[name];
     } else {
-      result = hVars[name];
-      if (!isString(result)) {
-        result = JSON.stringify(result);
+      value = hVars[name];
+      if (defined(value)) {
+        if (isString(value)) {
+          return value;
+        } else {
+          return JSON.stringify(value);
+        }
+      } else {
+        return `__${name}__`;
       }
     }
-    return result;
   };
   return line.replace(rx, replacerFunc);
 };

package/src/fs_utils.coffee

@@ -361,6 +361,7 @@ export parseSource = (source) ->
 	#        fullpath
 	#        stub
 	#        ext
+	#        purpose
 	#        }
 	# --- NOTE: source may be a file URL, e.g. import.meta.url
 
@@ -394,6 +395,13 @@ export parseSource = (source) ->
 				stub: hInfo.name
 				ext: hInfo.ext
 				}
+
+		# --- check for a 'purpose'
+		if lMatches = hSourceInfo.stub.match(///
+				\.
+				([A-Za-z_]+)
+				$///)
+			hSourceInfo.purpose = lMatches[1]
 	debug "return from parseSource()", hSourceInfo
 	return hSourceInfo
 

package/src/fs_utils.js

@@ -422,13 +422,14 @@ export var shortenPath = function(path) {
 
 // ---------------------------------------------------------------------------
 export var parseSource = function(source) {
-  var dir, hInfo, hSourceInfo;
+  var dir, hInfo, hSourceInfo, lMatches;
   // --- returns {
   //        dir
   //        filename
   //        fullpath
   //        stub
   //        ext
+  //        purpose
   //        }
   // --- NOTE: source may be a file URL, e.g. import.meta.url
   debug("enter parseSource()");
@@ -462,6 +463,10 @@ export var parseSource = function(source) {
         ext: hInfo.ext
       };
     }
+    // --- check for a 'purpose'
+    if (lMatches = hSourceInfo.stub.match(/\.([A-Za-z_]+)$/)) {
+      hSourceInfo.purpose = lMatches[1];
+    }
   }
   debug("return from parseSource()", hSourceInfo);
   return hSourceInfo;

package/src/indent_utils.coffee

@@ -1,7 +1,7 @@
 # indent_utils.coffee
 
 import {
-	assert, undef, error, escapeStr,
+	assert, undef, error, escapeStr, defined,
 	OL, isInteger, isString, isArray, isEmpty, rtrim,
 	} from '@jdeighan/coffee-utils'
 import {arrayToBlock, blockToArray} from '@jdeighan/coffee-utils/block'
@@ -68,7 +68,7 @@ export indented = (input, level=1) ->
 
 export undented = (text, level=undef) ->
 
-	if level? && (level==0)
+	if defined(level) && (level==0)
 		return text
 
 	if isString(text)
@@ -85,7 +85,7 @@ export undented = (text, level=undef) ->
 		error "undented(): Not an array or string: #{OL(text)}"
 
 	# --- determine what to remove from beginning of each line
-	if level?
+	if defined(level)
 		assert isInteger(level), "undented(): level must be an integer"
 		toRemove = indentation(level)
 	else

package/src/indent_utils.js

@@ -5,6 +5,7 @@ import {
   undef,
   error,
   escapeStr,
+  defined,
   OL,
   isInteger,
   isString,
@@ -86,7 +87,7 @@ export var indented = function(input, level = 1) {
 //            - returns same type as text, i.e. either string or array
 export var undented = function(text, level = undef) {
   var i, j, lLines, lMatches, lNewLines, len, len1, line, nToRemove, toRemove;
-  if ((level != null) && (level === 0)) {
+  if (defined(level) && (level === 0)) {
     return text;
   }
   if (isString(text)) {
@@ -107,7 +108,7 @@ export var undented = function(text, level = undef) {
     error(`undented(): Not an array or string: ${OL(text)}`);
   }
   // --- determine what to remove from beginning of each line
-  if (level != null) {
+  if (defined(level)) {
     assert(isInteger(level), "undented(): level must be an integer");
     toRemove = indentation(level);
   } else {