Port File System APIs in Deno namespace to @std/fs

[kt3k]

We aim to make @std/fs cross-runtime (ref #4313). To achieve that we need to port FS APIs from Deno namespace (with Node.js compatibility)

• Deno FS APIs https://docs.deno.com/api/deno/file-system
• deno-shim https://github.com/denoland/node_shims/tree/main/packages/shim-deno/src/deno/stable/functions

Classes

• FsFile

Functions

• chmod feat(fs/unstable): add chmod and chmodSync #6343
• chmodSync feat(fs/unstable): add chmod and chmodSync #6343
• chown
• chownSync
• copyFile
• copyFileSync
• create
• createSync
• link feat(fs/unstable): add link and linkSync #6369
• linkSync feat(fs/unstable): add link and linkSync #6369
• lstat feat(fs/unstable): add fs.lstat #6276
• lstatSync feat(fs/unstable): add statSync and lstatSync #6300
• makeTempDir feat(fs/unstable): add makeTempDir and makeTempDirSync #6391
• makeTempDirSync feat(fs/unstable): add makeTempDir and makeTempDirSync #6391
• makeTempFile
• makeTempFileSync
• mkdir
• mkdirSync
• open
• openSync
• readDir feat(fs/unstable): add readDir #6338
• readDirSync feat(fs/unstable): add readDirSync #6381
• readFile feat(fs/unstable): add readFile and readFileSync #6394
• readFileSync feat(fs/unstable): add readFile and readFileSync #6394
• readLink feat(fs/unstable): add readLink and readLinkSync #6373
• readLinkSync feat(fs/unstable): add readLink and readLinkSync #6373
• readTextFile
• readTextFileSync
• realPath feat(fs/unstable): add realPath and realPathSync #6366
• realPathSync feat(fs/unstable): add realPath and realPathSync #6366
• remove
• removeSync
• rename feat(fs/unstable): add rename #6379
• renameSync feat(fs/unstable): add renameSync #6396
• stat feat(fs/unstable): add fs.stat #6258
• statSync feat(fs/unstable): add statSync and lstatSync #6300
• symlink feat(fs/unstable): add symlink and symlinkSync #6352
• symlinkSync feat(fs/unstable): add symlink and symlinkSync #6352
• truncate
• truncateSync
• umask
• utime
• utimeSync
• watchFs
• writeFile
• writeFileSync
• writeTextFile
• writeTextFileSync

shim-deno package already implements Node.js compatible Deno APIs. We can borrow the code from there for the Node.js compatibility part https://github.com/denoland/node_shims/tree/main/packages/shim-deno

[eryue0220]

Are unlink and unlinkSync ignored?

[kt3k]

It looks like Deno doesn't have unlink and unlinkSync. Instead it has remove and removeSync. This list tries to mirror Deno FS APIs.

[eryue0220]

Considering compatibility with Node, should fs.unlink and fs.unlinkSync also be provided?

[kt3k]

Do you suggest unlink would be an alias to remove?

[eryue0220]

Yes, except for compatibility, link and unlink is a pair, which is make more sense and more understandable than remove. WDYT?

[kt3k]

Looked at the docs again, (Deno's) remove has an option like recursive (it can remove the entire directory), but unlink (of Node) doesn't. I feel unlink can't replace remove, and it feels like a limited version of remove.

BTW Node.js also has rm which is similar to Deno's remove.