@jdeighan/coffee-utils 7.0.49 → 7.0.50

package/package.json

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

package/src/call_stack.coffee

@@ -1,6 +1,8 @@
 # call_stack.coffee
 
-import {undef, croak, assert} from '@jdeighan/coffee-utils'
+import {
+	undef, defined, croak, assert, isBoolean,
+	} from '@jdeighan/coffee-utils'
 import {log, LOG} from '@jdeighan/coffee-utils/log'
 import {getPrefix} from '@jdeighan/coffee-utils/arrow'
 
@@ -64,9 +66,9 @@ export class CallStack
 	# ........................................................................
 	# ........................................................................
 
-	call: (funcName, hInfo, isLogged=undef) ->
+	doCall: (funcName, hInfo, isLogged) ->
 
-		assert isLogged != undef, "CallStack.call(): 3 args required"
+		assert isBoolean(isLogged), "CallStack.call(): 3 args required"
 		mainPre = getPrefix(@level)
 
 		if doDebugStack
@@ -75,7 +77,7 @@ export class CallStack
 
 		@addCall funcName, hInfo, isLogged
 		auxPre = getPrefix(@level)
-		return [mainPre, auxPre, undef]
+		return [mainPre, auxPre]
 
 	# ........................................................................
 

package/src/call_stack.js

