@magic/fs 0.0.15 → 0.0.19

package/README.md

@@ -100,17 +100,23 @@ import fs from '@magic/fs'
 
 const run = async () => {
   // first level directories
-  const directories = await fs.getDirectories(process.cwd())
+  const directories = await fs.getDirectories(process.cwd(), false)
   console.log(directories)
 
+  // first level again
+  const dirs = await fs.getDirectories(process.cwd(), { depth: false })
+
   // recursive run
-  const deepDirectories = await fs.getDirectories(process.cwd(), true)
+  const deepDirectories = await fs.getDirectories(process.cwd())
   console.log(deepDirectories)
 
-  // recursive run with specified depth, 
-  // just pass a number as second argument
-  const deepDirectoriesDepth2 = await fs.getDirectories(process.cwd(), 2)
+  // recursive run with specified depth
+  const deepDirectoriesDepth2 = await fs.getDirectories(process.cwd(), { depth: 2 })
   console.log(deepDirectoriesDepth2)
+
+  // use /some/dir as root instead of process.cwd()
+  const deepDirWithRoot = await fs.getDirectories(process.cwd(), { depth: true, root: '/some/dir' })
+  console.log(deepDirWithRoot)
 }
 run()
 ```
@@ -128,13 +134,12 @@ const run = async () => {
   console.log(files)
 
   // recursive run
-  const deepFiles = await fs.getFiles(process.cwd(), true)
+  const deepFiles = await fs.getFiles(process.cwd(), { depth: true })
   console.log(deepFiles)
 
-  // recursive run with specified depth, 
-  // just pass a number as second argument
-  const deepDirectoriesDepth2 = await fs.getFiles(process.cwd(), 2)
-  console.log(deepDirectoriesDepth2)
+  // recursive run with specified depth,
+  const deepFilesDepth2 = await fs.getFiles(process.cwd(), { depth: 2 })
+  console.log(deepFilesDepth2)
 }
 run()
 ```
@@ -179,10 +184,10 @@ bump required node version to 14.2.0
 #### 0.0.7
 rmrf: add dryRun option
 
-#### 0.0.8 
+#### 0.0.8
 update dependencies
 
-#### 0.0.9 - unreleased
+#### 0.0.9
 * remove unused imports from getDirectories
 * getDirectories and getFiles now accept a number as second argument.
 
@@ -198,7 +203,7 @@ getFiles(directory, 2) // two levels down
 ##### 0.0.11
 update dependencies (@magic/mime-types)
 
-##### 0.0.12 
+##### 0.0.12
 export all functions from native fs
 
 ##### 0.0.13
@@ -211,7 +216,19 @@ update dependencies (@magic/mime-types)
 ##### 0.0.15
 update @magic/types to avoid circular dependency
 
-##### 0.0.16 - unreleased
+##### 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 - unreleased
 ...
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/fs",
-  "version": "0.0.15",
+  "version": "0.0.19",
   "author": "Wizards & Witches",
   "description": "nodejs fs promises + goodies",
   "license": "AGPL-3.0",
@@ -35,16 +35,16 @@
     "@magic-modules/git-badges": "0.0.11",
     "@magic-modules/light-switch": "0.0.10",
     "@magic-modules/no-spy": "0.0.6",
