Skip to content

Commit

Permalink
fs: introduce dirent.parentPath
Browse files Browse the repository at this point in the history
The goal is to replace `dirent.path` using a name that's less likely to
create confusion.
`dirent.path` value has not been stable, moving it to a different
property name should avoid breaking some upgrading user expectations.

PR-URL: #50976
Reviewed-By: Ethan Arrowood <ethan@arrowood.dev>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
  • Loading branch information
aduh95 authored and richardlau committed Mar 25, 2024
1 parent 4b3cc3c commit 0225fce
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 6 deletions.
15 changes: 14 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6578,6 +6578,19 @@ The file name that this {fs.Dirent} object refers to. The type of this
value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
[`fs.readdirSync()`][].
#### `dirent.parentPath`
<!-- YAML
added:
- REPLACEME
-->
> Stability: 1 – Experimental
* {string}
The path to the parent directory of the file this {fs.Dirent} object refers to.
#### `dirent.path`
<!-- YAML
Expand All @@ -6586,7 +6599,7 @@ added: v20.1.0
* {string}
The base path that this {fs.Dirent} object refers to.
Alias for `dirent.parentPath`.
### Class: `fs.FSWatcher`
Expand Down
2 changes: 1 addition & 1 deletion lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -1426,7 +1426,7 @@ function readdirSyncRecursive(basePath, options) {
const dirent = getDirent(path, readdirResult[0][i], readdirResult[1][i]);
ArrayPrototypePush(readdirResults, dirent);
if (dirent.isDirectory()) {
ArrayPrototypePush(pathsQueue, pathModule.join(dirent.path, dirent.name));
ArrayPrototypePush(pathsQueue, pathModule.join(dirent.parentPath, dirent.name));
}
}
} else {
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/fs/dir.js
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ class Dir {
}

readSyncRecursive(dirent) {
const path = pathModule.join(dirent.path, dirent.name);
const path = pathModule.join(dirent.parentPath, dirent.name);
const ctx = { path };
const handle = dirBinding.opendir(
pathModule.toNamespacedPath(path),
Expand Down
1 change: 1 addition & 0 deletions lib/internal/fs/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ function assertEncoding(encoding) {
class Dirent {
constructor(name, type, path) {
this.name = name;
this.parentPath = path;
this.path = path;
this[kType] = type;
}
Expand Down
8 changes: 5 additions & 3 deletions test/parallel/test-fs-opendir.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ const invalidCallbackObj = {
const entries = files.map(() => {
const dirent = dir.readSync();
assertDirent(dirent);
return dirent.name;
});
assert.deepStrictEqual(files, entries.sort());
return { name: dirent.name, path: dirent.path, parentPath: dirent.parentPath, toString() { return dirent.name; } };
}).sort();
assert.deepStrictEqual(entries.map((d) => d.name), files);
assert.deepStrictEqual(entries.map((d) => d.path), Array(entries.length).fill(testDir));
assert.deepStrictEqual(entries.map((d) => d.parentPath), Array(entries.length).fill(testDir));

// dir.read should return null when no more entries exist
assert.strictEqual(dir.readSync(), null);
Expand Down

0 comments on commit 0225fce

Please sign in to comment.