feat: add withFileTypes in FileSystem

[fu1996]

This pr is from #16780 in the webpack repository. #16780
The relevant unit tests have been run, and types.d.ts have been automatically generated. Please pr this
This is my first attempt to resolve issues in webpack. If there are any issues that do not meet the specification, I will modify them as soon as possible. 😄

Results of running unit tests locally:

[alexander-akait]

It is possible to pass undefined directly here, so boolean | undefined

[alexander-akait]

Let's create a new type BufferEncoding and move them there and reuse here and above

[alexander-akait]

Also buffer possible too

[alexander-akait]

Just for infromation, here is node types for such method:

export function readdir(
        path: PathLike,
        options:
            | {
                  encoding: BufferEncoding | null;
                  withFileTypes?: false | undefined;
              }
            | BufferEncoding
            | undefined
            | null,
        callback: (err: NodeJS.ErrnoException | null, files: string[]) => void
    ): void;
    /**
     * Asynchronous readdir(3) - read a directory.
     * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
     * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
     */
    export function readdir(
        path: PathLike,
        options:
            | {
                  encoding: 'buffer';
                  withFileTypes?: false | undefined;
              }
            | 'buffer',
        callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void
    ): void;

[fu1996]

Let's create a new type BufferEncoding and move them there and reuse here and above

"This types.d.ts is automatically generated by running the 'yarn special lint fix' command. I think what I can do is modify the jsDoc syntax in 'Resolver. js' to generate it, but I cannot control the addition of' ascii '|' utf8 '|' utf-8 '|' utf16le '|' ucs2 '|' ucs-2 '|' base64 '|' latin1 '|' binary '|' hex ';"; "Force the use of the BufferEncoding type, even if I manually modify it after running the 'yarn special lint fix' command, but I don't think this is a good method. Do you have any good ideas for controlling the use of the BufferEncoding type instead of its corresponding enumeration value?"?

The following figure shows that after I manually changed to BufferEncoding and executed the 'yarn special lint fix' command, my manual modification was invalid

[alexander-akait]

undefined possible too

[alexander-akait]

Let's fix some things and we can merge, thank you

[fu1996]

Let's fix some things and we can merge, thank you

Thank you, cr. It's early morning in China, and I will repair it in 10 hours. 😄

[fu1996]

Let's fix some things and we can merge, thank you

On the other hand, after I added 'buffer' and undefined and executed the 'yarn special lint fix' command, 'buffer' was successfully automatically generated in the 'types. d.ts' file, but undefined was not generated. For details, see this commit: commit url Is this a normal situation? 😊

[alexander-akait]

So undefined doesn't generate in types, right?

[fu1996]

So undefined doesn't generate in types, right?

Yes, undefined cannot be generated by running the command yarn special lint fix. Do you have any good suggestions?

[alexander-akait]

/cc @TheLarkInn

[TheLarkInn]

Sorry I'm JUST seeing this! I apologize for the delay @fu1996. This looks awesome thank you so much for the contribution!

[TheLarkInn]

My understanding is that as long as the parameter is optional that the lint-fix will automatically not generated the undefined also and that the optional parameter satisfies this.

[TheLarkInn]

I'll wait on confirmation from @alexander-akait on this before merging but all looks good!

[TheLarkInn]

Congrats @fu1996 on your first PR to webpack! 🎉

多谢!!