@jdeighan/coffee-utils 5.0.4 → 6.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "5.0.4",
+	"version": "6.0.1",
 	"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/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

@@ -4,7 +4,7 @@ import yaml from 'js-yaml'
 
 import {
 	assert, undef, isNumber, isInteger, isString, isHash, isFunction,
-	escapeStr, sep_eq,
+	escapeStr, sep_eq, sep_dash
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
 import {tabify, untabify} from '@jdeighan/coffee-utils/indent'
@@ -17,9 +17,15 @@ export id = 42
 # ---------------------------------------------------------------------------
 # This is useful for debugging and easy to remove after debugging
 
-export LOG = (lArgs...) ->
+export LOG = (label, item, ch='=') ->
 
-	console.log lArgs...
+	if item
+		console.log ch.repeat(42)
+		console.log "[#{label}]:"
+		console.log untabify(orderedStringify(item))
+		console.log ch.repeat(42)
+	else
+		console.log label
 	return
 
 # ---------------------------------------------------------------------------

package/src/log_utils.js

@@ -13,7 +13,8 @@ import {
   isHash,
   isFunction,
   escapeStr,
-  sep_eq
+  sep_eq,
+  sep_dash
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -34,8 +35,15 @@ export var id = 42;
 
 // ---------------------------------------------------------------------------
 // This is useful for debugging and easy to remove after debugging
-export var LOG = function(...lArgs) {
-  console.log(...lArgs);
+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(label);
+  }
 };
 
 // ---------------------------------------------------------------------------