@jdeighan/coffee-utils 14.0.38 → 15.0.0

package/package.json

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

package/src/fs.coffee

@@ -5,7 +5,7 @@ import pathlib from 'path'
 import urllib from 'url'
 import fs from 'fs'
 import {
-	readFile, writeFile, rm,
+	readFile, writeFile, rm, rmdir,   #  rmSync, rmdirSync,
 	} from 'node:fs/promises'
 import {execSync} from 'node:child_process'
 import readline from 'readline'
@@ -21,6 +21,15 @@ import {LOG, LOGVALUE} from '@jdeighan/base-utils/log'
 import {dbg, dbgEnter, dbgReturn} from '@jdeighan/base-utils/debug'
 import {fromTAML} from '@jdeighan/base-utils/taml'
 
+fix = true
+
+# ---------------------------------------------------------------------------
+
+export doFixOutput = (flag=true) =>
+
+	fix = flag
+	return
+
 # ---------------------------------------------------------------------------
 
 export mkpath = (lParts...) =>
@@ -40,7 +49,7 @@ export mkpath = (lParts...) =>
 
 # ---------------------------------------------------------------------------
 
-export mkdir = (dirpath) =>
+export mkdirSync = (dirpath) =>
 
 	try
 		fs.mkdirSync dirpath
@@ -54,21 +63,88 @@ export mkdir = (dirpath) =>
 
 # ---------------------------------------------------------------------------
 
-export rmdir = (dirpath) =>
+export rmDir = (dirpath) =>
+
+	await rmdir dirpath, {recursive: true}
+	return
+
+# ---------------------------------------------------------------------------
+
+export rmDirSync = (dirpath) =>
 
-	await rm dirpath, {recursive: true}
+	fs.rmdirSync dirpath, {recursive: true}
 	return
 
 # ---------------------------------------------------------------------------
 
-export rmfile = (filepath) =>
+export rmFile = (filepath) =>
 
 	await rm filepath
 	return
 
+# ---------------------------------------------------------------------------
+
+export rmFileSync = (filepath) =>
+
+	fs.rmSync filepath
+	return
+
+# --------------------------------------------------------------------------
+
+export fixOutput = (contents) =>
+
+	if fix
+		return rtrim(contents) + "\n"
+	else
+		return contents
+
+# --------------------------------------------------------------------------
+
+export fixFile = (filepath, func) =>
+
+	contents = await readFile(filepath, {encoding: 'utf8'})
+	output = func(contents) # returns modified contents
+	output = fixOutput(output)
+	await writeFile(filepath, output, {encoding: 'utf8'})
+	return
+
+# --------------------------------------------------------------------------
+
+export fixJson = (filepath, func) =>
+
+	contents = await readFile(filepath, {encoding: 'utf8'})
+	hJson = JSON.parse(contents)
+	func(hJson)   # modify in place
+	output = JSON.stringify(hJson, null, 3)
+	output = fixOutput(output)
+	await writeFile(filepath, output, {encoding: 'utf8'})
+	return
+
+# --------------------------------------------------------------------------
+
+export fixFileSync = (filepath, func) =>
+
+	contents = fs.readFileSync(filepath, {encoding: 'utf8'})
+	output = func(contents) # returns modified contents
+	output = fixOutput(output)
+	fs.writeFileSync(filepath, output, {encoding: 'utf8'})
+	return
+
+# --------------------------------------------------------------------------
+
+export fixJsonSync = (filepath, func) =>
+
+	contents = fs.readFileSync(filepath, {encoding: 'utf8'})
+	hJson = JSON.parse(contents)
+	func(hJson)   # modify in place
+	output = JSON.stringify(hJson, null, 3)
+	output = fixOutput(output)
+	fs.writeFileSync(filepath, output, {encoding: 'utf8'})
+	return
+
 # --------------------------------------------------------------------------
 
-export execCmd = (cmdLine) =>
+export execCmdSync = (cmdLine) =>
 
 	execSync cmdLine, {}, (error, stdout, stderr) =>
 		if (error)
@@ -326,7 +402,7 @@ export barf = (filepath, contents='', hOptions={}) =>
 				contents = toBlock(contents)
 			else if ! isString(contents)
 				croak "barf(): Invalid contents"
-			contents = rtrim(contents) + "\n"
+			contents = fixOutput(contents)
 	fs.writeFileSync(filepath, contents, {encoding: 'utf8'})
 	return
 

package/src/fs.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.7.0
 // fs.coffee
