jupyter-ijavascript-utils 1.15.2 → 1.16.1

package/DOCS.md

@@ -46,6 +46,7 @@ This is not intended to be the only way to accomplish many of these tasks, and a
 
 ## What's New
 
+* 1.16 - provide file.matchFiles - as a way to find files or directories
 * 1.15 - provide {@link module:object.formatProperties|object.formatProperties} - as a way to quickly convert to string, number, etc.
 * 1.14 - provide {@link module:object.mapProperties|object.mapProperties()} and {@link module:format.compactNumber|format.compactNumber()}
 * 1.13 - provide {@link module:random|utils.random()} to genrate random values

package/README.md

@@ -46,6 +46,7 @@ This is not intended to be the only way to accomplish many of these tasks, and a
 
 # What's New
 
+* 1.16 - provide file.matchFiles - as a way to find files or directories
 * 1.15 - provide object.formatProperties - as a way to quickly convert to string, number, etc.
 * 1.14 - provide format.compactNumber and object.mapProperties
 * 1.13 - provide utils.random() to genrate random values

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.15.2",
+  "version": "1.16.1",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "homepage": "https://jupyter-ijavascript-utils.onrender.com/",
   "license": "MIT",

package/src/file.js

@@ -26,6 +26,7 @@ const logger = require('./logger');
  * * listing directory
  *   * {@link module:file.pwd|pwd()} - list the current path
  *   * {@link module:file.listFiles|listFiles(path)} - list files in a diven path
+ *   * {@link module:file.matchFiles|matchFiles(path, matchingFn)} - find files or directories with a matching fn
  * * checking files exist
  *   * {@link module:file.checkFile|checkFile(...paths)} - check if a file at a path exists
  * 
@@ -279,12 +280,13 @@ module.exports.pwd = function pwd() {
  * List files in a directory
  * 
  * @param {String} directoryPath - path of the directory to list
+ * @param {Object} [readdirOptions=null] - object with options to pass to fs readdir
  * @see {@link module:file.pwd|pwd()} - to get the current working directory
  * @example
  * utils.file.listFiles('./');
  * // ['.gitignore', 'data', ... ];
  */
-module.exports.listFiles = function listFiles(directoryPath) {
+module.exports.listFiles = function listFiles(directoryPath, readdirOptions = null) {
   const resolvedPath = path.resolve(directoryPath);
   if (!fs.existsSync(resolvedPath)) {
     logger.error('Path does not exist: %s', resolvedPath);
@@ -295,13 +297,65 @@ module.exports.listFiles = function listFiles(directoryPath) {
   }
 
   try {
-    const results = fs.readdirSync(resolvedPath);
+    const results = fs.readdirSync(resolvedPath, readdirOptions);
     return results;
   } catch (err) {
     logger.error(`unable to read directory: ${resolvedPath}`);
   }
 };
 
+/**
+ * Finds files in a directory, returning only the file names and paths of those that match a function.
+ * 
+ * Note the matching function passes both fileNames and {@link https://nodejs.org/api/fs.html#class-fsdirent|DirEnt} objects<br />
+ * {(fileName:String, file:{@link https://nodejs.org/api/fs.html#class-fsdirent|DirEnt}) => Boolean}<br />
+ * allowing for checking for files:`.isFile()`, directories:`.isDirectory()`, symbolic links:`.isSymbolicLink()`, etc.
+ * 
+ * For example, if there is a `./tmp` folder, with:
+ * 
+ * * ./tmp/fileA (file)
+ * * ./tmp/fileB (file)
+ * * ./tmp/dirA  (directory)
+ * * ./tmp/dirB  (directory)
+ * 
+ * You could find only files like the following:
+ * 
+ * ```
+ * utils.file.matchFiles('./tmp', (fileName, file) => file.isFile());
+ * // ['./tmp/fileA', './tmp/fileB'];
+ * ```
+ * 
+ * or find directories ending with the letter B:
+ * 
+ * ```
+ * utils.file.matchFiles('./tmp',
+ *  (fileName, file) => file.isDirectory() && fileName.endsWith('B')
+ * );
+ * // ['./tmp/dirB'];
+ * ```
+ * 
+ * Note: passing false as the last parameter will only return file names
+ * 
+ * ```
+ * utils.file.matchFiles('./tmp', (fileName) => fileName.startsWith('file'), false);
+ * // ['fileA', 'fileB']
+ * ```
+ * 
+ * @param {String} directoryPath - path of the directory to match within
+ * @param {Function} matchingFunction - (DirEnt) => Boolean function to determine
+ *  if the path should be returned or not
+ * @param {Boolean} [returnFullPath=true] - whether the full path should be returned
+ * @returns {String[]} - list of the files that match 
+
+ */
+module.exports.matchFiles = function matchFiles(directoryPath, matchingFunction, returnFullPath = true) {
+  return FileUtil.listFiles(directoryPath, { withFileTypes: true })
+    .filter((dirExt) => matchingFunction(dirExt.name, dirExt))
+    .map((dirExt) => returnFullPath
+      ? path.resolve(directoryPath, dirExt.name)
+      : dirExt.name);
+};
+
 /**
  * Synchronously checks if any of the files provided do not exist.
  * 

package/src/object.js

@@ -206,10 +206,12 @@ module.exports.augment = function augment(objCollection, mappingFn, inPlace = fa
  */
 module.exports.mapByProperty = function mapByProperty(collection, propertyName) {
   if (!propertyName) throw new Error('object.mapByProperty: expects a propertyName');
+
+  const cleanedFunc = ObjectUtils.evaluateFunctionOrProperty(propertyName);
   
   return (collection || []).reduce(
     (result, entry) => {
-      result.set(entry[propertyName], entry);
+      result.set(cleanedFunc(entry), entry);
       return result;
     }, new Map()
   );

package/src/plantuml.js

@@ -1,5 +1,4 @@
-/* global fetch */
-/* eslint-disable no-empty, class-methods-use-this */
+/* eslint-disable no-empty, class-methods-use-this, no-redeclare */
 
 //-- encode the strings into the format needed for the plantuml server
 const plantUMLEncoder = require('plantuml-encoder');