@jdeighan/coffee-utils 4.1.35 → 5.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "4.1.35",
+	"version": "5.0.0",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -15,9 +15,9 @@
 		"./stack": "./src/call_stack.js",
 		"./debug": "./src/debug_utils.js",
 		"./svelte": "./src/svelte_utils.js",
-		"./test": "./src/UnitTester.js",
 		"./store": "./src/DataStores.js",
 		"./taml": "./src/taml.js",
+		"./templib": "./src/templib.js",
 		"./package.json": "./package.json"
 	},
 	"engines": {
@@ -29,7 +29,7 @@
 	"scripts": {
 		"build": "cls && rm -f ./src/*.js && coffee -c ./src",
 		"pretest": "cls && cielo -qfc ./test && coffee -c .",
-		"test": "ava ./test/*.test.js",
+		"test": "npx ava ./test/*.test.js",
 		"prefinaltest": "npm run pretest",
 		"finaltest": "cross-env FINALTEST=yes ava ./test/*.test.js"
 	},
@@ -47,10 +47,12 @@
 	},
 	"homepage": "https://github.com/johndeighan/coffee-utils#readme",
 	"dependencies": {
-		"ava": "^3.15.0",
 		"cross-env": "^7.0.3",
 		"js-yaml": "^4.1.0",
 		"readline-sync": "^1.4.10",
 		"svelte": "^3.46.4"
+	},
+	"devDependencies": {
+		"@jdeighan/unit-tester": "^1.0.4"
 	}
 }

package/src/block_utils.coffee

@@ -6,7 +6,6 @@ import readline from 'readline'
 import {
 	assert, isEmpty, isString, nonEmpty, error, isComment, rtrim,
 	} from '@jdeighan/coffee-utils'
-import {log} from '@jdeighan/coffee-utils/log'
 
 # ---------------------------------------------------------------------------
 #   blockToArray - split a block into lines

package/src/block_utils.js

@@ -14,10 +14,6 @@ import {
   rtrim
 } from '@jdeighan/coffee-utils';
 
