@magic/fs 0.0.28 → 0.0.30

package/README.md

@@ -296,7 +296,18 @@ update dependencies
 
 update dependencies
 
-##### 0.0.29 - unreleased
+##### 0.0.29
+
+- update dependencies
+- getFiles and getDirectories now accept maxDepth and minDepth config args
+
+##### 0.0.30
+
+- update dependencies
+- remove deprecated getFiles and getDirectories api
+- add minDepth option
+
+##### 0.0.31 - unreleased
 
 ...
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/fs",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "author": "Wizards & Witches",
   "description": "nodejs fs promises + goodies",
   "license": "AGPL-3.0",
@@ -33,13 +33,13 @@
   },
   "devDependencies": {
     "@magic-modules/git-badges": "0.0.12",
-    "@magic-modules/light-switch": "0.0.11",
-    "@magic-modules/no-spy": "0.0.8",
-    "@magic-modules/pre": "0.0.11",
-    "@magic-themes/docs": "0.0.14",
-    "@magic/core": "0.0.149",
-    "@magic/format": "0.0.50",
-    "@magic/test": "0.2.15"
+    "@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.156",
+    "@magic/format": "0.0.54",
+    "@magic/test": "0.2.18"
   },
   "dependencies": {
     "@magic/deep": "0.1.16",

package/src/getDirectories.mjs

@@ -11,24 +11,28 @@ import { getFilePath } from './getFilePath.mjs'
 
 const libName = '@magic/fs.getDirectories'
 
-export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
-  if (root !== 'deprecated') {
-    log.warn('E_DEPRECATED', 'you have used fs.getDirectories with a third argument.')
-    log.info('Please use the new syntax instead:')
-    log.info('fs.getDirectories(dir, { root: true })')
-  } else {
-    root = false
+export const getDirectories = async (dir, args = {}) => {
+  if (is.number(args)) {
+    args = {
+      maxDepth: args,
+    }
+  } else if (args === false) {
+    args = {
+      maxDepth: 1,
+    }
   }
 
-  let noRoot = false
-  if (!is.empty(depth) && is.objectNative(depth)) {
-    root = root || depth?.root
-    noRoot = depth?.noRoot
-    depth = depth?.depth
+  let { minDepth, maxDepth = false, depth = false, root, noRoot = false } = args
+
+  if (is.number(depth) && !is.number(maxDepth)) {
+    maxDepth = depth
   }
 
-  if (depth === false) {
-    depth = 1
+  if (!is.number(maxDepth)) {
+    maxDepth = 200_000
+  }
+  if (!is.number(minDepth)) {
+    minDepth = 0
   }
 
   if (!is.array(dir) && !is.string(dir)) {
@@ -50,17 +54,19 @@ 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)
+      .filter(a => a).length
+
+    if (currentDepth > maxDepth) {
+      return []
     }
 
     const dirContent = await fs.readdir(dir)
@@ -71,7 +77,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)) {
@@ -98,14 +104,29 @@ export const getDirectories = async (dir, depth = {}, root = 'deprecated') => {
       }),
     )
 
-    let finalDirs = dirs.filter(a => a)
+    let finalDirs = deep.flatten(dirs).filter(a => a)
     if (!noRoot) {
       finalDirs = [dir, ...finalDirs]
     }
 
-    const finalized = deep.flatten(finalDirs).filter(a => a)
+    const finalized = finalDirs
+      .filter(a => a)
+      .filter(dir => {
+        if (is.number(minDepth)) {
+          const currentDepth = dir
+            .replace(root, '')
+            .split(path.sep)
+            .filter(a => a).length
+
+          return currentDepth >= minDepth
+        }
+
+        return false
+      })
+
+    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

@@ -2,26 +2,12 @@ import path from 'path'
 
 import is from '@magic/types'
 import error from '@magic/error'
-import log from '@magic/log'
 
 import { fs } from './fs.mjs'
 
 const libName = '@magic/fs.getFilePath'
 
-export const getFilePath = async (fn, dir, file, depth = true, root = 'deprecated') => {
-  if (root !== 'deprecated') {
-    log.warn('E_DEPRECATED', 'you have used fs.getFilePath with a fifth argument.')
-    log.info('Please use the new syntax instead:')
-    log.info("fs.getFilePath(fn, dir, file, { depth: true || 22, root: false || '/some/dir/' })")
-  } else {
-    root = false
-  }
-
-  if (!is.empty(depth) && is.objectNative(depth)) {
-    root = depth.root
-    depth = depth.depth
-  }
-
+export const getFilePath = async (fn, dir, file, args = {}) => {
   if (is.empty(fn)) {
     throw error(`${libName}: fn: first argument can not be empty`, 'E_ARG_1_EMPTY')
   }
@@ -47,14 +33,7 @@ export const getFilePath = async (fn, dir, file, depth = true, root = 'deprecate
 
   const stat = await fs.stat(filePath)
   if (stat.isDirectory(filePath)) {
-    const currentDepth = filePath
-      .replace(root, '')
-      .split(path.sep)
-      .filter(a => a).length
-
-    if (depth || currentDepth === 1) {
-      return await fn(filePath, { depth, root })
-    }
+    return await fn(filePath, args)
   } else if (stat.isFile()) {
     return filePath
   }

package/src/getFiles.mjs

@@ -3,34 +3,34 @@ import path from 'path'
 import deep from '@magic/deep'
 import is from '@magic/types'
 import error from '@magic/error'
-import log from '@magic/log'
 
 import { getFilePath } from './getFilePath.mjs'
 import { fs } from './fs.mjs'
 
 const libName = '@magic/fs.getFiles'
 
-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' })")
-  } else {
-    root = false
+export const getFiles = async (dir, args = {}) => {
+  if (is.number(args)) {
+    args = {
+      maxDepth: args,
+    }
   }
 
-  let extension
+  let { minDepth = 0, maxDepth = false, depth = false, extension = false, ext = false, root } = args
 
-  if (!is.empty(depth) && is.objectNative(depth)) {
-    root = root || depth?.root
-    extension = depth?.extension
+  if (ext && !extension) {
+    extension = ext
+  }
 
-    /* make sure this is the last action in this if  */
-    depth = depth?.depth
+  if (is.number(depth) && !is.number(maxDepth)) {
+    maxDepth = depth
   }
 
-  if (depth === false) {
-    depth = 1
+  if (!is.number(maxDepth)) {
+    maxDepth = 200_000
+  }
+  if (!is.number(minDepth)) {
+    minDepth = 0
   }
 
   if (is.empty(dir)) {
@@ -41,31 +41,60 @@ 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)) {
     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)
+    .filter(a => a).length
+
+  if (currentDepth > 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)
+                .filter(a => a).length - 1
+
+            return currentDepth >= minDepth
+          }
+
+          return true
         }),
     )
   } catch (e) {