Skip to content

"cash-money" is a virtual busybox-like framework in pure javascript.

License

Notifications You must be signed in to change notification settings

3p3r/cash-money

Repository files navigation

cash-money

"cash-money" is a virtual busybox-like framework in pure javascript.

cash-money

usage

install:

npm i react-ode-cash-money

sample:

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:

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(<thing 1>); await cash(<thing 2>); and you are good with no race conditions.

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 <command>"
  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`));
})();

About

"cash-money" is a virtual busybox-like framework in pure javascript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published