-    "@magic-modules/pre": "0.0.10",
-    "@magic-themes/docs": "0.0.13",
-    "@magic/core": "0.0.127",
-    "@magic/format": "0.0.27",
-    "@magic/test": "0.1.72"
+    "@magic-modules/pre": "0.0.11",
+    "@magic-themes/docs": "0.0.14",
+    "@magic/core": "0.0.133",
+    "@magic/format": "0.0.33",
+    "@magic/test": "0.1.77"
   },
   "dependencies": {
-    "@magic/deep": "0.1.7",
+    "@magic/deep": "0.1.8",
     "@magic/error": "0.0.10",
-    "@magic/mime-types": "0.0.10",
+    "@magic/mime-types": "0.0.12",
     "@magic/types": "0.1.16"
   },
   "files": [

package/src/getDirectories.mjs

@@ -11,9 +11,24 @@ import { getFilePath } from './getFilePath.mjs'
 
 const libName = '@magic/fs.getDirectories'
 
-export const getDirectories = async (dir, recurse = true, root = false) => {
-  if (recurse === false) {
-    recurse = 1
+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
+  }
+
+  let noRoot = false
+  if (!is.empty(depth) && is.objectNative(depth)) {
+    root = root || depth?.root
+    noRoot = depth?.noRoot
+    depth = depth?.depth
+  }
+
+  if (depth === false) {
+    depth = 1
   }
 
   if (!is.array(dir) && !is.string(dir)) {
@@ -34,14 +49,16 @@ export const getDirectories = async (dir, recurse = true, root = false) => {
 
   try {
     if (is.array(dir)) {
-      const dirs = await Promise.all(dir.map(async f => await getDirectories(f, recurse, root)))
+      const dirs = await Promise.all(
+        dir.map(async f => await getDirectories(f, { depth, root, noRoot })),
+      )
 
       return deep.flatten(...dirs).filter(a => a)
     }
 
-    if (is.number(recurse)) {
+    if (is.number(depth)) {
       const currentDepth = dir.replace(root, '').split(path.sep).length
-      if (currentDepth - 1 > recurse) {
+      if (currentDepth - 1 > depth) {
         return []
       }
     }
@@ -54,7 +71,7 @@ export const getDirectories = async (dir, recurse = true, root = false) => {
           throw error(`${libName}: path was not a string: ${file}`, 'E_ARG_TYPE')
         }
 
-        let filePath = await getFilePath(getDirectories, dir, file, recurse, root)
+        let filePath = await getFilePath(getDirectories, dir, file, { depth, root })
 
         if (filePath) {
           if (!is.array(filePath)) {
@@ -81,7 +98,12 @@ export const getDirectories = async (dir, recurse = true, root = false) => {
       }),
     )
 
-    const finalized = deep.flatten(dir, dirs).filter(a => a)
+    let finalDirs = dirs.filter(a => a)
+    if (!noRoot) {
+      finalDirs = [dir, ...finalDirs]
+    }
+
+    const finalized = deep.flatten(finalDirs).filter(a => a)
 
     return Array.from(new Set(finalized))
   } catch (e) {

package/src/getFilePath.mjs

@@ -2,12 +2,26 @@ 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, recurse = true, root = false) => {
+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
+  }
+
   if (is.empty(fn)) {
     throw error(`${libName}: fn: first argument can not be empty`, 'E_ARG_1_EMPTY')
   }
@@ -33,12 +47,13 @@ export const getFilePath = async (fn, dir, file, recurse = true, root = false) =
 
   const stat = await fs.stat(filePath)
   if (stat.isDirectory(filePath)) {
-    const depth = filePath
+    const currentDepth = filePath
       .replace(root, '')
       .split(path.sep)
       .filter(a => a).length
-    if (recurse || depth === 1) {
-      return await fn(filePath, recurse, root)
+
+    if (depth || currentDepth === 1) {
+      return await fn(filePath, { depth, root })
     }
   } else if (stat.isFile()) {
     return filePath

package/src/getFiles.mjs

@@ -3,15 +3,29 @@ 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, recurse = true, root = false) => {
-  if (recurse === false) {
-    recurse = 1
+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 })')
+  } else {
+    root = false
+  }
+
+  if (!is.empty(depth) && is.objectNative(depth)) {
+    root = root || depth?.root
+    depth = depth?.depth
+  }
+
+  if (depth === false) {
+    depth = 1
   }
 
   if (is.empty(dir)) {
@@ -22,13 +36,13 @@ export const getFiles = async (dir, recurse = true, root = false) => {
     throw error(`${libName}: dir: first argument must be a string.`, 'E_ARG_TYPE')
   }
 
-  if (is.empty(root) && is.number(recurse)) {
+  if (is.empty(root) && is.number(depth)) {
     root = dir
   }
 
-  if (is.number(recurse)) {
+  if (is.number(depth)) {
     const currentDepth = dir.replace(root, '').split(path.sep).length
-    if (currentDepth - 1 > recurse) {
+    if (currentDepth - 1 > depth) {
       return []
     }
   }
@@ -36,7 +50,7 @@ export const getFiles = async (dir, recurse = true, root = false) => {
   try {
     const dirContent = await fs.readdir(dir)
     const files = await Promise.all(
-      dirContent.map(file => getFilePath(getFiles, dir, file, recurse, root)),
+      dirContent.map(file => getFilePath(getFiles, dir, file, { depth, root })),
     )
 
     return await Promise.all(