@jdeighan/coffee-utils 5.0.5 → 6.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "5.0.5",
+	"version": "6.0.2",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -46,6 +46,7 @@
 	"dependencies": {
 		"cross-env": "^7.0.3",
 		"js-yaml": "^4.1.0",
+		"n-readlines": "^1.0.1",
 		"readline-sync": "^1.4.10",
 		"svelte": "^3.46.4"
 	},

package/src/debug_utils.coffee

@@ -28,6 +28,15 @@ export debugging = false
 shouldDebug = shouldLog = undef
 
 stack = new CallStack()
+DEBUGDEBUG = false
+
+# ---------------------------------------------------------------------------
+
+export setDEBUGDEBUG = (flag=true) ->
+
+	DEBUGDEBUG = flag
+	console.log "DEBUGDEBUG = #{flag}"
+	return
 
 # ---------------------------------------------------------------------------
 
@@ -36,8 +45,8 @@ export resetDebugging = (funcDoDebug=undef, funcDoLog=undef) ->
 	debugging = false
 	debugLevel = 0
 	stack.reset()
-	shouldDebug = (funcName, curDebugging) -> curDebugging
-	shouldLog   = (str) -> debugging || process.env.DEBUG
+	shouldDebug = (funcName) -> debugging
+	shouldLog   = (str) -> debugging
 	if funcDoDebug
 		setDebugging funcDoDebug, funcDoLog
 	return
@@ -47,15 +56,21 @@ export resetDebugging = (funcDoDebug=undef, funcDoLog=undef) ->
 export setDebugging = (funcDoDebug=undef, funcDoLog=undef) ->
 
 	if isBoolean(funcDoDebug)
+		if DEBUGDEBUG
+			console.log "setDebugging #{funcDoDebug}"
 		debugging = funcDoDebug
 	else if isString(funcDoDebug)
 		debugging = false
 		lFuncNames = words(funcDoDebug)
 		assert isArray(lFuncNames), "words('#{funcDoDebug}') returned non-array"
-		shouldDebug = (funcName, curDebugging) ->
-			curDebugging || funcMatch(funcName, lFuncNames)
+		shouldDebug = (funcName) ->
+			funcMatch(funcName, lFuncNames)
+		if DEBUGDEBUG
+			console.log "setDebugging FUNCS: #{lFuncNames.join(',')}"
 	else if isFunction(funcDoDebug)
 		shouldDebug = funcDoDebug
+		if DEBUGDEBUG
+			console.log "setDebugging to custom func"
 	else
 		croak "setDebugging(): bad parameter #{oneline(funcDoDebug)}"
 
@@ -114,17 +129,6 @@ getPrefix = (level) ->
 
 # ---------------------------------------------------------------------------
 
-envSaysDebug = (curFunc) ->
-
-	if process.env.DEBUG_FUNC?
-		return curFunc == process.env.DEBUG_FUNC
-	else if process.env.DEBUG_FUNCS?
-		return process.env.DEBUG_FUNCS.split(',').indexOf(curFunc) > -1
-	else
-		return false
-
-# ---------------------------------------------------------------------------
-
 export debug = (lArgs...) ->
 	# --- either 1 or 2 args
 
@@ -157,7 +161,7 @@ export debug = (lArgs...) ->
 		entering = true
 		curFunc = lMatches[1]
 		stack.call(curFunc, curEnv())
