JS usage? - Githubissues

shelljs / shx

Portable Shell Commands for Node

MIT License

1.72k stars 44 forks source link

JS usage? #103

Closed corysimmons closed 7 years ago

corysimmons commented 7 years ago

I only see CLI and npm script usage. Is ShellJS for JS and shx is for CLI?

nfischer commented 7 years ago

Yeah, that's the idea. Shx exposes ShellJS implementations to the commandline.

ShellJS: good for writing long scripts, all in JS, running via NodeJS (node myScript.js)
Shx: good for writing one-off commands in npm package scripts (like "clean": "shx rm -rf out/")

nfischer commented 7 years ago

Closing this for now. Ping this thread if you need further clarification 😄

corysimmons commented 7 years ago

Nice, thank you.

I just noticed there is a spot for this in the ShellJS README. Maybe add exactly what you wrote above in this README as well? I ended up here because ShellJS was like "USE SHX FOR COMMANDS" and I was like "I want commands!" then I got here and was like "Wait, how is this different from ShellJS?"

nfischer commented 7 years ago

@corysimmons if you have some idea of what would make the docs more helpful, I'll gladly look over a pull request :smile:

corysimmons commented 7 years ago

haha, no problem.

https://github.com/shelljs/shx/pull/104