@@ -4,8 +4,10 @@ var doDebugStack;
 
 import {
   undef,
+  defined,
   croak,
-  assert
+  assert,
+  isBoolean
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -72,9 +74,9 @@ export var CallStack = class CallStack {
 
   // ........................................................................
   // ........................................................................
-  call(funcName, hInfo, isLogged = undef) {
+  doCall(funcName, hInfo, isLogged) {
     var auxPre, mainPre, prefix;
-    assert(isLogged !== undef, "CallStack.call(): 3 args required");
+    assert(isBoolean(isLogged), "CallStack.call(): 3 args required");
     mainPre = getPrefix(this.level);
     if (doDebugStack) {
       prefix = '   '.repeat(this.lStack.length);
@@ -82,7 +84,7 @@ export var CallStack = class CallStack {
     }
     this.addCall(funcName, hInfo, isLogged);
     auxPre = getPrefix(this.level);
-    return [mainPre, auxPre, undef];
+    return [mainPre, auxPre];
   }
 
   // ........................................................................

package/src/debug_utils.coffee

@@ -1,7 +1,8 @@
 # debug_utils.coffee
 
 import {
-	assert, undef, error, croak, warn, isString, isFunction, isBoolean,
+	assert, undef, error, croak, warn, defined,
+	isString, isFunction, isBoolean,
 	OL, escapeStr, isNumber, isArray, words, pass,
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
@@ -14,8 +15,8 @@ import {
 
 # --- These are saved/restored on the call stack
 export debugging = false
-shouldLogFunc   = (func) -> debugging
-shouldLogString = (str) -> debugging
+shouldLogFunc   = (func) -> return debugging
+shouldLogString = (str)  -> return debugging
 
 stack = new CallStack()
 doDebugDebug = false
@@ -37,8 +38,8 @@ resetDebugging = () ->
 	if doDebugDebug
 		LOG "resetDebugging() - debugging = false"
 	stack.reset()
-	shouldLogFunc = (func) -> debugging
-	shouldLogString = (str)  -> debugging
+	shouldLogFunc = (func)  -> return debugging
+	shouldLogString = (str) -> return debugging
 	return
 
 # ---------------------------------------------------------------------------
@@ -65,7 +66,7 @@ export setDebugging = (funcDoDebug=undef, funcDoLog=undef) ->
 	else
 		croak "setDebugging(): bad parameter #{OL(funcDoDebug)}"
 
-	if funcDoLog
+	if isFunction(funcDoLog)
 		assert isFunction(funcDoLog), "setDebugging: arg 2 not a function"
 		shouldLogString = funcDoLog
 	return
@@ -89,8 +90,8 @@ export funcMatch = (curFunc, lFuncNames) ->
 # ---------------------------------------------------------------------------
 # 1. adjust call stack on 'enter' or 'return from'
 # 2. adjust debugging flag
-# 3. return [mainPrefix, auxPrefix, hEnv] - hEnv can be undef
-# 4. disable logging by setting mainPrefix to undef
+# 3. return [mainPrefix, auxPrefix, hEnv, type] - hEnv can be undef
+# 4. disable logging by setting type to undef
 
 adjustStack = (str) ->
 
@@ -100,17 +101,21 @@ adjustStack = (str) ->
 			\s+
 			([A-Za-z_][A-Za-z0-9_\.]*)
 			///))
+
+		# --- We are entering function curFunc
 		curFunc = lMatches[1]
+
 		hEnv = {
 			debugging
 			shouldLogFunc
 			shouldLogString
 			}
+
 		debugging = shouldLogFunc(curFunc)
 		if doDebugDebug
 			trans = "#{hEnv.debugging} => #{debugging}"
 			LOG "   ENTER #{curFunc}, debugging: #{trans}"
-		[mainPre, auxPre, _] = stack.call(curFunc, hEnv, debugging)
+		[mainPre, auxPre] = stack.doCall(curFunc, hEnv, debugging)
 		return [
 			mainPre
 			auxPre
@@ -152,6 +157,9 @@ export debug = (lArgs...) ->
 	#     distinguish between 1 arg sent vs. 2 args sent
 	nArgs = lArgs.length
 	assert (nArgs==1) || (nArgs==2), "debug(): #{nArgs} args"
+
+	# --- label must always be there, and be a string
+	#     item is optional
 	[label, item] = lArgs
 	assert isString(label),
 			"debug(): 1st arg #{OL(label)} should be a string"

package/src/debug_utils.js

@@ -8,6 +8,7 @@ import {
   error,
   croak,
   warn,
+  defined,
   isString,
   isFunction,
   isBoolean,
@@ -108,7 +109,7 @@ export var setDebugging = function(funcDoDebug = undef, funcDoLog = undef) {
   } else {
     croak(`setDebugging(): bad parameter ${OL(funcDoDebug)}`);
   }
-  if (funcDoLog) {
+  if (isFunction(funcDoLog)) {
     assert(isFunction(funcDoLog), "setDebugging: arg 2 not a function");
     shouldLogString = funcDoLog;
   }
@@ -132,11 +133,12 @@ export var funcMatch = function(curFunc, lFuncNames) {
 // ---------------------------------------------------------------------------
 // 1. adjust call stack on 'enter' or 'return from'
 // 2. adjust debugging flag
-// 3. return [mainPrefix, auxPrefix, hEnv] - hEnv can be undef
-// 4. disable logging by setting mainPrefix to undef
+// 3. return [mainPrefix, auxPrefix, hEnv, type] - hEnv can be undef
+// 4. disable logging by setting type to undef
 adjustStack = function(str) {
   var _, auxPre, curFunc, hEnv, lMatches, mainPre, trans;
   if ((lMatches = str.match(/^\s*enter\s+([A-Za-z_][A-Za-z0-9_\.]*)/))) {
+    // --- We are entering function curFunc
     curFunc = lMatches[1];
     hEnv = {debugging, shouldLogFunc, shouldLogString};
     debugging = shouldLogFunc(curFunc);
@@ -144,7 +146,7 @@ adjustStack = function(str) {
       trans = `${hEnv.debugging} => ${debugging}`;
       LOG(`   ENTER ${curFunc}, debugging: ${trans}`);
     }
-    [mainPre, auxPre, _] = stack.call(curFunc, hEnv, debugging);
+    [mainPre, auxPre] = stack.doCall(curFunc, hEnv, debugging);
     return [mainPre, auxPre, undef, shouldLogFunc(curFunc) ? 'enter' : undef];
   } else if ((lMatches = str.match(/^\s*return.+from\s+([A-Za-z_][A-Za-z0-9_\.]*)/))) {
     curFunc = lMatches[1];
@@ -166,6 +168,8 @@ export var debug = function(...lArgs) {
   //     distinguish between 1 arg sent vs. 2 args sent
   nArgs = lArgs.length;
   assert((nArgs === 1) || (nArgs === 2), `debug(): ${nArgs} args`);
+  // --- label must always be there, and be a string
+  //     item is optional
   [label, item] = lArgs;
   assert(isString(label), `debug(): 1st arg ${OL(label)} should be a string`);
   if (doDebugDebug) {