clize

clize

run any exported object directly from the CLI

Install

$ npm i -g clize
$ clize ~/Desktop/foo.js 123 \'hello\' # ...

Usage

Let's say we have a foo.js file in ~/Desktop/foo.js. This file looks like this :

module.exports = (a, b) => {
  return a + b
}

This is great and all, we require it in out other files and use the return value. However I often find myself in need of a module that can be required, but also that can be executed directly from the CLI and still work.

Now with clize you can directly call such modules. Here is how it looks like :

$ clize ~/Desktop/foo.js 1 2
3

That's it.

Module file path

You can pass either :

• relative file path (../../foo/bar.js)
• absolute file path (/Users/user/foo/bar.js)

Module name

By default, only the default export is required and executed. If you use named export, you can specificy the -m (module) option along with the module name.

$ clize ~/Desktop/foo.js -m coolModule 1 2

Where foo.js contains exports.coolModule = ...

Module arguments

You can pass as many arguments as you wish to your module. To keep the code clean and the CLI easy to use, you will need to escape variable delimitation characters. What this means :

• integer -> 4 -> no delimitation, simply write 4
• string -> 'hello' -> has ' as delimitation, your shell will strip these characters if not escaped, so write \'foo\' Same goes for any variable delimitation character that might be messed with by your shell.

$ clize ~/Desktop/foo.js 1 2
3
$ clize ~/Desktop/foo.js 1 \'2\' # js auto ineference
12
$ clize ~/Desktop/foo.js \'1\' \'2\'
12

How it Works

To be completed later, it's very easy, watch in index.ts there's only like 20 lines of code.