@jdeighan/coffee-utils 14.0.36 → 14.0.38

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "14.0.36",
+	"version": "14.0.38",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -45,14 +45,14 @@
 	},
 	"homepage": "https://github.com/johndeighan/coffee-utils#readme",
 	"dependencies": {
-		"@jdeighan/base-utils": "^4.0.22",
+		"@jdeighan/base-utils": "^4.0.26",
 		"cross-env": "^7.0.3",
 		"n-readlines": "^1.0.1",
 		"readline-sync": "^1.4.10",
-		"svelte": "^3.55.1"
+		"svelte": "^3.58.0"
 	},
 	"devDependencies": {
-		"@jdeighan/unit-tester": "^3.0.43",
+		"@jdeighan/unit-tester": "^3.0.44",
 		"ava": "^5.2.0"
 	}
 }

package/src/fs.coffee

@@ -1,8 +1,13 @@
 # fs.coffee
 
+import os from 'os'
 import pathlib from 'path'
 import urllib from 'url'
 import fs from 'fs'
+import {
+	readFile, writeFile, rm,
+	} from 'node:fs/promises'
+import {execSync} from 'node:child_process'
 import readline from 'readline'
 import NReadLines from 'n-readlines'
 
@@ -16,6 +21,68 @@ import {LOG, LOGVALUE} from '@jdeighan/base-utils/log'
 import {dbg, dbgEnter, dbgReturn} from '@jdeighan/base-utils/debug'
 import {fromTAML} from '@jdeighan/base-utils/taml'
 
+# ---------------------------------------------------------------------------
+
+export mkpath = (lParts...) =>
+
+	# --- Ignore empty parts
+	lNewParts = []
+	for part in lParts
+		if nonEmpty(part)
+			lNewParts.push part
+
+	newPath = lNewParts.join('/').replaceAll('\\', '/')
+	if lMatches = newPath.match(/^([A-Z])\:(.*)$/)
+		[_, drive, rest] = lMatches
+		return "#{drive.toLowerCase()}:#{rest}"
+	else
+		return newPath
+
+# ---------------------------------------------------------------------------
+
+export mkdir = (dirpath) =>
+
+	try
+		fs.mkdirSync dirpath
+	catch err
+		if (err.code == 'EEXIST')
+			console.log 'Directory exists. Please choose another name'
+		else
+			console.log err
+		process.exit 1
+	return
+
+# ---------------------------------------------------------------------------
+
+export rmdir = (dirpath) =>
+
+	await rm dirpath, {recursive: true}
+	return
+
+# ---------------------------------------------------------------------------
+
+export rmfile = (filepath) =>
+
+	await rm filepath
+	return
+
+# --------------------------------------------------------------------------
+
+export execCmd = (cmdLine) =>
+
+	execSync cmdLine, {}, (error, stdout, stderr) =>
+		if (error)
+			LOG "ERROR in #{cmdLine}: #{error.code}"
+			process.exit 1
+	return stdout
+
+# ---------------------------------------------------------------------------
+
+export cloneRepo = (user, repo, dir) =>
+
+	git_repo = "https://github.com/#{user}/#{repo}.git"
+	return execCmd "git clone #{git_repo} #{dir}"
+
 # ---------------------------------------------------------------------------
 #    mydir() - pass argument import.meta.url and it will return
 #              the directory your file is in
@@ -29,6 +96,12 @@ export mydir = (url) =>
 
 # ---------------------------------------------------------------------------
 
+export homeDir = () =>
+
+	return mkpath(os.homedir())
+
+# ---------------------------------------------------------------------------
+
 export projRoot = (url) =>
 
 	dir = mydir(url)
@@ -108,23 +181,6 @@ export fileExt = (path) =>
 
 # ---------------------------------------------------------------------------
 
-export mkpath = (lParts...) =>
-
-	# --- Ignore empty parts
-	lNewParts = []
-	for part in lParts
-		if nonEmpty(part)
-			lNewParts.push part
-
-	newPath = lNewParts.join('/').replace(/\\/g, '/')
-	if lMatches = newPath.match(/^([A-Z])\:(.*)$/)
-		[_, drive, rest] = lMatches
-		return "#{drive.toLowerCase()}:#{rest}"
-	else
-		return newPath
-
-# ---------------------------------------------------------------------------
-
 export getFullPath = (filepath) =>
 
 	return mkpath(pathlib.resolve(filepath))
