@jdeighan/coffee-utils 11.0.21 → 11.0.23

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "11.0.21",
+	"version": "11.0.23",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -32,7 +32,7 @@
 		"verbose": false
 	},
 	"scripts": {
-		"build": "cls && rm -f ./src/*.js && coffee -c ./src",
+		"build": "cls && rm -f ./*.js && coffee -c .",
 		"pretest": "cls && cielo -qfc ./test && coffee -c .",
 		"test": "npm run build && ava ./test/*.test.js && git status"
 	},
@@ -50,7 +50,7 @@
 	},
 	"homepage": "https://github.com/johndeighan/coffee-utils#readme",
 	"dependencies": {
-		"@jdeighan/exceptions": "^1.0.18",
+		"@jdeighan/exceptions": "^1.0.19",
 		"cross-env": "^7.0.3",
 		"js-yaml": "^4.1.0",
 		"n-readlines": "^1.0.1",
@@ -58,6 +58,6 @@
 		"svelte": "^3.52.0"
 	},
 	"devDependencies": {
-		"@jdeighan/unit-tester": "^2.0.42"
+		"@jdeighan/unit-tester": "^2.0.43"
 	}
 }

package/src/fs.coffee

@@ -7,7 +7,7 @@ import NReadLines from 'n-readlines'
 
 import {assert, croak, LOG, fromTAML} from '@jdeighan/exceptions'
 import {
-	undef, pass, defined, rtrim, isEmpty, nonEmpty,
+	undef, pass, defined, rtrim, isEmpty, nonEmpty, getOptions,
 	isString, isArray, isHash, isRegExp, isFunction, OL,
 	} from '@jdeighan/coffee-utils'
 import {arrayToBlock} from '@jdeighan/coffee-utils/block'
@@ -23,6 +23,15 @@ export mydir = (url) ->
 	final = mkpath(dir)
 	return final
 
+# ---------------------------------------------------------------------------
+
+export projRoot = (url) ->
+
+	dir = mydir(url)
+	rootDir = pathTo('package.json', dir, 'direction=up directory')
+	assert defined(rootDir), "No project root directory found"
+	return rootDir
+
 # ---------------------------------------------------------------------------
 #    myfile() - pass argument import.meta.url and it will return
 #               the name of your file
@@ -44,18 +53,25 @@ export myfullpath = (url) ->
 
 # ---------------------------------------------------------------------------
 
+export getStats = (fullpath) ->
+
+	return fs.lstatSync(fullpath)
+
+# ---------------------------------------------------------------------------
+
 export isFile = (fullpath) ->
 
-	return fs.lstatSync(fullpath).isFile()
+	try
+		return getStats(fullpath).isFile()
+	catch
+		return false
 
 # ---------------------------------------------------------------------------
 
 export isDir = (fullpath) ->
 
 	try
-		obj = fs.lstatSync(fullpath)
-		if !obj? then return false
-		return obj.isDirectory()
+		return getStats(fullpath).isDirectory()
 	catch
 		return false
 
@@ -253,41 +269,49 @@ export forEachFile = (dir, cb, filt=undef, level=0) ->
 
 # ---------------------------------------------------------------------------
 
-export pathTo = (fname, searchDir, hOptions={}) ->
+export pathTo = (fname, searchDir, options=undef) ->
 
-	{direction, relative} = hOptions
-	if isEmpty(direction)
-		direction = 'down'
-	if isEmpty(relative)
-		relative = false
+	{direction, relative, directory} = getOptions(options, {
+		direction: 'down'
+		relative: false
+		directory: false    # return only the directory the file is in
+		})
 
+	assert !(relative && directory), "relative & directory are incompatible"
 	if ! searchDir
 		searchDir = process.cwd()
-	assert fs.existsSync(searchDir), "Dir #{searchDir} does not exist"
+	assert isDir(searchDir), "Not a directory: #{OL(searchDir)}"
 	filepath = mkpath(searchDir, fname)
-	if fs.existsSync(filepath)
+	if isFile(filepath)
 		if relative
-			filepath = "./#{fname}"
-		return filepath
+			return "./#{fname}"
+		else if directory
+			return searchDir
+		else
+			return filepath
 
 	if (direction == 'down')
 		# --- Search all directories in this directory
 		#     getSubDirs() returns dirs sorted alphabetically
 		for subdir in getSubDirs(searchDir)
-			dirpath = mkpath(searchDir, subdir)
-			if defined(fpath = pathTo(fname, dirpath, hOptions))
+			dirPath = mkpath(searchDir, subdir)
+			if defined(fpath = pathTo(fname, dirPath, options))
 				if relative
-					fpath = fpath.replace('./', "./#{subdir}/")
-				return fpath
+					return fpath.replace('./', "./#{subdir}/")
+				else if directory
+					return dirPath
+				else
+					return fpath
 	else if (direction == 'up')
 		nLevels = 0
 		while defined(dirPath = getParentDir(searchDir))
 			nLevels += 1
 			fpath = mkpath(dirPath, fname)
-			if fs.existsSync(fpath)
+			if isFile(fpath)
 				if relative
-					fpath = "../".repeat(nLevels) + fname
-					return fpath
+					return "../".repeat(nLevels) + fname
+				else if directory
+					return dirPath
 				else
 					return fpath
 			searchDir = dirPath

