feat: PathRef - readDir() and readDirSync return a WalkEntry …

…(includes path) (#112)

src/path.test.ts

@@ -258,16 +258,16 @@ Deno.test("readDir", async () => {
 
     const entries1 = [];
     for await (const entry of dir.readDir()) {
-      entries1.push(entry.name);
+      entries1.push(entry);
     }
-    entries1.sort();
-    const entries2 = Array.from(dir.readDirSync()).map((e) => e.name);
-    entries2.sort();
+    const entries2 = Array.from(dir.readDirSync());
+    entries1.sort((a, b) => a.name.localeCompare(b.name));
+    entries2.sort((a, b) => a.name.localeCompare(b.name));
 
     for (const entries of [entries1, entries2]) {
       assertEquals(entries.length, 2);
-      assertEquals(entries[0], "file1");
-      assertEquals(entries[1], "file2");
+      assertEquals(entries[0].name, "file1");
+      assertEquals(entries[1].name, "file2");
     }
 
     const filePaths1 = [];
@@ -278,7 +278,8 @@ Deno.test("readDir", async () => {
     filePaths1.sort();
     filePaths2.sort();
     assertEquals(filePaths1, filePaths2);
-    assertEquals(filePaths1, entries1.map((dirName) => dir.join(dirName).toString()));
+    assertEquals(filePaths1, entries1.map((entry) => entry.path.toString()));
+    assertEquals(filePaths1, entries2.map((entry) => entry.path.toString()));
   });
 });
 

src/path.ts

@@ -434,29 +434,43 @@ export class PathRef {
   }
 
   /** Reads the entries in the directory. */
-  readDir(): AsyncIterable<Deno.DirEntry> {
-    return Deno.readDir(this.#path);
+  async *readDir(): AsyncIterable<WalkEntry> {
+    const dir = this.resolve();
+    for await (const entry of Deno.readDir(dir.#path)) {
+      yield {
+        ...entry,
+        path: dir.join(entry.name),
+      };
+    }
   }
 
   /** Synchronously reads the entries in the directory. */
-  readDirSync(): Iterable<Deno.DirEntry> {
-    return Deno.readDirSync(this.#path);
+  *readDirSync(): Iterable<WalkEntry> {
+    const dir = this.resolve();
+    for (const entry of Deno.readDirSync(dir.#path)) {
+      yield {
+        ...entry,
+        path: dir.join(entry.name),
+      };
+    }
   }
 
-  /** Reads the directory file paths, not including symlinks. */
+  /** Reads only the directory file paths, not including symlinks. */
   async *readDirFilePaths(): AsyncIterable<PathRef> {
-    for await (const entry of Deno.readDir(this.#path)) {
+    const dir = this.resolve();
+    for await (const entry of Deno.readDir(dir.#path)) {
       if (entry.isFile) {
-        yield this.join(entry.name);
+        yield dir.join(entry.name);
       }
     }
   }
 
-  /** Synchronously reads the directory file paths, not including symlinks. */
+  /** Synchronously reads only the directory file paths, not including symlinks. */
   *readDirFilePathsSync(): Iterable<PathRef> {
-    for (const entry of Deno.readDirSync(this.#path)) {
+    const dir = this.resolve();
+    for (const entry of Deno.readDirSync(dir.#path)) {
       if (entry.isFile) {
-        yield this.join(entry.name);
+        yield dir.join(entry.name);
       }
     }
   }