-var isSystemDir;
+var fix, isSystemDir;
 
 import os from 'os';
 
@@ -13,7 +13,8 @@ import fs from 'fs';
 import {
   readFile,
   writeFile,
-  rm
+  rm,
+  rmdir //  rmSync, rmdirSync,
 } from 'node:fs/promises';
 
 import {
@@ -63,6 +64,13 @@ import {
   fromTAML
 } from '@jdeighan/base-utils/taml';
 
+fix = true;
+
+// ---------------------------------------------------------------------------
+export var doFixOutput = (flag = true) => {
+  fix = flag;
+};
+
 // ---------------------------------------------------------------------------
 export var mkpath = (...lParts) => {
   var _, drive, i, lMatches, lNewParts, len, newPath, part, rest;
@@ -84,7 +92,7 @@ export var mkpath = (...lParts) => {
 };
 
 // ---------------------------------------------------------------------------
-export var mkdir = (dirpath) => {
+export var mkdirSync = (dirpath) => {
   var err;
   try {
     fs.mkdirSync(dirpath);
@@ -100,19 +108,96 @@ export var mkdir = (dirpath) => {
 };
 
 // ---------------------------------------------------------------------------
-export var rmdir = async(dirpath) => {
-  await rm(dirpath, {
+export var rmDir = async(dirpath) => {
+  await rmdir(dirpath, {
+    recursive: true
+  });
+};
+
+// ---------------------------------------------------------------------------
+export var rmDirSync = (dirpath) => {
+  fs.rmdirSync(dirpath, {
     recursive: true
   });
 };
 
 // ---------------------------------------------------------------------------
-export var rmfile = async(filepath) => {
+export var rmFile = async(filepath) => {
   await rm(filepath);
 };
 
+// ---------------------------------------------------------------------------
+export var rmFileSync = (filepath) => {
+  fs.rmSync(filepath);
+};
+
+// --------------------------------------------------------------------------
+export var fixOutput = (contents) => {
+  if (fix) {
+    return rtrim(contents) + "\n";
+  } else {
+    return contents;
+  }
+};
+
+// --------------------------------------------------------------------------
+export var fixFile = async(filepath, func) => {
+  var contents, output;
+  contents = (await readFile(filepath, {
+    encoding: 'utf8'
+  }));
+  output = func(contents); // returns modified contents
+  output = fixOutput(output);
+  await writeFile(filepath, output, {
+    encoding: 'utf8'
+  });
+};
+
+// --------------------------------------------------------------------------
+export var fixJson = async(filepath, func) => {
+  var contents, hJson, output;
+  contents = (await readFile(filepath, {
+    encoding: 'utf8'
+  }));
+  hJson = JSON.parse(contents);
+  func(hJson); // modify in place
+  output = JSON.stringify(hJson, null, 3);
+  output = fixOutput(output);
+  await writeFile(filepath, output, {
+    encoding: 'utf8'
+  });
+};
+
+// --------------------------------------------------------------------------
+export var fixFileSync = (filepath, func) => {
+  var contents, output;
+  contents = fs.readFileSync(filepath, {
+    encoding: 'utf8'
+  });
+  output = func(contents); // returns modified contents
+  output = fixOutput(output);
+  fs.writeFileSync(filepath, output, {
+    encoding: 'utf8'
+  });
+};
+
+// --------------------------------------------------------------------------
+export var fixJsonSync = (filepath, func) => {
+  var contents, hJson, output;
+  contents = fs.readFileSync(filepath, {
+    encoding: 'utf8'
+  });
+  hJson = JSON.parse(contents);
+  func(hJson); // modify in place
+  output = JSON.stringify(hJson, null, 3);
+  output = fixOutput(output);
+  fs.writeFileSync(filepath, output, {
+    encoding: 'utf8'
+  });
+};
+
 // --------------------------------------------------------------------------
-export var execCmd = (cmdLine) => {
+export var execCmdSync = (cmdLine) => {
   execSync(cmdLine, {}, (error, stdout, stderr) => {
     if (error) {
       LOG(`ERROR in ${cmdLine}: ${error.code}`);
@@ -381,7 +466,7 @@ export var barf = (filepath, contents = '', hOptions = {}) => {
       } else if (!isString(contents)) {
         croak("barf(): Invalid contents");
       }
-      contents = rtrim(contents) + "\n";
+      contents = fixOutput(contents);
   }
   fs.writeFileSync(filepath, contents, {
     encoding: 'utf8'