Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3p3r/cash-money
"cash-money" is a virtual busybox-like framework in pure javascript.
https://github.com/3p3r/cash-money
cash inquirer memfs shell vorpal webpack
Last synced: 14 days ago
JSON representation
"cash-money" is a virtual busybox-like framework in pure javascript.
- Host: GitHub
- URL: https://github.com/3p3r/cash-money
- Owner: 3p3r
- License: mit
- Created: 2022-05-26T21:16:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-28T22:38:45.000Z (over 2 years ago)
- Last Synced: 2024-12-15T13:50:23.741Z (20 days ago)
- Topics: cash, inquirer, memfs, shell, vorpal, webpack
- Language: JavaScript
- Homepage:
- Size: 978 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cash-money
"cash-money" is a virtual [busybox](https://busybox.net/)-like framework in pure javascript.
## usage
install:
```bash
npm i react-ode-cash-money
```
sample:
```JS
const { cash, fs } = require("react-ode-cash-money");
// this all happens in-memory!
(async () => {
console.log(await cash("echo 'hello world'"));
fs.writeFileSync("sample.txt", "hello file content", "utf8");
await cash("touch random.log");
console.log(await cash("cat sample.txt"));
console.log(await cash("ls -lah"));
})();
```
output:
```bash
hello world
hello file content
total 18
drw-rw-rw- 1 1000 1000 0 May 27 13:22 .
drw-rw-rw- 1 1000 1000 0 May 27 13:22 ..
-rw-rw-rw- 1 1000 1000 0 May 27 13:22 random.log
-rw-rw-rw- 1 1000 1000 18 May 27 13:22 sample.txt
drwxrwxrwx 1 1000 1000 0 May 27 13:22 tmp
```
## api
a single `use` api is exposed where you can define "programs" for the shell. `exec()` is program's entrypoint and `setup()` is like its `getopts`.
"cash-money" modifies "cash" to accept async `exec()`s but you still need to make sure `exec()`s are executed serially asynchronously.
meaning that you cannot call cash commands in the middle of each other. there is no threading or process management.
do a waterfall `await cash(); await cash();` and you are good with no race conditions.
```JS
const { console: logger, cash, use } = require("react-ode-cash-money");
// this works if you call before 1st execution
use({
// program's binary name
name: "sample",
// help when executed as "help "
help: "sample help",
// program's entry point
exec: async function (argv) {
// application logic goes here
if (argv.version) {
logger.log("Sample 1.0.0"); // or import console from cash-money
return 0;
}
},
// program's command line parser setup
setup: function (vorpal, interfacer, preparser) {
vorpal
.command("sample")
.parse(preparser)
.option("-v, --version", "show version")
.action(function (args, callback) {
// this call glues vorpal to cash basically
return interfacer.call(this, args, callback);
});
},
});
// this is how you use the new command:
(async () => {
console.log(await cash(`sample --version`));
console.log(await cash(`help sample`));
})();
```