@magic/fs 0.0.27 → 0.0.29

package/README.md

@@ -12,12 +12,15 @@ exports all fs.promises + exists + mkdirp + rmrf + getFiles + getDirs functions.
 [html-docs](https://magic.github.io/fs)
 
 ### installation
+
 be in a nodejs project
+
 ```bash
 npm install @magic/fs
 ```
 
 ### import
+
 ```javascript
 import fs from '@magic/fs'
 
@@ -31,7 +34,9 @@ run()
 ```
 
 ### promises
+
 promises from fs:
+
 ```
 access
 copyFile
@@ -65,6 +70,7 @@ rmDir
 ```
 
 ### export overloads:
+
 ```javascript
 rmdir, rmDir
 readfile, readFile
@@ -74,6 +80,7 @@ readdir, readDir
 ### Additional functions:
 
 #### mkdirp
+
 same as mkdir -p on unix
 
 ```javascript
@@ -81,17 +88,21 @@ await fs.mkdirp('./path/to/dir')
 ```
 
 #### rmrf
+
 same as rm -rf on unix.
 
 **will not work outside process.cwd()**
+
 ```javascript
 await fs.rmrf('./path/to/dir')
 ```
 
 #### exists
+
 same as fs.exists, but promisified and ready for esmodules.
 
 #### getDirectories
+
 get a list of directories in a directory,
 recursively.
 
@@ -122,6 +133,7 @@ run()
 ```
 
 #### getFiles
+
 get a list of files in a directory,
 recursively.
 
@@ -145,6 +157,7 @@ run()
 ```
 
 #### getFileType
+
 get the file type of a file,
 based on extension,
 and defaulting to "txt"
@@ -157,39 +170,47 @@ console.log(fileType, fileType === 'html')
 
 const nonFileType = fs.getFileType()
 console.log(nonFileType, nonFileType === 'txt')
-
 ```
 
 ### changelog
 
 #### 0.0.1
+
 first release
 
 #### 0.0.2
-* bump required node version
-* update dependencies
+
+- bump required node version
+- update dependencies
 
 #### 0.0.3
+
 better error messages
 
 #### 0.0.4
+
 rmrf returns true if directory does not exist.
 
 #### 0.0.5
+
 use @magic/mime-types to export contentTypes
 
 #### 0.0.6
+
 bump required node version to 14.2.0
 
 #### 0.0.7
+
 rmrf: add dryRun option
 
 #### 0.0.8
+
 update dependencies
 
 #### 0.0.9
-* remove unused imports from getDirectories
-* getDirectories and getFiles now accept a number as second argument.
+
+- remove unused imports from getDirectories
+- getDirectories and getFiles now accept a number as second argument.
 
 ```
 // if a number is given instead of true/false, then this is the depth of recursion.
@@ -197,65 +218,92 @@ getFiles(directory, 2) // two levels down
 ```
 
 #### 0.0.10
-* bump required node version to 14.15.4
-* update dependencies
+
+- bump required node version to 14.15.4
+- update dependencies
 
 ##### 0.0.11
+
 update dependencies (@magic/mime-types)
 
 ##### 0.0.12
+
 export all functions from native fs
 
 ##### 0.0.13
-* getDirectories, getFiles: default root to process.cwd() if first argument is an array and root is not passed
-* update dependencies
+
+- getDirectories, getFiles: default root to process.cwd() if first argument is an array and root is not passed
+- update dependencies
 
 ##### 0.0.14
+
 update dependencies (@magic/mime-types)
 
 ##### 0.0.15
+
 update @magic/types to avoid circular dependency
 
 ##### 0.0.16
+
 add deprecation warning for calls to fs.getDirectories, fs.getFilePath and fs.getFiles that do not use an options object
 
 ##### 0.0.17
+
 update dependencies
 
 ##### 0.0.18
+
 update mime-types
 
 ##### 0.0.19
+
 update dependencies
 
 ##### 0.0.20
+
 update dependencies
 
 ##### 0.0.21
-* add missing @magic/fs dependency
-* update dependencies
+
+- add missing @magic/fs dependency
+- update dependencies
 
 ##### 0.0.22
+
 update dependencies
 
 ##### 0.0.23
+
 update dependencies
 
 ##### 0.0.24
+
 getFiles: allow files to be filtered by extension, using the .extension key of the second parameter
 
 ##### 0.0.25
+
 update dependencies
 
 ##### 0.0.26
+
 update dependencies
 
 ##### 0.0.27
+
 update dependencies
 
-##### 0.0.28 - unreleased
-...
+##### 0.0.28
 
+update dependencies
+
+##### 0.0.29
+
+- update dependencies
+- getFiles and getDirectories now accept maxDepth and minDepth config args
+
+##### 0.0.30 - unreleased
+
+...
 
 [npm-image]: https://img.shields.io/npm/v/@magic/fs.svg
 [npm-url]: https://www.npmjs.com/package/@magic/fs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/fs",
-  "version": "0.0.27",
+  "version": "0.0.29",
   "author": "Wizards & Witches",
   "description": "nodejs fs promises + goodies",
   "license": "AGPL-3.0",
@@ -33,20 +33,20 @@
   },
   "devDependencies": {
     "@magic-modules/git-badges": "0.0.12",
-    "@magic-modules/light-switch": "0.0.11",
-    "@magic-modules/no-spy": "0.0.7",
-    "@magic-modules/pre": "0.0.11",
-    "@magic-themes/docs": "0.0.14",
-    "@magic/core": "0.0.142",
-    "@magic/format": "0.0.41",
-    "@magic/test": "0.2.12"
+    "@magic-modules/light-switch": "0.0.12",
+    "@magic-modules/no-spy": "0.0.9",
+    "@magic-modules/pre": "0.0.12",
+    "@magic-themes/docs": "0.0.15",
+    "@magic/core": "0.0.155",
+    "@magic/format": "0.0.52",
+    "@magic/test": "0.2.18"
   },
   "dependencies": {
-    "@magic/deep": "0.1.15",
-    "@magic/error": "0.0.16",
-    "@magic/log": "0.1.17",
-    "@magic/mime-types": "0.0.17",
-    "@magic/types": "0.1.22"
+    "@magic/deep": "0.1.16",
+    "@magic/error": "0.0.17",
+    "@magic/log": "0.1.18",
+    "@magic/mime-types": "0.0.18",
+    "@magic/types": "0.1.23"
   },
   "files": [
     "src"

package/src/getDirectories.mjs

@@ -20,17 +20,31 @@ export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
     root = false
   }
 
