quick-shell.js

what is quick-shell.js ?

quick-shell is a nodejs lib, which you can use it to create a shell application quickly

install

install with npm:

npm install quick-shell

basic usage

let shell = require('quick-shell');

shell
    .welcome('welcome to my shell program')
    .prompt('$ ')
    .listen('echo', (params) => {
        console.log(params);
    })
    .listen('add', (params) => {
        let temp = params.split(' ');
        console.log(
            (parseInt(temp[0]) + parseInt(temp[1])).toString()
        );
    })
    .start();

run the js file, a shell will start like this:

welcome to my shell program
$

when you input 'echo hello world':

welcome to my shell program
$ echo hello world
hello world

when you input 'add 7 9':

welcome to my shell program
$ add 7 9
16

just like this, if you want to create a shell application, just use 'listen' to create a listen relation of instruction. As the instruction was caught, its handler whick you input already will be called

API

import:

let shell = require('quick-shell');

link style call:

shell
    .//...
    .//...
    .start();

set the welcome text:

shell
    .welcome('your welcome text');

set the prompt text:

shell
    .prompt('# ');

set the error text:

shell
    .error({
        inputNothing: 'you input nothing',
        noMatchedInstruction: 'have no matched instruction'
    });

create a listen relation:

// by the way, the params is same as 'param param param', you need to split it by yourself
shell
    .listen('echo', (params) => {
        console.log(params);
    });

if you want more sumtom function, set the callback:

shell
    .onStart(() => {
        // do something on shell start
    })
    .onExit(() => {
        // do something on shell exit
    })
    .onLine((line) => {
        // do something when a line inputed
    })
    .onCaught((instruction, params) => {
        // do something when a instruction was caught
    });

start the shell program:

shell
    .start();

about

• author: china.nanJing.nuaa.kindem
• GitHub: FlyAndNotDown - quick-shell