@jdeighan/coffee-utils 10.0.17 → 11.0.1

package/package.json

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

package/src/call_stack.coffee

@@ -5,7 +5,6 @@ import {
 	undef, defined, OL,  escapeStr, deepCopy,
 	isArray, isBoolean,
 	} from '@jdeighan/coffee-utils'
-import {LOG} from '@jdeighan/coffee-utils/log'
 
 doDebugStack = false
 
@@ -29,7 +28,7 @@ export class CallStack
 	reset: () ->
 
 		if doDebugStack
-			LOG "RESET STACK"
+			console.log "RESET STACK"
 		@lStack = []
 		return
 
@@ -48,7 +47,7 @@ export class CallStack
 		assert isBoolean(isLogged), "missing isLogged"
 
 		if doDebugStack
-			LOG @indent() + "[--> ENTER #{funcName}]"
+			console.log @indent() + "[--> ENTER #{funcName}]"
 
 		lMatches = funcName.match(///^
 				([A-Za-z_][A-Za-z0-9_]*)
@@ -101,13 +100,13 @@ export class CallStack
 	returnFrom: (fName) ->
 
 		if @lStack.length == 0
-			LOG "ERROR: returnFrom('#{fName}') but stack is empty"
+			console.log "ERROR: returnFrom('#{fName}') but stack is empty"
 			return
 		{fullName, isLogged} = @lStack.pop()
 		if doDebugStack
-			LOG @indent() + "[<-- BACK #{fName}]"
+			console.log @indent() + "[<-- BACK #{fName}]"
 		if (fullName != fName)
-			LOG "ERROR: returnFrom('#{fName}') but TOS is #{fullName}"
+			console.log "ERROR: returnFrom('#{fName}') but TOS is #{fullName}"
 			return
 
 		return

package/src/call_stack.js

@@ -17,10 +17,6 @@ import {
   isBoolean
 } from '@jdeighan/coffee-utils';
 
-import {
-  LOG
-} from '@jdeighan/coffee-utils/log';
-
 doDebugStack = false;
 
 // ---------------------------------------------------------------------------
@@ -37,7 +33,7 @@ export var CallStack = class CallStack {
   // ........................................................................
   reset() {
     if (doDebugStack) {
-      LOG("RESET STACK");
+      console.log("RESET STACK");
     }
     this.lStack = [];
   }
@@ -54,7 +50,7 @@ export var CallStack = class CallStack {
     assert(isArray(lArgs), "missing lArgs");
     assert(isBoolean(isLogged), "missing isLogged");
     if (doDebugStack) {
-      LOG(this.indent() + `[--> ENTER ${funcName}]`);
+      console.log(this.indent() + `[--> ENTER ${funcName}]`);
     }
     lMatches = funcName.match(/^([A-Za-z_][A-Za-z0-9_]*)(?:\.([A-Za-z_][A-Za-z0-9_]*))?$/);
     assert(defined(lMatches), `Bad funcName: ${OL(funcName)}`);
@@ -106,15 +102,15 @@ export var CallStack = class CallStack {
   returnFrom(fName) {
     var fullName, isLogged;
     if (this.lStack.length === 0) {
-      LOG(`ERROR: returnFrom('${fName}') but stack is empty`);
+      console.log(`ERROR: returnFrom('${fName}') but stack is empty`);
       return;
     }
     ({fullName, isLogged} = this.lStack.pop());
     if (doDebugStack) {
-      LOG(this.indent() + `[<-- BACK ${fName}]`);
+      console.log(this.indent() + `[<-- BACK ${fName}]`);
     }
     if (fullName !== fName) {
-      LOG(`ERROR: returnFrom('${fName}') but TOS is ${fullName}`);
+      console.log(`ERROR: returnFrom('${fName}') but TOS is ${fullName}`);
       return;
     }
   }

package/src/indent_utils.coffee

@@ -69,7 +69,7 @@ export isUndented = (line) ->
 
 # ---------------------------------------------------------------------------
 #   indented - add indentation to each string in a block or array
-#            - always returns a string
+#            - returns the same type as input, i.e. array or string
 
 export indented = (input, level=1, oneIndent="\t") ->
 
@@ -78,14 +78,20 @@ export indented = (input, level=1, oneIndent="\t") ->
 		return input
 
 	toAdd = indentation(level, oneIndent)
-	lInputLines = toArray(input)
 
-	lLines = for line in lInputLines
+	# --- NOTE: toArray(input) just returns input if it's an array
+	#           else it splits the string into an array of lines
+	lLines = for line in toArray(input)
 		if isEmpty(line)
 			""
 		else
 			"#{toAdd}#{line}"
-	return arrayToBlock(lLines)
+	if isArray(input)
+		return lLines
+	else if isString(input)
+		return toBlock(lLines)
+	else
+		croak "Invalid input; #{OL(input)}"
 
 # ---------------------------------------------------------------------------
 #   undented - string with 1st line indentation removed for each line

package/src/indent_utils.js

@@ -82,20 +82,22 @@ export var isUndented = function(line) {
 
 // ---------------------------------------------------------------------------
 //   indented - add indentation to each string in a block or array
-//            - always returns a string
+//            - returns the same type as input, i.e. array or string
 export var indented = function(input, level = 1, oneIndent = "\t") {
-  var lInputLines, lLines, line, toAdd;
+  var lLines, line, toAdd;
   assert(level >= 0, "indented(): negative level");
   if (level === 0) {
     return input;
   }
   toAdd = indentation(level, oneIndent);
-  lInputLines = toArray(input);
+  // --- NOTE: toArray(input) just returns input if it's an array
+  //           else it splits the string into an array of lines
   lLines = (function() {
-    var i, len1, results;
+    var i, len1, ref, results;
+    ref = toArray(input);
     results = [];
-    for (i = 0, len1 = lInputLines.length; i < len1; i++) {
-      line = lInputLines[i];
+    for (i = 0, len1 = ref.length; i < len1; i++) {
+      line = ref[i];
       if (isEmpty(line)) {
         results.push("");
       } else {
@@ -104,7 +106,13 @@ export var indented = function(input, level = 1, oneIndent = "\t") {
     }
     return results;
   })();
-  return arrayToBlock(lLines);
+  if (isArray(input)) {
+    return lLines;
+  } else if (isString(input)) {
+    return toBlock(lLines);
+  } else {
+    return croak(`Invalid input; ${OL(input)}`);
+  }
 };
 
 // ---------------------------------------------------------------------------

package/src/log_utils.coffee

@@ -1,7 +1,5 @@
 # log_utils.coffee
 
-import yaml from 'js-yaml'
-
 import {assert, error, croak} from '@jdeighan/unit-tester/utils'
 import {
 	undef, isNumber, isInteger, isString, isHash, isFunction,
@@ -11,6 +9,7 @@ import {blockToArray} from '@jdeighan/coffee-utils/block'
 import {
 	tabify, untabify, indentation, indented,
 	} from '@jdeighan/coffee-utils/indent'
+import {toTAML} from '@jdeighan/coffee-utils/taml'
 
 # --- This logger only ever gets passed a single string argument
 putstr = undef
@@ -96,39 +95,24 @@ export resetLogger = () ->
 
 # ---------------------------------------------------------------------------
 
-escReplacer = (name, value) ->
-
-	if ! isString(value)
-		return value
-	return escapeStr(value)
-
-# ---------------------------------------------------------------------------
-
 export tamlStringify = (obj, escape=false) ->
 
-	str = yaml.dump(obj, {
-		skipInvalid: true
-		indent: 1
+	return toTAML(obj, {
+		useTabs: false
 		sortKeys: false
-		lineWidth: -1
-		replacer: if escape then escReplacer else (name,value) -> value
+		escape
 		})
-	return "---\n" + str
 
 # ---------------------------------------------------------------------------
 
 export orderedStringify = (obj, escape=false) ->
 
-	str = yaml.dump(obj, {
-		skipInvalid: true
-		indent: 1
+	return toTAML(obj, {
+		useTabs: false
 		sortKeys: true
-		lineWidth: 40
-		replacer: if escape then escReplacer else (name,value) -> value
+		escape
 		})
 
-	return "---\n" + str
-
 # ---------------------------------------------------------------------------
 
 maxOneLine = 32

package/src/log_utils.js

@@ -1,8 +1,6 @@
 // Generated by CoffeeScript 2.7.0
 // log_utils.coffee
-var doDebugLog, escReplacer, fixForTerminal, fourSpaces, loaded, maxOneLine, putBlock, putstr;
-
-import yaml from 'js-yaml';
+var doDebugLog, fixForTerminal, fourSpaces, loaded, maxOneLine, putBlock, putstr;
 
 import {
   assert,
@@ -35,6 +33,10 @@ import {
   indented
 } from '@jdeighan/coffee-utils/indent';
 
+import {
+  toTAML
+} from '@jdeighan/coffee-utils/taml';
+
 // --- This logger only ever gets passed a single string argument
 putstr = undef;
 
@@ -122,42 +124,22 @@ export var resetLogger = function() {
   return setLogger(console.log);
 };
 
-// ---------------------------------------------------------------------------
-escReplacer = function(name, value) {
-  if (!isString(value)) {
-    return value;
-  }
-  return escapeStr(value);
-};
-
 // ---------------------------------------------------------------------------
 export var tamlStringify = function(obj, escape = false) {
-  var str;
-  str = yaml.dump(obj, {
-    skipInvalid: true,
-    indent: 1,
+  return toTAML(obj, {
+    useTabs: false,
     sortKeys: false,
-    lineWidth: -1,
-    replacer: escape ? escReplacer : function(name, value) {
-      return value;
-    }
+    escape
   });
-  return "---\n" + str;
 };
 
 // ---------------------------------------------------------------------------
 export var orderedStringify = function(obj, escape = false) {
-  var str;
-  str = yaml.dump(obj, {
-    skipInvalid: true,
-    indent: 1,
+  return toTAML(obj, {
+    useTabs: false,
     sortKeys: true,
-    lineWidth: 40,
-    replacer: escape ? escReplacer : function(name, value) {
-      return value;
-    }
+    escape
   });
-  return "---\n" + str;
 };
 
 // ---------------------------------------------------------------------------

package/src/taml.coffee

@@ -4,7 +4,7 @@ import yaml from 'js-yaml'
 
 import {assert, error, croak} from '@jdeighan/unit-tester/utils'
 import {
-	undef, oneline, isString, chomp,
+	undef, oneline, isString, chomp, escapeStr,
 	} from '@jdeighan/coffee-utils'
 import {untabify, tabify, splitLine} from '@jdeighan/coffee-utils/indent'
 import {slurp} from '@jdeighan/coffee-utils/fs'
@@ -64,9 +64,24 @@ export fromTAML = taml
 
 # ---------------------------------------------------------------------------
 
-export toTAML = (x, useTabs=false) ->
+escReplacer = (name, value) ->
 
-	str = yaml.dump(x, {indent:3})
+	if ! isString(value)
+		return value
+	return escapeStr(value)
+
+# ---------------------------------------------------------------------------
+
+export toTAML = (obj, hOptions={}) ->
+
+	{useTabs, sortKeys, escape} = hOptions
+	str = yaml.dump(obj, {
+		skipInvalid: true
+		indent: 3
+		sortKeys: !!sortKeys
+		lineWidth: -1
+		replacer: if !!escape then escReplacer else (name,value) -> value
+		})
 	if useTabs
 		str = str.replace(/   /g, "\t")
 	return "---\n" + chomp(str)

package/src/taml.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.7.0
 // taml.coffee
-var squote;
+var escReplacer, squote;
 
 import yaml from 'js-yaml';
 
@@ -14,7 +14,8 @@ import {
   undef,
   oneline,
   isString,
-  chomp
+  chomp,
+  escapeStr
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -89,10 +90,25 @@ export var taml = function(text) {
 export var fromTAML = taml;
 
 // ---------------------------------------------------------------------------
-export var toTAML = function(x, useTabs = false) {
-  var str;
-  str = yaml.dump(x, {
-    indent: 3
+escReplacer = function(name, value) {
+  if (!isString(value)) {
+    return value;
+  }
+  return escapeStr(value);
+};
+
+// ---------------------------------------------------------------------------
+export var toTAML = function(obj, hOptions = {}) {
+  var escape, sortKeys, str, useTabs;
+  ({useTabs, sortKeys, escape} = hOptions);
+  str = yaml.dump(obj, {
+    skipInvalid: true,
+    indent: 3,
+    sortKeys: !!sortKeys,
+    lineWidth: -1,
+    replacer: !!escape ? escReplacer : function(name, value) {
+      return value;
+    }
   });
   if (useTabs) {
     str = str.replace(/   /g, "\t");