-		debugging = envSaysDebug(curFunc) || shouldDebug(curFunc, debugging)
+		debugging = shouldDebug(curFunc)
 	else if (lMatches = str.match(///^
 			\s*
 			return

package/src/debug_utils.js

@@ -1,6 +1,6 @@
 // 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, undef, vbar;
+var DEBUGDEBUG, arrow, arrowhead, corner, curEnv, debugLevel, getPrefix, hbar, indent, logger, reMethod, setEnv, shouldDebug, shouldLog, stack, undef, vbar;
 
 import {
   assert,
@@ -63,16 +63,24 @@ shouldDebug = shouldLog = undef;
 
 stack = new CallStack();
 
+DEBUGDEBUG = false;
+
+// ---------------------------------------------------------------------------
+export var setDEBUGDEBUG = function(flag = true) {
+  DEBUGDEBUG = flag;
+  console.log(`DEBUGDEBUG = ${flag}`);
+};
+
 // ---------------------------------------------------------------------------
 export var resetDebugging = function(funcDoDebug = undef, funcDoLog = undef) {
   debugging = false;
   debugLevel = 0;
   stack.reset();
-  shouldDebug = function(funcName, curDebugging) {
-    return curDebugging;
+  shouldDebug = function(funcName) {
+    return debugging;
   };
   shouldLog = function(str) {
-    return debugging || process.env.DEBUG;
+    return debugging;
   };
   if (funcDoDebug) {
     setDebugging(funcDoDebug, funcDoLog);
@@ -83,16 +91,25 @@ export var resetDebugging = function(funcDoDebug = undef, funcDoLog = undef) {
 export var setDebugging = function(funcDoDebug = undef, funcDoLog = undef) {
   var lFuncNames;
   if (isBoolean(funcDoDebug)) {
+    if (DEBUGDEBUG) {
+      console.log(`setDebugging ${funcDoDebug}`);
+    }
     debugging = funcDoDebug;
   } else if (isString(funcDoDebug)) {
     debugging = false;
     lFuncNames = words(funcDoDebug);
     assert(isArray(lFuncNames), `words('${funcDoDebug}') returned non-array`);
-    shouldDebug = function(funcName, curDebugging) {
-      return curDebugging || funcMatch(funcName, lFuncNames);
+    shouldDebug = function(funcName) {
+      return funcMatch(funcName, lFuncNames);
     };
+    if (DEBUGDEBUG) {
+      console.log(`setDebugging FUNCS: ${lFuncNames.join(',')}`);
+    }
   } else if (isFunction(funcDoDebug)) {
     shouldDebug = funcDoDebug;
+    if (DEBUGDEBUG) {
+      console.log("setDebugging to custom func");
+    }
   } else {
     croak(`setDebugging(): bad parameter ${oneline(funcDoDebug)}`);
   }
@@ -144,17 +161,6 @@ getPrefix = function(level) {
   return '   '.repeat(level);
 };
 
-// ---------------------------------------------------------------------------
-envSaysDebug = function(curFunc) {
-  if (process.env.DEBUG_FUNC != null) {
-    return curFunc === process.env.DEBUG_FUNC;
-  } else if (process.env.DEBUG_FUNCS != null) {
-    return process.env.DEBUG_FUNCS.split(',').indexOf(curFunc) > -1;
-  } else {
-    return false;
-  }
-};
-
 // ---------------------------------------------------------------------------
 export var debug = function(...lArgs) {
   var curFunc, entering, hInfo, item, itemPrefix, lMatches, nArgs, prefix, returning, str;
@@ -179,7 +185,7 @@ export var debug = function(...lArgs) {
     entering = true;
     curFunc = lMatches[1];
     stack.call(curFunc, curEnv());
-    debugging = envSaysDebug(curFunc) || shouldDebug(curFunc, debugging);
+    debugging = shouldDebug(curFunc);
   } else if ((lMatches = str.match(/^\s*return.+from\s+([A-Za-z_][A-Za-z0-9_\.]*)/))) {
     returning = true;
     curFunc = lMatches[1];

package/src/fs_utils.coffee

@@ -3,12 +3,13 @@
 import pathlib from 'path'
 import urllib from 'url'
 import fs from 'fs'
+import NReadLines from 'n-readlines'
 
 import {
 	assert, undef, pass, rtrim, error, nonEmpty,
 	isString, isRegExp, isFunction, croak,
 	} from '@jdeighan/coffee-utils'
-import {log} from '@jdeighan/coffee-utils/log'
+import {log, LOG} from '@jdeighan/coffee-utils/log'
 import {debug} from '@jdeighan/coffee-utils/debug'
 
 # ---------------------------------------------------------------------------
@@ -98,14 +99,36 @@ export backup = (file, from, to, report=false) ->
 	else
 		fs.copyFileSync(src, dest)
 
+# ---------------------------------------------------------------------------
+
+export forEachLineInFile = (filepath, func) ->
+
+	reader = new NReadLines(filepath)
+	nLines = 0
+
+	while (buffer = reader.next())
+		nLines += 1
+		# --- text is split on \n chars, we also need to remove \r chars
+		line = buffer.toString().replace(/\r/g, '')
+		if func(line, nLines) == 'EOF'
+			reader.close()   # allow premature termination
+	return
+
 # ---------------------------------------------------------------------------
 #   slurp - read an entire file into a string
 
-export slurp = (filepath) ->
+export slurp = (filepath, maxLines=undef) ->
 
 	debug "enter slurp('#{filepath}')"
-	filepath = filepath.replace(/\//g, "\\")
-	contents = fs.readFileSync(filepath, 'utf8').toString()
+	if maxLines?
+		lLines = []
+		forEachLineInFile filepath, (line, nLines) ->
+			lLines.push line
+			return if nLines >= maxLines then 'EOF' else undef
+		contents = lLines.join("\n")
+	else
+		filepath = filepath.replace(/\//g, "\\")
+		contents = fs.readFileSync(filepath, 'utf8').toString()
 	debug "return from slurp()", contents
 	return contents
 

package/src/fs_utils.js

@@ -6,6 +6,8 @@ import urllib from 'url';
 
 import fs from 'fs';
 
+import NReadLines from 'n-readlines';
+
 import {
   assert,
   undef,
@@ -20,7 +22,8 @@ import {
 } from '@jdeighan/coffee-utils';
 
 import {
-  log
+  log,
+  LOG
 } from '@jdeighan/coffee-utils/log';
 
 import {
@@ -117,13 +120,41 @@ export var backup = function(file, from, to, report = false) {
   }
 };
 
+// ---------------------------------------------------------------------------
+export var forEachLineInFile = function(filepath, func) {
+  var buffer, line, nLines, reader;
+  reader = new NReadLines(filepath);
+  nLines = 0;
+  while ((buffer = reader.next())) {
+    nLines += 1;
+    // --- text is split on \n chars, we also need to remove \r chars
+    line = buffer.toString().replace(/\r/g, '');
+    if (func(line, nLines) === 'EOF') {
+      reader.close(); // allow premature termination
+    }
+  }
+};
+
 // ---------------------------------------------------------------------------
 //   slurp - read an entire file into a string
-export var slurp = function(filepath) {
-  var contents;
+export var slurp = function(filepath, maxLines = undef) {
+  var contents, lLines;
   debug(`enter slurp('${filepath}')`);
-  filepath = filepath.replace(/\//g, "\\");
-  contents = fs.readFileSync(filepath, 'utf8').toString();
+  if (maxLines != null) {
+    lLines = [];
+    forEachLineInFile(filepath, function(line, nLines) {
+      lLines.push(line);
+      if (nLines >= maxLines) {
+        return 'EOF';
+      } else {
+        return undef;
+      }
+    });
+    contents = lLines.join("\n");
+  } else {
+    filepath = filepath.replace(/\//g, "\\");
+    contents = fs.readFileSync(filepath, 'utf8').toString();
+  }
   debug("return from slurp()", contents);
   return contents;
 };

package/src/log_utils.coffee

@@ -17,14 +17,15 @@ export id = 42
 # ---------------------------------------------------------------------------
 # This is useful for debugging and easy to remove after debugging
 
-export LOG = (item, label, ch='=') ->
+export LOG = (label, item, ch='=') ->
 
-	if label
+	if item
 		console.log ch.repeat(42)
 		console.log "[#{label}]:"
 		console.log untabify(orderedStringify(item))
+		console.log ch.repeat(42)
 	else
-		console.log item
+		console.log label
 	return
 
 # ---------------------------------------------------------------------------

package/src/log_utils.js

@@ -35,13 +35,14 @@ export var id = 42;
 
 // ---------------------------------------------------------------------------
 // This is useful for debugging and easy to remove after debugging
-export var LOG = function(item, label, ch = '=') {
-  if (label) {
+export var LOG = function(label, item, ch = '=') {
+  if (item) {
     console.log(ch.repeat(42));
     console.log(`[${label}]:`);
     console.log(untabify(orderedStringify(item)));
+    console.log(ch.repeat(42));
   } else {
-    console.log(item);
+    console.log(label);
   }
 };