-import {
-  log
-} from '@jdeighan/coffee-utils/log';
-
 // ---------------------------------------------------------------------------
 //   blockToArray - split a block into lines
 export var blockToArray = function(block) {

package/src/coffee_utils.coffee

@@ -1,7 +1,5 @@
 # coffee_utils.coffee
 
-import {log} from '@jdeighan/coffee-utils/log'
-
 export sep_dash = '-'.repeat(42)
 export sep_eq = '='.repeat(42)
 `export const undef = undefined`
@@ -33,8 +31,10 @@ export assert = (cond, msg) ->
 export croak = (err, label, obj) ->
 
 	message = if (typeof err == 'object') then err.message else err
-	log "ERROR (croak): #{message}"
-	log label, obj
+	console.log "ERROR (croak): #{message}"
+	console.log obj, label
+
+	# --- re-throw the error
 	if (typeof err == 'object')
 		throw err
 	else
@@ -227,7 +227,7 @@ export uniq = (lItems) ->
 
 export warn = (message) ->
 
-	log "WARNING: #{message}"
+	say "WARNING: #{message}"
 
 # ---------------------------------------------------------------------------
 #   hashToStr - stringify a hash
@@ -301,24 +301,17 @@ export deepCopy = (obj) ->
 # ---------------------------------------------------------------------------
 #   escapeStr - escape newlines, TAB chars, etc.
 
-export escapeStr = (str, hEscape=undef) ->
+export hDefEsc = {
+	"\n": '®'
+	"\t": '→'
+	" ": '˳'
+	}
 
-	if ! isString(str)
-		croak "escapeStr(): not a string", str, 'STRING'
-	if hEscape?
-		lParts = for ch in str.split('')
-			if hEscape[ch]?
-				hEscape[ch]
-			else
-				ch
-	else
-		lParts = for ch in str.split('')
-			if ch == '\n'
-				'\\n'
-			else if ch == '\t'
-				'\\t'
-			else
-				ch
+export escapeStr = (str, hEscape=hDefEsc) ->
+
+	assert isString(str), "escapeStr(): not a string"
+	lParts = for ch in str.split('')
+		if hEscape[ch]? then hEscape[ch] else ch
 	return lParts.join('')
 
 # ---------------------------------------------------------------------------

package/src/coffee_utils.js

@@ -2,10 +2,6 @@
 // coffee_utils.coffee
 var commentRegExp;
 
-import {
-  log
-} from '@jdeighan/coffee-utils/log';
-
 export var sep_dash = '-'.repeat(42);
 
 export var sep_eq = '='.repeat(42);
@@ -35,8 +31,9 @@ export var assert = function(cond, msg) {
 export var croak = function(err, label, obj) {
   var message;
   message = (typeof err === 'object') ? err.message : err;
-  log(`ERROR (croak): ${message}`);
-  log(label, obj);
+  console.log(`ERROR (croak): ${message}`);
+  console.log(obj, label);
+  // --- re-throw the error
   if (typeof err === 'object') {
     throw err;
   } else {
@@ -229,7 +226,7 @@ export var uniq = function(lItems) {
 // ---------------------------------------------------------------------------
 //   warn - issue a warning
 export var warn = function(message) {
-  return log(`WARNING: ${message}`);
+  return say(`WARNING: ${message}`);
 };
 
 // ---------------------------------------------------------------------------
@@ -298,44 +295,29 @@ export var deepCopy = function(obj) {
 
 // ---------------------------------------------------------------------------
 //   escapeStr - escape newlines, TAB chars, etc.
-export var escapeStr = function(str, hEscape = undef) {
+export var hDefEsc = {
+  "\n": '®',
+  "\t": '→',
+  " ": '˳'
+};
+
+export var escapeStr = function(str, hEscape = hDefEsc) {
   var ch, lParts;
-  if (!isString(str)) {
-    croak("escapeStr(): not a string", str, 'STRING');
-  }
-  if (hEscape != null) {
-    lParts = (function() {
-      var i, len, ref, results;
-      ref = str.split('');
-      results = [];
-      for (i = 0, len = ref.length; i < len; i++) {
-        ch = ref[i];
-        if (hEscape[ch] != null) {
-          results.push(hEscape[ch]);
-        } else {
-          results.push(ch);
-        }
-      }
-      return results;
-    })();
-  } else {
-    lParts = (function() {
-      var i, len, ref, results;
-      ref = str.split('');
-      results = [];
-      for (i = 0, len = ref.length; i < len; i++) {
-        ch = ref[i];
-        if (ch === '\n') {
-          results.push('\\n');
-        } else if (ch === '\t') {
-          results.push('\\t');
-        } else {
-          results.push(ch);
-        }
+  assert(isString(str), "escapeStr(): not a string");
+  lParts = (function() {
+    var i, len, ref, results;
+    ref = str.split('');
+    results = [];
+    for (i = 0, len = ref.length; i < len; i++) {
+      ch = ref[i];
+      if (hEscape[ch] != null) {
+        results.push(hEscape[ch]);
+      } else {
+        results.push(ch);
       }
-      return results;
-    })();
-  }
+    }
+    return results;
+  })();
   return lParts.join('');
 };
 

package/src/debug_utils.coffee

@@ -1,14 +1,18 @@
 # debug_utils.coffee
 
 import {
-	assert, undef, error, croak, warn, isString, isFunction, isBoolean,
+	assert, error, croak, warn, isString, isFunction, isBoolean,
 	oneline, escapeStr, isNumber, isArray, words,
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
-import {log, setLogger} from '@jdeighan/coffee-utils/log'
+import {untabify} from '@jdeighan/coffee-utils/indent'
 import {slurp} from '@jdeighan/coffee-utils/fs'
 import {CallStack} from '@jdeighan/coffee-utils/stack'
+import {
+	log, setStringifier, orderedStringify,
+	} from '@jdeighan/coffee-utils/log'
 
+undef = undefined
 vbar = '│'       # unicode 2502
 hbar = '─'       # unicode 2500
 corner = '└'     # unicode 2514
@@ -18,7 +22,6 @@ indent = vbar + '   '
 arrow = corner + hbar + arrowhead + ' '
 
 debugLevel = 0   # controls amount of indentation - we ensure it's never < 0
-stdLogger = false
 
 # --- These are saved/restored on the call stack
 export debugging = false
@@ -34,7 +37,7 @@ export resetDebugging = (funcDoDebug=undef, funcDoLog=undef) ->
 	debugLevel = 0
 	stack.reset()
 	shouldDebug = (funcName, curDebugging) -> curDebugging
-	shouldLog   = (str)      -> debugging
+	shouldLog   = (str) -> debugging || process.env.DEBUG
 	if funcDoDebug
 		setDebugging funcDoDebug, funcDoLog
 	return
@@ -91,32 +94,17 @@ setEnv = (hEnv) ->
 	return
 
 # ---------------------------------------------------------------------------
+# --- 2 possible signatures:
+#        (item) - just log out the string
+#        (item, hOptions) - log out the object, with a label
 
-export useStdLogger = (flag=true) ->
-
-	stdLogger = flag
-	return
-
-# ---------------------------------------------------------------------------
-
-logger = (lArgs...) ->
+logger = (item, hOptions=undef) ->
 
-	if stdLogger
-		log lArgs...
-	else
-		orgLogger = setLogger(console.log)
-		log lArgs...
-		setLogger(orgLogger)
+	log item, hOptions
 	return
 
 # ---------------------------------------------------------------------------
 
-stripArrow = (prefix) ->
-
-	return prefix.replace(arrow, '    ')
-
-# ---------------------------------------------------------------------------
-
 getPrefix = (level) ->
 
 	if (level < 0)
@@ -182,7 +170,7 @@ export debug = (lArgs...) ->
 		curFunc = lMatches[1]
 		hInfo = stack.returnFrom(curFunc)
 
-	if debugging && shouldLog(str)
+	if shouldLog(str)
 
 		# --- set the prefix, i.e. indentation to use
 		if returning
@@ -194,12 +182,15 @@ export debug = (lArgs...) ->
 			prefix = indent.repeat(debugLevel)
 
 		if (nArgs==1)
-			logger str, item, {prefix}
+			logger str, {
+				prefix: prefix
+				}
 		else
-			logger str, item, {
-				prefix,
-				logItem: true,
-				itemPrefix: stripArrow(prefix),
+			itemPrefix = prefix.replace(arrow, '    ')
+			logger item, {
+				label: str
+				prefix: prefix
+				itemPrefix
 				}
 
 	# --- Adjust debug level

package/src/debug_utils.js

@@ -1,10 +1,9 @@
 // Generated by CoffeeScript 2.6.1
 // debug_utils.coffee
-var arrow, arrowhead, corner, curEnv, debugLevel, envSaysDebug, getPrefix, hbar, indent, logger, reMethod, setEnv, shouldDebug, shouldLog, stack, stdLogger, stripArrow, vbar;
+var arrow, arrowhead, corner, curEnv, debugLevel, envSaysDebug, getPrefix, hbar, indent, logger, reMethod, setEnv, shouldDebug, shouldLog, stack, undef, vbar;
 
 import {
   assert,
-  undef,
   error,
   croak,
   warn,
@@ -23,9 +22,8 @@ import {
 } from '@jdeighan/coffee-utils/block';
 
 import {
-  log,
-  setLogger
-} from '@jdeighan/coffee-utils/log';
+  untabify
+} from '@jdeighan/coffee-utils/indent';
 
 import {
   slurp
@@ -35,6 +33,14 @@ import {
   CallStack
 } from '@jdeighan/coffee-utils/stack';
 
+import {
+  log,
+  setStringifier,
+  orderedStringify
+} from '@jdeighan/coffee-utils/log';
+
+undef = void 0;
+
 vbar = '│'; // unicode 2502
 
 hbar = '─'; // unicode 2500
@@ -49,7 +55,6 @@ arrow = corner + hbar + arrowhead + ' ';
 
 debugLevel = 0; // controls amount of indentation - we ensure it's never < 0
 
-stdLogger = false;
 
 // --- These are saved/restored on the call stack
 export var debugging = false;
@@ -67,7 +72,7 @@ export var resetDebugging = function(funcDoDebug = undef, funcDoLog = undef) {
     return curDebugging;
   };
   shouldLog = function(str) {
-    return debugging;
+    return debugging || process.env.DEBUG;
   };
   if (funcDoDebug) {
     setDebugging(funcDoDebug, funcDoLog);
@@ -123,25 +128,11 @@ setEnv = function(hEnv) {
 };
 
 // ---------------------------------------------------------------------------
-export var useStdLogger = function(flag = true) {
-  stdLogger = flag;
-};
-
-// ---------------------------------------------------------------------------
-logger = function(...lArgs) {
-  var orgLogger;
-  if (stdLogger) {
-    log(...lArgs);
-  } else {
-    orgLogger = setLogger(console.log);
-    log(...lArgs);
-    setLogger(orgLogger);
-  }
-};
-
-// ---------------------------------------------------------------------------
-stripArrow = function(prefix) {
-  return prefix.replace(arrow, '    ');
+// --- 2 possible signatures:
+//        (item) - just log out the string
+//        (item, hOptions) - log out the object, with a label
+logger = function(item, hOptions = undef) {
+  log(item, hOptions);
 };
 
 // ---------------------------------------------------------------------------
@@ -166,7 +157,7 @@ envSaysDebug = function(curFunc) {
 
 // ---------------------------------------------------------------------------
 export var debug = function(...lArgs) {
-  var curFunc, entering, hInfo, item, lMatches, nArgs, prefix, returning, str;
+  var curFunc, entering, hInfo, item, itemPrefix, lMatches, nArgs, prefix, returning, str;
   // --- either 1 or 2 args
 
   // --- We always need to manipulate the stack when we encounter
@@ -194,7 +185,7 @@ export var debug = function(...lArgs) {
     curFunc = lMatches[1];
     hInfo = stack.returnFrom(curFunc);
   }
-  if (debugging && shouldLog(str)) {
+  if (shouldLog(str)) {
     // --- set the prefix, i.e. indentation to use
     if (returning) {
       if (debugLevel === 0) {
@@ -206,12 +197,15 @@ export var debug = function(...lArgs) {
       prefix = indent.repeat(debugLevel);
     }
     if (nArgs === 1) {
-      logger(str, item, {prefix});
+      logger(str, {
+        prefix: prefix
+      });
     } else {
-      logger(str, item, {
-        prefix,
-        logItem: true,
-        itemPrefix: stripArrow(prefix)
+      itemPrefix = prefix.replace(arrow, '    ');
+      logger(item, {
+        label: str,
+        prefix: prefix,
+        itemPrefix
       });
     }
   }

package/src/indent_utils.coffee

@@ -117,19 +117,17 @@ export tabify = (str, numSpaces=undef) ->
 
 	lLines = []
 	for str in blockToArray(str)
-		lMatches = str.match(/^(\s*)(.*)$/)
-		[_, prefix, theRest] = lMatches
-		if prefix == ''
+		[_, prefix, theRest] = str.match(/^(\s*)(.*)$/)
+		prefixLen = prefix.length
+		if prefixLen == 0
 			lLines.push theRest
 		else
-			n = prefix.length
 			if (prefix.indexOf('\t') != -1)
 				error "tabify(): leading TAB characters not allowed"
-			if ! numSpaces?
-				numSpaces = n
-			if (n % numSpaces != 0)
-				error "tabify(): Invalid # of leading space chars"
-			lLines.push '\t'.repeat(n / numSpaces) + theRest
+			if numSpaces == undef
+				numSpaces = prefixLen
+			assert (prefixLen % numSpaces == 0), "Bad prefix"
+			lLines.push '\t'.repeat(prefixLen) + theRest
 	return arrayToBlock(lLines)
 
 # ---------------------------------------------------------------------------

package/src/indent_utils.js

@@ -137,27 +137,24 @@ export var undented = function(text, level = undef) {
 //             if numSpaces is not defined, then the first line
 //             that contains at least one space sets it
 export var tabify = function(str, numSpaces = undef) {
-  var _, i, lLines, lMatches, len, n, prefix, ref, theRest;
+  var _, i, lLines, len, prefix, prefixLen, ref, theRest;
   lLines = [];
   ref = blockToArray(str);
   for (i = 0, len = ref.length; i < len; i++) {
     str = ref[i];
-    lMatches = str.match(/^(\s*)(.*)$/);
-    [_, prefix, theRest] = lMatches;
-    if (prefix === '') {
+    [_, prefix, theRest] = str.match(/^(\s*)(.*)$/);
+    prefixLen = prefix.length;
+    if (prefixLen === 0) {
       lLines.push(theRest);
     } else {
-      n = prefix.length;
       if (prefix.indexOf('\t') !== -1) {
         error("tabify(): leading TAB characters not allowed");
       }
-      if (numSpaces == null) {
-        numSpaces = n;
-      }
-      if (n % numSpaces !== 0) {
-        error("tabify(): Invalid # of leading space chars");
+      if (numSpaces === undef) {
+        numSpaces = prefixLen;
       }
-      lLines.push('\t'.repeat(n / numSpaces) + theRest);
+      assert(prefixLen % numSpaces === 0, "Bad prefix");
+      lLines.push('\t'.repeat(prefixLen) + theRest);
     }
   }
   return arrayToBlock(lLines);