Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unix commands vs. fs-extra functions #753

Closed
manidlou opened this issue Feb 4, 2020 · 6 comments · Fixed by #795
Closed

Unix commands vs. fs-extra functions #753

manidlou opened this issue Feb 4, 2020 · 6 comments · Fixed by #795

Comments

@manidlou
Copy link
Collaborator

manidlou commented Feb 4, 2020

Something that I keep seeing in users' comments is that users expect fs-extra functions to have the same behavior/implementation as unix commands cp, mv, rm....

At least, I couldn't find anywhere in the docs that specifies we follow unix or posix or any other specs.

I think it is a good idea to clarify this for our users. So my question is, what should we do here? Should we follow some specs or we should specify in the docs that we don't follow any specs?

@RyanZim
Copy link
Collaborator

RyanZim commented Feb 4, 2020

I'm not interested in following specs for command-line *nix tools. The assumption probably comes from our function naming; also this could be improved:

"description": "fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.",

@RyanZim RyanZim added this to the 9.0.0 milestone Feb 4, 2020
@manidlou
Copy link
Collaborator Author

manidlou commented Feb 4, 2020

Yeah I'm not interested in following specs neither! I just wanna make sure it is clear for our users that we don't follow any specs and they shouldn't expect fs-extra functions to have the same behavior as unix commands.

@RyanZim
Copy link
Collaborator

RyanZim commented Feb 6, 2020

Do you want to submit a docs PR for this? Feel free to improve the npm description while you're at it.

@RyanZim
Copy link
Collaborator

RyanZim commented Mar 11, 2020

Looking closer, copy*, ensureDir*, & remove* all contain statements such as:

Like cp -r.

Should we remove these statements, or clarify that they're similar, but not the same?

@RyanZim
Copy link
Collaborator

RyanZim commented Mar 17, 2020

@manidlou bump

@RyanZim RyanZim removed this from the 9.0.0 milestone Mar 19, 2020
@manidlou
Copy link
Collaborator Author

manidlou commented Mar 20, 2020

I would say we remove them (I am still fine if you guys decide to edit them to be clear) but I don't understand how this would be helpful to users because they are ultimately different implementations and I think keeping them in the docs still leave some confusion around this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants