@jdeighan/coffee-utils 14.0.37 → 15.0.0

package/package.json

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

package/src/fs.coffee

@@ -1,10 +1,11 @@
 # fs.coffee
 
+import os from 'os'
 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'
@@ -20,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...) =>
@@ -30,7 +40,7 @@ export mkpath = (lParts...) =>
 		if nonEmpty(part)
 			lNewParts.push part
 
-	newPath = lNewParts.join('/').replace(/\\/g, '/')
+	newPath = lNewParts.join('/').replaceAll('\\', '/')
 	if lMatches = newPath.match(/^([A-Z])\:(.*)$/)
 		[_, drive, rest] = lMatches
 		return "#{drive.toLowerCase()}:#{rest}"
@@ -39,7 +49,7 @@ export mkpath = (lParts...) =>
 
 # ---------------------------------------------------------------------------
 
-export mkdir = (dirpath) =>
+export mkdirSync = (dirpath) =>
 
 	try
 		fs.mkdirSync dirpath
@@ -53,41 +63,88 @@ export mkdir = (dirpath) =>
 
 # ---------------------------------------------------------------------------
 
-export mkfile = (filepath, contents='') =>
+export rmDir = (dirpath) =>
 
-	await writeFile filepath, contents
+	await rmdir dirpath, {recursive: true}
 	return
 
 # ---------------------------------------------------------------------------
 
-export rmdir = (dirpath) =>
+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 cdTo = (dirpath) =>
+export rmFileSync = (filepath) =>
 
-	process.chdir dirpath
-	return process.cwd()
+	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 cdToUserDir = (lSubDirs...) =>
+# --------------------------------------------------------------------------
+
+export fixFileSync = (filepath, func) =>
 
-	return cd(mkpath('~', lSubDirs...))
+	contents = fs.readFileSync(filepath, {encoding: 'utf8'})
+	output = func(contents) # returns modified contents
+	output = fixOutput(output)
+	fs.writeFileSync(filepath, output, {encoding: 'utf8'})
+	return
 
 # --------------------------------------------------------------------------
 
-export execCmd = (cmdLine) =>
+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 execCmdSync = (cmdLine) =>
 
 	execSync cmdLine, {}, (error, stdout, stderr) =>
 		if (error)
@@ -102,20 +159,6 @@ export cloneRepo = (user, repo, dir) =>
 	git_repo = "https://github.com/#{user}/#{repo}.git"
 	return execCmd "git clone #{git_repo} #{dir}"
 
-# ---------------------------------------------------------------------------
-
-export getPkgJson = (filepath) =>
-
-	jsonTxt = fs.readFileSync(filepath, {encoding: 'utf8'})
-	hJson = JSON.parse jsonTxt
-	return
-
-# ---------------------------------------------------------------------------
-
-export putPkgJson = (filepath, hJson) =>
-
-	return
-
 # ---------------------------------------------------------------------------
 #    mydir() - pass argument import.meta.url and it will return
 #              the directory your file is in
@@ -129,6 +172,12 @@ export mydir = (url) =>
 
 # ---------------------------------------------------------------------------
 
+export homeDir = () =>
+
+	return mkpath(os.homedir())
+
+# ---------------------------------------------------------------------------
+
 export projRoot = (url) =>
 
 	dir = mydir(url)
@@ -353,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,8 @@
 // Generated by CoffeeScript 2.7.0
 // fs.coffee
-var isSystemDir;
+var fix, isSystemDir;
+
+import os from 'os';
 
 import pathlib from 'path';
 
@@ -11,7 +13,8 @@ import fs from 'fs';
 import {
   readFile,
   writeFile,
-  rm
+  rm,
+  rmdir //  rmSync, rmdirSync,
 } from 'node:fs/promises';
 
 import {
@@ -61,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;
@@ -72,7 +82,7 @@ export var mkpath = (...lParts) => {
       lNewParts.push(part);
     }
   }
-  newPath = lNewParts.join('/').replace(/\\/g, '/');
+  newPath = lNewParts.join('/').replaceAll('\\', '/');
   if (lMatches = newPath.match(/^([A-Z])\:(.*)$/)) {
     [_, drive, rest] = lMatches;
     return `${drive.toLowerCase()}:${rest}`;
@@ -82,7 +92,7 @@ export var mkpath = (...lParts) => {
 };
 
 // ---------------------------------------------------------------------------
-export var mkdir = (dirpath) => {
+export var mkdirSync = (dirpath) => {
   var err;
   try {
     fs.mkdirSync(dirpath);
@@ -98,35 +108,96 @@ export var mkdir = (dirpath) => {
 };
 
 // ---------------------------------------------------------------------------
-export var mkfile = async(filepath, contents = '') => {
-  await writeFile(filepath, contents);
+export var rmDir = async(dirpath) => {
+  await rmdir(dirpath, {
+    recursive: true
+  });
 };
 
 // ---------------------------------------------------------------------------
-export var rmdir = async(dirpath) => {
-  await rm(dirpath, {
+export var rmDirSync = (dirpath) => {
+  fs.rmdirSync(dirpath, {
     recursive: true
   });
 };
 
 // ---------------------------------------------------------------------------
-export var rmfile = async(filepath) => {
+export var rmFile = async(filepath) => {
   await rm(filepath);
 };
 
 // ---------------------------------------------------------------------------
-export var cdTo = (dirpath) => {
-  process.chdir(dirpath);
-  return process.cwd();
+export var rmFileSync = (filepath) => {
+  fs.rmSync(filepath);
 };
 
-// ---------------------------------------------------------------------------
-export var cdToUserDir = (...lSubDirs) => {
-  return cd(mkpath('~', ...lSubDirs));
+// --------------------------------------------------------------------------
+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 execCmd = (cmdLine) => {
+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 execCmdSync = (cmdLine) => {
   execSync(cmdLine, {}, (error, stdout, stderr) => {
     if (error) {
       LOG(`ERROR in ${cmdLine}: ${error.code}`);
@@ -143,18 +214,6 @@ export var cloneRepo = (user, repo, dir) => {
   return execCmd(`git clone ${git_repo} ${dir}`);
 };
 
-// ---------------------------------------------------------------------------
-export var getPkgJson = (filepath) => {
-  var hJson, jsonTxt;
-  jsonTxt = fs.readFileSync(filepath, {
-    encoding: 'utf8'
-  });
-  hJson = JSON.parse(jsonTxt);
-};
-
-// ---------------------------------------------------------------------------
-export var putPkgJson = (filepath, hJson) => {};
-
 // ---------------------------------------------------------------------------
 //    mydir() - pass argument import.meta.url and it will return
 //              the directory your file is in
@@ -166,6 +225,11 @@ export var mydir = (url) => {
   return final;
 };
 
+// ---------------------------------------------------------------------------
+export var homeDir = () => {
+  return mkpath(os.homedir());
+};
+
 // ---------------------------------------------------------------------------
 export var projRoot = (url) => {
   var dir, rootDir;
@@ -402,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'