package/src/fs.js

@@ -24,6 +24,7 @@ import {
   rtrim,
   isEmpty,
   nonEmpty,
+  getOptions,
   isString,
   isArray,
   isHash,
@@ -47,6 +48,15 @@ export var mydir = function(url) {
   return final;
 };
 
+// ---------------------------------------------------------------------------
+export var projRoot = function(url) {
+  var dir, rootDir;
+  dir = mydir(url);
+  rootDir = pathTo('package.json', dir, 'direction=up directory');
+  assert(defined(rootDir), "No project root directory found");
+  return rootDir;
+};
+
 // ---------------------------------------------------------------------------
 //    myfile() - pass argument import.meta.url and it will return
 //               the name of your file
@@ -66,20 +76,24 @@ export var myfullpath = function(url) {
   return mkpath(path);
 };
 
+// ---------------------------------------------------------------------------
+export var getStats = function(fullpath) {
+  return fs.lstatSync(fullpath);
+};
+
 // ---------------------------------------------------------------------------
 export var isFile = function(fullpath) {
-  return fs.lstatSync(fullpath).isFile();
+  try {
+    return getStats(fullpath).isFile();
+  } catch (error) {
+    return false;
+  }
 };
 
 // ---------------------------------------------------------------------------
 export var isDir = function(fullpath) {
-  var obj;
   try {
-    obj = fs.lstatSync(fullpath);
-    if (obj == null) {
-      return false;
-    }
-    return obj.isDirectory();
+    return getStats(fullpath).isDirectory();
   } catch (error) {
     return false;
   }
@@ -308,25 +322,27 @@ export var forEachFile = function(dir, cb, filt = undef, level = 0) {
 };
 
 // ---------------------------------------------------------------------------
-export var pathTo = function(fname, searchDir, hOptions = {}) {
-  var dirPath, direction, dirpath, filepath, fpath, i, len, nLevels, ref, relative, subdir;
-  ({direction, relative} = hOptions);
-  if (isEmpty(direction)) {
-    direction = 'down';
-  }
-  if (isEmpty(relative)) {
-    relative = false;
-  }
+export var pathTo = function(fname, searchDir, options = undef) {
+  var dirPath, direction, directory, filepath, fpath, i, len, nLevels, ref, relative, subdir;
+  ({direction, relative, directory} = getOptions(options, {
+    direction: 'down',
+    relative: false,
+    directory: false // return only the directory the file is in
+  }));
+  assert(!(relative && directory), "relative & directory are incompatible");
   if (!searchDir) {
     searchDir = process.cwd();
   }
-  assert(fs.existsSync(searchDir), `Dir ${searchDir} does not exist`);
+  assert(isDir(searchDir), `Not a directory: ${OL(searchDir)}`);
   filepath = mkpath(searchDir, fname);
-  if (fs.existsSync(filepath)) {
+  if (isFile(filepath)) {
     if (relative) {
-      filepath = `./${fname}`;
+      return `./${fname}`;
+    } else if (directory) {
+      return searchDir;
+    } else {
+      return filepath;
     }
-    return filepath;
   }
   if (direction === 'down') {
     ref = getSubDirs(searchDir);
@@ -334,12 +350,15 @@ export var pathTo = function(fname, searchDir, hOptions = {}) {
     //     getSubDirs() returns dirs sorted alphabetically
     for (i = 0, len = ref.length; i < len; i++) {
       subdir = ref[i];
-      dirpath = mkpath(searchDir, subdir);
-      if (defined(fpath = pathTo(fname, dirpath, hOptions))) {
+      dirPath = mkpath(searchDir, subdir);
+      if (defined(fpath = pathTo(fname, dirPath, options))) {
         if (relative) {
-          fpath = fpath.replace('./', `./${subdir}/`);
+          return fpath.replace('./', `./${subdir}/`);
+        } else if (directory) {
+          return dirPath;
+        } else {
+          return fpath;
         }
-        return fpath;
       }
     }
   } else if (direction === 'up') {
@@ -347,10 +366,11 @@ export var pathTo = function(fname, searchDir, hOptions = {}) {
     while (defined(dirPath = getParentDir(searchDir))) {
       nLevels += 1;
       fpath = mkpath(dirPath, fname);
-      if (fs.existsSync(fpath)) {
+      if (isFile(fpath)) {
         if (relative) {
-          fpath = "../".repeat(nLevels) + fname;
-          return fpath;
+          return "../".repeat(nLevels) + fname;
+        } else if (directory) {
+          return dirPath;
         } else {
           return fpath;
         }

package/temp.js

@@ -1,26 +0,0 @@
-// Generated by CoffeeScript 2.6.1
-// temp.coffee
-var dir;
-
-import {
-  say
-} from '@jdeighan/coffee-utils';
-
-import {
-  log
-} from '@jdeighan/coffee-utils/log';
-
-import {
-  setDebugging
-} from '@jdeighan/coffee-utils/debug';
-
-import {
-  mydir,
-  mkpath
-} from '@jdeighan/coffee-utils/fs';
-
-setDebugging(true);
-
-dir = mydir(import.meta.url);
-
-say(`dir = ${dir}`);