Feature request: isEmptyDir()

[btea]

Sometimes we encounter situations where we need to determine whether a directory is empty before deleting or performing other operations. Therefore, I think it might be convenient if an API can be provided.

fs.isEmptyDir(dir[,callback])

[RyanZim]

This is basically a duplicate of #420; though I'm open to reconsidering the decision there.

Can you elaborate more on the use-case here?

[btea]

This is basically a duplicate of #420; though I'm open to reconsidering the decision there.

Oh, sorry, I didn't notice this.

Can you elaborate more on the use-case here?

For example, in pnpm, there is a pnpm patch-remove command. After removing a certain patch file, you need to determine whether the directory where the patch file is stored is empty to decide whether to remove the corresponding folder.

There is also scaffolding that when initializing a project, it will also judge whether it is empty to decide whether to overwrite the content and continue or cancel. And I think this method can also be reused internally in emptyDir.

[RyanZim]

I'm especially hesitant to add it as it's trivial to implement wherever it's needed; the code is literally:

!(await fs.readdir(dir)).length

Is it worth creating a method just for this?

[RyanZim]

Also, in the case of something like emptyDir, you wouldn't actually want to use this, as you want the full output from fs.readdir anyhow.

[btea]

I'm especially hesitant to add it as it's trivial to implement wherever it's needed; the code is literally:

!(await fs.readdir(dir)).length

Yes, the code implementation seems relatively simple.

Is it worth creating a method just for this?

It is hoped that providing this wrapper function is just a suggestion. It is difficult for me to give a strong support for whether it is worth adding. The scenario I am currently encountering is the example I provided above.

[RyanZim]

cc @JPeer264 @manidlou @jprichardson for thoughts

[SukkaW]

@RyanZim I have some thoughts.

fs.readdir can be extremely slow if a folder contains many items (that's why #1028 is made, which replaces readdir w/ opendir).

fs.opendir is more performant (since it implements stream API), but it can't be used in a one-liner like !(await fs.readdir(dir)).length. Thus a util isEmptyDir using fs.opendir under the hood is trivial for me.

[RyanZim]

@SukkaW That's an interesting point; in that case I'd be open to a PR adding it.

[SukkaW]

@SukkaW That's an interesting point; in that case I'd be open to a PR adding it.

I can create a PR adding it!

[zcoresion]

Maybe is-directory-empty from sindresorhus is helpful

[SukkaW]

Maybe is-directory-empty from sindresorhus is helpful

Pure ESM module, which is bad. Probably should just implement this in fs-extra.

[zcoresion]

Maybe is-directory-empty from sindresorhus is helpful

Pure ESM module, which is bad. Probably should just implement this in fs-extra.

That's what I mean. Its source code is only a few lines