fix: don't include filename in path when calling readdir with withFileTypes: true

[jonsch318]

This solves issue #1007 and is in large part the solution of @zzzzBuv though with some tests changed for conformance with node and readdir recursive fix.

src/dirent.path is only the path of the parent dir and dirent.name is either the filename+extension or the directory name. This is now reflected in readdir. Because readdir constructs the filenames from the readdir we join(path,name).

I had to change the test with readdir({withFileType: true}) because they were out of spec with node.

To test for conformance i used a simple script (node version v21.7.2)

const fs = require('fs');
const path = require('path');

async function Test() {
  const dir = path.join(process.cwd());

  console.log('readdirSync(withFileTypes, recursive)');

  let res = fs.readdirSync(dir, { withFileTypes: true, recursive: true });
  console.log(res);

  console.log('promise readdir(withFileTypes, recursive)');

  res = await fs.promises.readdir(dir, { withFileTypes: true, recursive: true });
  console.log(res);

  console.log('promise readdir(recursive)');

  res = fs.readdirSync(dir, { withFileTypes: false, recursive: true });
  console.log(res);
}

Test();

in the following file structure

it results in the following log:

readdirSync(withFileTypes, recursive)
[
  Dirent {
    name: 'a',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 2
  },
  Dirent {
    name: 'rf1',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 1
  },
  Dirent {
    name: 'test.js',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 1
  },
  Dirent {
    name: '.af2',
    parentPath: '/home/jonas/src/temp/readdir-test/a',
    path: '/home/jonas/src/temp/readdir-test/a',
    [Symbol(type)]: 1
  },
  Dirent {
    name: 'af1',
    parentPath: '/home/jonas/src/temp/readdir-test/a',
    path: '/home/jonas/src/temp/readdir-test/a',
    [Symbol(type)]: 1
  }
]
promise readdir(withFileTypes, recursive)
[
  Dirent {
    name: 'a',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 2
  },
  Dirent {
    name: 'rf1',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 1
  },
  Dirent {
    name: 'test.js',
    parentPath: '/home/jonas/src/temp/readdir-test',
    path: '/home/jonas/src/temp/readdir-test',
    [Symbol(type)]: 1
  },
  Dirent {
    name: '.af2',
    parentPath: '/home/jonas/src/temp/readdir-test/a',
    path: '/home/jonas/src/temp/readdir-test/a',
    [Symbol(type)]: 1
  },
  Dirent {
    name: 'af1',
    parentPath: '/home/jonas/src/temp/readdir-test/a',
    path: '/home/jonas/src/temp/readdir-test/a',
    [Symbol(type)]: 1
  }
]
promise readdir(recursive)
[ 'a', 'rf1', 'test.js', 'a/.af2', 'a/af1' ]

as i can see the test reflect that.

Resolves #1007

[G-Rath]

Looks like a good start, just needs the Windows tests fixed

[jonsch318]

I removed the overly long commit description from the one commit :)
and hopefully fixed the windows bug. i cant test that locally

[jonsch318]

@G-Rath my bad i forgot that string replace isn`t inplace. I have switched to my windows machine and this passes all tests so it should now work.

[jonsch318]

okay last try... sorry for the careless editing. Now everything should be fine

[G-Rath]

Awesome!

[G-Rath]

Whoops didn't see there were new pushes - no worries about the repeated failing of CI.

I'm happy to keep approving the workflow runs until it passes 😛