@@ -230,10 +286,11 @@ export forEachSetOfBlocks = (filepath, func,
 	return
 
 # ---------------------------------------------------------------------------
-#   slurp - read an entire file into a string
+#   slurp - read a file into a string
 
-export slurp = (filepath, maxLines=undef) =>
+export slurp = (filepath, hOptions={}) =>
 
+	{maxLines, format} = getOptions(hOptions)
 	if defined(maxLines)
 		lLines = []
 		forEachLineInFile filepath, (line, nLines) ->
@@ -243,20 +300,33 @@ export slurp = (filepath, maxLines=undef) =>
 	else
 		filepath = filepath.replace(/\//g, "\\")
 		contents = fs.readFileSync(filepath, 'utf8').toString()
-	return contents
+	switch format
+		when 'TAML'
+			return fromTAML(contents)
+		when 'JSON'
+			return JSON.parse(contents)
+		else
+			assert notdefined(format), "Unknown format: #{format}"
+			return contents
 
 # ---------------------------------------------------------------------------
 #   barf - write a string to a file
 
-export barf = (filepath, contents) =>
+export barf = (filepath, contents='', hOptions={}) =>
 
-	if isEmpty(contents)
-		return
-	if isArray(contents)
-		contents = toBlock(contents)
-	else if ! isString(contents)
-		croak "barf(): Invalid contents"
-	contents = rtrim(contents) + "\n"
+	{format} = getOptions(hOptions)
+	switch format
+		when 'TAML'
+			contents = toTAML(contents)
+		when 'JSON'
+			contents = JSON.stringify(contents, null, 3)
+		else
+			assert notdefined(format), "Unknown format: #{format}"
+			if isArray(contents)
+				contents = toBlock(contents)
+			else if ! isString(contents)
+				croak "barf(): Invalid contents"
+			contents = rtrim(contents) + "\n"
 	fs.writeFileSync(filepath, contents, {encoding: 'utf8'})
 	return
 
@@ -499,5 +569,4 @@ export parseSource = (source) =>
 
 export slurpTAML = (filepath) =>
 
-	contents = slurp(filepath)
-	return fromTAML(contents)
+	return slurp(filepath, {format: 'TAML'})

package/src/fs.js

@@ -2,12 +2,24 @@
 // fs.coffee
 var isSystemDir;
 
+import os from 'os';
+
 import pathlib from 'path';
 
 import urllib from 'url';
 
 import fs from 'fs';
 
+import {
+  readFile,
+  writeFile,
+  rm
+} from 'node:fs/promises';
+
+import {
+  execSync
+} from 'node:child_process';
+
 import readline from 'readline';
 
 import NReadLines from 'n-readlines';
@@ -51,6 +63,72 @@ import {
   fromTAML
 } from '@jdeighan/base-utils/taml';
 
+// ---------------------------------------------------------------------------
+export var mkpath = (...lParts) => {
+  var _, drive, i, lMatches, lNewParts, len, newPath, part, rest;
+  // --- Ignore empty parts
+  lNewParts = [];
+  for (i = 0, len = lParts.length; i < len; i++) {
+    part = lParts[i];
+    if (nonEmpty(part)) {
+      lNewParts.push(part);
+    }
+  }
+  newPath = lNewParts.join('/').replaceAll('\\', '/');
+  if (lMatches = newPath.match(/^([A-Z])\:(.*)$/)) {
+    [_, drive, rest] = lMatches;
+    return `${drive.toLowerCase()}:${rest}`;
+  } else {
+    return newPath;
+  }
+};
+
+// ---------------------------------------------------------------------------
+export var mkdir = (dirpath) => {
+  var err;
+  try {
+    fs.mkdirSync(dirpath);
+  } catch (error1) {
+    err = error1;
+    if (err.code === 'EEXIST') {
+      console.log('Directory exists. Please choose another name');
+    } else {
+      console.log(err);
+    }
+    process.exit(1);
+  }
+};
+
+// ---------------------------------------------------------------------------
+export var rmdir = async(dirpath) => {
+  await rm(dirpath, {
+    recursive: true
+  });
+};
+
+// ---------------------------------------------------------------------------
+export var rmfile = async(filepath) => {
+  await rm(filepath);
+};
+
+// --------------------------------------------------------------------------
+export var execCmd = (cmdLine) => {
+  execSync(cmdLine, {}, (error, stdout, stderr) => {
+    if (error) {
+      LOG(`ERROR in ${cmdLine}: ${error.code}`);
+      return process.exit(1);
+    }
+  });
+  return stdout;
+};
+
+// ---------------------------------------------------------------------------
+export var cloneRepo = (user, repo, dir) => {
+  var git_repo;
+  git_repo = `https://github.com/${user}/${repo}.git`;
+  return execCmd(`git clone ${git_repo} ${dir}`);
+};
+
 // ---------------------------------------------------------------------------
 //    mydir() - pass argument import.meta.url and it will return
 //              the directory your file is in
@@ -62,6 +140,11 @@ export var mydir = (url) => {
   return final;
 };
 
+// ---------------------------------------------------------------------------
+export var homeDir = () => {
+  return mkpath(os.homedir());
+};
+
 // ---------------------------------------------------------------------------
 export var projRoot = (url) => {
   var dir, rootDir;
@@ -99,7 +182,7 @@ export var getStats = (fullpath) => {
 export var isFile = (fullpath) => {
   try {
     return getStats(fullpath).isFile();
-  } catch (error) {
+  } catch (error1) {
     return false;
   }
 };
@@ -108,7 +191,7 @@ export var isFile = (fullpath) => {
 export var isDir = (fullpath) => {
   try {
     return getStats(fullpath).isDirectory();
-  } catch (error) {
+  } catch (error1) {
     return false;
   }
 };
@@ -142,26 +225,6 @@ export var fileExt = (path) => {
   }
 };
 
-// ---------------------------------------------------------------------------
-export var mkpath = (...lParts) => {
-  var _, drive, i, lMatches, lNewParts, len, newPath, part, rest;
-  // --- Ignore empty parts
-  lNewParts = [];
-  for (i = 0, len = lParts.length; i < len; i++) {
-    part = lParts[i];
-    if (nonEmpty(part)) {
-      lNewParts.push(part);
-    }
-  }
-  newPath = lNewParts.join('/').replace(/\\/g, '/');
-  if (lMatches = newPath.match(/^([A-Z])\:(.*)$/)) {
-    [_, drive, rest] = lMatches;
-    return `${drive.toLowerCase()}:${rest}`;
-  } else {
-    return newPath;
-  }
-};
-
 // ---------------------------------------------------------------------------
 export var getFullPath = (filepath) => {
   return mkpath(pathlib.resolve(filepath));
@@ -273,9 +336,10 @@ export var forEachSetOfBlocks = (filepath, func, block_regexp = /^-{16,}$/, set_
 };
 
 // ---------------------------------------------------------------------------
-//   slurp - read an entire file into a string
-export var slurp = (filepath, maxLines = undef) => {
-  var contents, lLines;
+//   slurp - read a file into a string
+export var slurp = (filepath, hOptions = {}) => {
+  var contents, format, lLines, maxLines;
+  ({maxLines, format} = getOptions(hOptions));
   if (defined(maxLines)) {
     lLines = [];
     forEachLineInFile(filepath, function(line, nLines) {
@@ -287,21 +351,38 @@ export var slurp = (filepath, maxLines = undef) => {
     filepath = filepath.replace(/\//g, "\\");
     contents = fs.readFileSync(filepath, 'utf8').toString();
   }
-  return contents;
+  switch (format) {
+    case 'TAML':
+      return fromTAML(contents);
+    case 'JSON':
+      return JSON.parse(contents);
+    default:
+      assert(notdefined(format), `Unknown format: ${format}`);
+      return contents;
+  }
 };
 
 // ---------------------------------------------------------------------------
 //   barf - write a string to a file
-export var barf = (filepath, contents) => {
-  if (isEmpty(contents)) {
-    return;
-  }
-  if (isArray(contents)) {
-    contents = toBlock(contents);
-  } else if (!isString(contents)) {
-    croak("barf(): Invalid contents");
+export var barf = (filepath, contents = '', hOptions = {}) => {
+  var format;
+  ({format} = getOptions(hOptions));
+  switch (format) {
+    case 'TAML':
+      contents = toTAML(contents);
+      break;
+    case 'JSON':
+      contents = JSON.stringify(contents, null, 3);
+      break;
+    default:
+      assert(notdefined(format), `Unknown format: ${format}`);
+      if (isArray(contents)) {
+        contents = toBlock(contents);
+      } else if (!isString(contents)) {
+        croak("barf(): Invalid contents");
+      }
+      contents = rtrim(contents) + "\n";
   }
-  contents = rtrim(contents) + "\n";
   fs.writeFileSync(filepath, contents, {
     encoding: 'utf8'
   });
@@ -333,8 +414,8 @@ export var removeFileWithExt = (path, newExt, hOptions = {}) => {
       LOG(`   unlink ${filename}`);
     }
     success = true;
-  } catch (error) {
-    err = error;
+  } catch (error1) {
+    err = error1;
     LOG(`   UNLINK FAILED: ${err.message}`);
     success = false;
   }
@@ -576,7 +657,7 @@ export var parseSource = (source) => {
 // ---------------------------------------------------------------------------
 //   slurpTAML - read TAML from a file
 export var slurpTAML = (filepath) => {
-  var contents;
-  contents = slurp(filepath);
-  return fromTAML(contents);
+  return slurp(filepath, {
+    format: 'TAML'
+  });
 };