@jdeighan/coffee-utils 7.0.49 → 7.0.52

package/src/log_utils.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.7.0
 // log_utils.coffee
-var escReplacer, fixStr, loaded, maxOneLine, putBlock, putstr;
+var doDebugLog, escReplacer, fixForTerminal, fourSpaces, loaded, maxOneLine, putBlock, putstr;
 
 import yaml from 'js-yaml';
 
@@ -15,7 +15,8 @@ import {
   escapeStr,
   sep_eq,
   sep_dash,
-  pass
+  pass,
+  OL
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -25,14 +26,27 @@ import {
 import {
   tabify,
   untabify,
-  indentation
+  indentation,
+  indented
 } from '@jdeighan/coffee-utils/indent';
 
 // --- This logger only ever gets passed a single string argument
 putstr = undef;
 
+doDebugLog = false;
+
 export var stringify = undef;
 
+fourSpaces = '    ';
+
+// ---------------------------------------------------------------------------
+export var debugLog = function(flag = true) {
+  doDebugLog = flag;
+  if (doDebugLog) {
+    LOG(`doDebugLog = ${flag}`);
+  }
+};
+
 // ---------------------------------------------------------------------------
 // This is useful for debugging
 export var LOG = function(...lArgs) {
@@ -41,9 +55,9 @@ export var LOG = function(...lArgs) {
   if (lArgs.length > 1) {
     // --- There's both a label and an item
     if (item === undef) {
-      console.log(`${label}: UNDEFINED`);
+      console.log(`${label} = undef`);
     } else if (item === null) {
-      console.log(`${label}: NULL`);
+      console.log(`${label} = null`);
     } else {
       console.log(sep_dash);
       console.log(`${label}:`);
@@ -134,19 +148,6 @@ export var orderedStringify = function(obj, escape = false) {
 // ---------------------------------------------------------------------------
 maxOneLine = 32;
 
-// ---------------------------------------------------------------------------
-fixStr = function(str) {
-  if (!str) {
-    return '';
-  }
-  // --- If putstr is console.log, we'll convert TAB char to 3 spaces
-  if (putstr === console.log) {
-    return untabify(str);
-  } else {
-    return str;
-  }
-};
-
 // ---------------------------------------------------------------------------
 export var log = function(str, hOptions = {}) {
   var prefix;
@@ -155,7 +156,10 @@ export var log = function(str, hOptions = {}) {
   assert(isFunction(putstr), "putstr not properly set");
   assert(isString(str), "log(): not a string");
   assert(isHash(hOptions), "log(): arg 2 not a hash");
-  prefix = fixStr(hOptions.prefix);
+  prefix = fixForTerminal(hOptions.prefix);
+  if (doDebugLog) {
+    LOG(`CALL log(${OL(str)}), prefix = ${OL(prefix)}`);
+  }
   putstr(`${prefix}${str}`);
   return true; // to allow use in boolean expressions
 };
@@ -165,13 +169,17 @@ export var log = function(str, hOptions = {}) {
 export var logItem = function(label, item, hOptions = {}) {
   var i, labelStr, len, prefix, ref, str;
   // --- valid options:
-  //   prefix     - not used
-  //   itemPrefix - always used
+  //   prefix
   assert(isFunction(putstr), "putstr not properly set");
   assert(!label || isString(label), "label a non-string");
   assert(isHash(hOptions), "arg 3 not a hash");
-  label = fixStr(label);
-  prefix = fixStr(hOptions.itemPrefix || hOptions.prefix);
+  label = fixForTerminal(label);
+  prefix = fixForTerminal(hOptions.prefix);
+  assert(prefix.indexOf("\t") === -1, "prefix has TAB");
+  if (doDebugLog) {
+    LOG(`CALL logItem(${OL(label)}, ${OL(item)})`);
+    LOG(`prefix = ${OL(prefix)}`);
+  }
   labelStr = label ? `${label} = ` : "";
   if (item === undef) {
     putstr(`${prefix}${labelStr}undef`);
@@ -184,12 +192,11 @@ export var logItem = function(label, item, hOptions = {}) {
       if (label) {
         putstr(`${prefix}${label}:`);
       }
-      putBlock(item, prefix);
+      putBlock(item, prefix + fourSpaces);
     }
   } else if (isNumber(item)) {
     putstr(`${prefix}${labelStr}${item}`);
   } else {
-    putstr(`${prefix}${sep_dash}`);
     if (label) {
       putstr(`${prefix}${label}:`);
     }
@@ -197,13 +204,27 @@ export var logItem = function(label, item, hOptions = {}) {
     // escape special chars
     for (i = 0, len = ref.length; i < len; i++) {
       str = ref[i];
-      putstr(`${prefix}${indentation(1)}${fixStr(str)}`);
+      putstr(`${prefix + fourSpaces}${fixForTerminal(str)}`);
     }
-    putstr(`${prefix}${sep_dash}`);
   }
   return true;
 };
 
+// ---------------------------------------------------------------------------
+export var shortEnough = function(label, value) {
+  return value === undef;
+};
+
+// ---------------------------------------------------------------------------
+// --- needed because Windows Terminal handles TAB chars badly
+fixForTerminal = function(str) {
+  if (!str) {
+    return '';
+  }
+  // --- convert TAB char to 4 spaces
+  return str.replace(/\t/g, fourSpaces);
+};
+
 // ---------------------------------------------------------------------------
 putBlock = function(item, prefix = '') {
   var i, len, line, ref;