+  let minDepth = 0
+  let maxDepth = 200
+
   let noRoot = false
-  if (!is.empty(depth) && is.objectNative(depth)) {
+  if (depth === false) {
+    maxDepth = 1
+  } else if (is.number(depth)) {
+    maxDepth = depth
+  } else if (!is.empty(depth) && is.objectNative(depth)) {
     root = root || depth?.root
     noRoot = depth?.noRoot
-    depth = depth?.depth
-  }
 
-  if (depth === false) {
-    depth = 1
+    if (depth.hasOwnProperty('depth')) {
+      maxDepth = depth.depth
+    } else if (depth.hasOwnProperty('maxDepth')) {
+      maxDepth = depth.maxDepth
+    }
+
+    if (depth.hasOwnProperty('minDepth')) {
+      minDepth = depth.minDepth
+    }
   }
 
+  maxDepth = parseInt(maxDepth)
+
   if (!is.array(dir) && !is.string(dir)) {
     throw error(`${libName}: need an array or a string as first argument`, 'E_ARG_TYPE')
   }
@@ -50,17 +64,15 @@ export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
   try {
     if (is.array(dir)) {
       const dirs = await Promise.all(
-        dir.map(async f => await getDirectories(f, { depth, root, noRoot })),
+        dir.map(async f => await getDirectories(f, { maxDepth, minDepth, root, noRoot })),
       )
 
       return deep.flatten(...dirs).filter(a => a)
     }
 
-    if (is.number(depth)) {
-      const currentDepth = dir.replace(root, '').split(path.sep).length
-      if (currentDepth - 1 > depth) {
-        return []
-      }
+    const currentDepth = dir.replace(root, '').split(path.sep).length
+    if (is.number(maxDepth) && currentDepth - 1 > maxDepth) {
+      return []
     }
 
     const dirContent = await fs.readdir(dir)
@@ -71,7 +83,7 @@ export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
           throw error(`${libName}: path was not a string: ${file}`, 'E_ARG_TYPE')
         }
 
-        let filePath = await getFilePath(getDirectories, dir, file, { depth, root })
+        let filePath = await getFilePath(getDirectories, dir, file, { maxDepth, minDepth, root })
 
         if (filePath) {
           if (!is.array(filePath)) {
@@ -103,9 +115,23 @@ export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
       finalDirs = [dir, ...finalDirs]
     }
 
-    const finalized = deep.flatten(finalDirs).filter(a => a)
+    const finalized = deep.flatten(finalDirs).filter(dir => {
+      if (!dir) {
+        return false
+      }
+
+      if (is.number(minDepth)) {
+        const currentDepth = dir.replace(root, '').split(path.sep).length
+
+        return currentDepth > minDepth
+      }
+
+      return true
+    })
+
+    const unique = Array.from(new Set(finalized))
 
-    return Array.from(new Set(finalized))
+    return unique
   } catch (e) {
     if (e.code === 'ENOENT') {
       return []

package/src/getFilePath.mjs

@@ -17,9 +17,13 @@ export const getFilePath = async (fn, dir, file, depth = true, root = 'deprecate
     root = false
   }
 
+  let minDepth = 0
+  let maxDepth = 200
+
   if (!is.empty(depth) && is.objectNative(depth)) {
     root = depth.root
-    depth = depth.depth
+    maxDepth = depth?.depth || depth?.maxDepth
+    minDepth = depth?.minDepth
   }
 
   if (is.empty(fn)) {
@@ -52,8 +56,8 @@ export const getFilePath = async (fn, dir, file, depth = true, root = 'deprecate
       .split(path.sep)
       .filter(a => a).length
 
-    if (depth || currentDepth === 1) {
-      return await fn(filePath, { depth, root })
+    if (maxDepth || currentDepth === 1) {
+      return await fn(filePath, { maxDepth, minDepth, root })
     }
   } else if (stat.isFile()) {
     return filePath

package/src/getFiles.mjs

@@ -14,25 +14,35 @@ export const getFiles = async (dir, depth = true, root = 'deprecated') => {
   if (root !== 'deprecated') {
     log.warn('E_DEPRECATED', 'you have used fs.getFiles with a third argument.')
     log.info('Please use the new syntax instead:')
-    log.info("fs.getFiles(dir, { depth: true, root: false, extension: 'md' })")
+    log.info("fs.getFiles(dir, { maxDepth: 200, root: false, extension: 'md', minDepth: 0 })")
   } else {
     root = false
   }
 
+  let minDepth = 0
+  let maxDepth = 200
+
   let extension
 
+  if (depth === false) {
+    maxDepth = 1
+  } else if (is.number(depth)) {
+    maxDepth = depth
+  }
   if (!is.empty(depth) && is.objectNative(depth)) {
     root = root || depth?.root
     extension = depth?.extension
 
-    /* make sure this is the last action in this if  */
-    depth = depth?.depth
+    maxDepth = depth?.depth || depth?.maxDepth
+    minDepth = depth.minDepth
   }
 
-  if (depth === false) {
-    depth = 1
+  if (maxDepth === false) {
+    maxDepth = 1
   }
 
+  maxDepth = parseInt(maxDepth)
+
   if (is.empty(dir)) {
     throw error(`${libName}: dir: first argument can not be empty.`, 'E_ARG_EMPTY')
   }
@@ -41,31 +51,53 @@ export const getFiles = async (dir, depth = true, root = 'deprecated') => {
     throw error(`${libName}: dir: first argument must be a string.`, 'E_ARG_TYPE')
   }
 
-  if (is.empty(root) && is.number(depth)) {
+  if (is.empty(root) && is.number(maxDepth)) {
     root = dir
   }
 
-  if (is.number(depth)) {
-    const currentDepth = dir.replace(root, '').split(path.sep).length
-    if (currentDepth - 1 > depth) {
-      return []
-    }
+  const currentDepth = dir.replace(root, '').split(path.sep).length
+
+  if (is.number(maxDepth) && currentDepth - 1 > maxDepth) {
+    return []
   }
 
   try {
     const dirContent = await fs.readdir(dir)
     const files = await Promise.all(
-      dirContent.map(file => getFilePath(getFiles, dir, file, { depth, root })),
+      dirContent.map(file => getFilePath(getFiles, dir, file, { maxDepth, minDepth, root })),
     )
 
     return await Promise.all(
       deep
         .flatten(files)
         .filter(a => a)
+        /*
+         * if an extension parameter has been passed,
+         * remove the file if it does not end with extension
+         */
         .filter(a => !extension || a.endsWith(extension))
+        /*
+         * filter nonfiles
+         */
         .filter(async f => {
           const stat = await fs.stat(f)
           return stat.isFile()
+        })
+        /*
+         * filter files if depth is smaller than minDepth
+         */
+        .filter(file => {
+          if (!file) {
+            return false
+          }
+
+          if (is.number(minDepth)) {
+            const currentDepth = file.replace(root, '').split(path.sep).length
+
+            return currentDepth > minDepth
+          }
+
+          return true
         }),
     )
   } catch (e) {