make relative paths lazy

this also ensures that the relative path is set before any user functions are called, but no sooner.

Author: jonschlinkert

README.md

@@ -485,4 +485,4 @@ Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 19, 2021._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 19, 2021._

bench/index.js

@@ -50,13 +50,14 @@ composer.task('recursive-large', () => {
 
 composer.task('recursive-mid', async () => {
   const dir = path.join(__dirname, '..');
+  const files = await readdir(dir, { recursive: true });
 
   if (shouldDelete || fs.existsSync(fixtures)) {
     await rimraf(fixtures, { glob: false });
     await pause(1000);
   }
 
-  return bench('recursive ~2,700 files')
+  return bench(`recursive ~${files.length} files`)
     .add('fdir', () => fdirRecursive(dir))
     .add('@folder/readdir', () => readdir(dir, { recursive: true }))
     .add('readdir-enhanced', () => enhanced.async(dir, { deep: true, basePath: dir }))

lib/async.js

@@ -154,16 +154,28 @@ const readdir = async (basedir, options = {}) => {
         file.dirname = dirent.path;
         file.path = file[kPath] = `${dirent.path}${sep}${file.name}`;
 
-        if (absolute !== true || objects === true || isMatch) {
+        let updatedRelative = false;
+
+        // lazily decorate relative path if or when a user supplied function is called
+        // if no function is passed, we can avoid calling this function
+        const updateRelative = () => {
+          if (updatedRelative) return;
+          updatedRelative = true;
+
           if (file[kPath] === file.path && file.base === file.cwd) {
             file.relative = dirent.relative ? `${dirent.relative}${sep}${file.name}` : file.name;
           } else {
             file.relative = path.relative(file.base, file.path);
           }
+        };
+
+        if (absolute !== true || objects === true || isMatch) {
+          updateRelative();
         }
 
         if (onEach) {
           try {
+            updateRelative();
             await onEach(file, dirent);
           } catch (err) {
             next(err);
@@ -172,8 +184,10 @@ const readdir = async (basedir, options = {}) => {
         }
 
         if (file.isSymbolicLink()) {
+
           try {
             if (typeof onSymbolicLink === 'function') {
+              updateRelative();
               await onSymbolicLink(file, dirent);
             }
 
@@ -219,6 +233,7 @@ const readdir = async (basedir, options = {}) => {
 
         if (typeof onFile === 'function') {
           try {
+            updateRelative();
             await onFile(file, dirent);
           } catch (err) {
             next(err);

lib/sync.js

@@ -131,21 +131,34 @@ const readdirSync = (basedir, options = {}) => {
       file.dirname = dirent.path;
       file.path = file[kPath] = `${dirent.path}${sep}${file.name}`;
 
-      if (absolute !== true || objects === true || isMatch) {
+      let updatedRelative = false;
+
+      // lazily decorate relative path if or when a user supplied function is called
+      // if no function is passed, we can avoid calling this function
+      const updateRelative = () => {
+        if (updatedRelative) return;
+        updatedRelative = true;
+
         if (file[kPath] === file.path && file.base === file.cwd) {
-          file.relative = dirent.relative ? `${dirent.relative}${path.sep}${file.name}` : file.name;
+          file.relative = dirent.relative ? `${dirent.relative}${sep}${file.name}` : file.name;
         } else {
           file.relative = path.relative(file.base, file.path);
         }
+      };
+
+      if (absolute !== true || objects === true || isMatch) {
+        updateRelative();
       }
 
       if (onEach) {
+        updateRelative();
         onEach(file, dirent);
       }
 
       if (file.isSymbolicLink()) {
         try {
           if (typeof onSymbolicLink === 'function') {
+            updateRelative();
             onSymbolicLink(file, dirent);
           }
 
@@ -178,6 +191,7 @@ const readdirSync = (basedir, options = {}) => {
       }
 
       if (typeof onFile === 'function') {
+        updateRelative();
         onFile(file, dirent);
       }
 

package.json

@@ -99,4 +99,4 @@
       "reflinks": true
     }
   }
-}
+}