@jdeighan/coffee-utils 10.0.16 → 11.0.0

package/package.json

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

package/src/block_utils.coffee

@@ -5,8 +5,9 @@ import readline from 'readline'
 
 import {assert, error, croak} from '@jdeighan/unit-tester/utils'
 import {
-	undef, pass, defined, isEmpty, isString, isArray, nonEmpty, rtrim,
-	escapeStr,
+	undef, pass, defined, notdefined,
+	isEmpty, isString, isArray, nonEmpty, isArrayOfStrings,
+	escapeStr, rtrim, OL,
 	} from '@jdeighan/coffee-utils'
 
 # ---------------------------------------------------------------------------
@@ -90,9 +91,9 @@ export arrayToBlock = (lLines) ->
 
 export toBlock = (lLines) ->
 
-	if (lLines == undef)
+	if notdefined(lLines)
 		return undef
-	assert isArray(lLines), "lLines is not an array"
+	assert isArrayOfStrings(lLines), "lLines is not an array: #{OL(lLines)}"
 	lNewLines = []
 	for line in lLines
 		if defined(line)

package/src/block_utils.js

@@ -14,12 +14,15 @@ import {
   undef,
   pass,
   defined,
+  notdefined,
   isEmpty,
   isString,
   isArray,
   nonEmpty,
+  isArrayOfStrings,
+  escapeStr,
   rtrim,
-  escapeStr
+  OL
 } from '@jdeighan/coffee-utils';
 
 // ---------------------------------------------------------------------------
@@ -113,10 +116,10 @@ export var arrayToBlock = function(lLines) {
 //             but undef items are ignored
 export var toBlock = function(lLines) {
   var i, lNewLines, len1, line;
-  if (lLines === undef) {
+  if (notdefined(lLines)) {
     return undef;
   }
-  assert(isArray(lLines), "lLines is not an array");
+  assert(isArrayOfStrings(lLines), `lLines is not an array: ${OL(lLines)}`);
   lNewLines = [];
   for (i = 0, len1 = lLines.length; i < len1; i++) {
     line = lLines[i];

package/src/coffee_utils.coffee

@@ -647,3 +647,9 @@ export getOptions = (hOptions, hDefault={}) ->
 		return hOptions
 	else
 		return hDefault
+
+# ---------------------------------------------------------------------------
+
+export timestamp = () ->
+
+	return new Date().toLocaleTimeString("en-US")

package/src/coffee_utils.js

@@ -731,3 +731,8 @@ export var getOptions = function(hOptions, hDefault = {}) {
     return hDefault;
   }
 };
+
+// ---------------------------------------------------------------------------
+export var timestamp = function() {
+  return new Date().toLocaleTimeString("en-US");
+};

package/src/indent_utils.coffee

@@ -68,7 +68,8 @@ export isUndented = (line) ->
 	return (lMatches[0].length == 0)
 
 # ---------------------------------------------------------------------------
-#   indented - add indentation to each string in a block
+#   indented - add indentation to each string in a block or array
+#            - returns the same type as input, i.e. array or string
 
 export indented = (input, level=1, oneIndent="\t") ->
 
@@ -77,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

@@ -81,20 +81,23 @@ export var isUndented = function(line) {
 };
 
 // ---------------------------------------------------------------------------
-//   indented - add indentation to each string in a block
+//   indented - add indentation to each string in a block or array
+//            - 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 {
@@ -103,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)}`);
+  }
 };
 
 // ---------------------------------------------------------------------------