quick-shell.js

宣布自
Kindem的博客,迎接人人转载,然则要注意说明出处

quick-shell.js简介

一向想本身宣布一个npm包尝尝,正巧方才学完操纵系统,写了许多shell范例的小顺序,就想着要不在nodejs上封装一套用于疾速建立简朴shell类运用的库,因而quick-shell.js就诞生了

运用quick-shell你能够疾速构建一个shell范例的简朴运用,异常合适运用js做课设或许一些小demo

装置

该包已宣布在npm上了,能够直接运用npm装置到项目依靠

npm install quick-shell

基础运用

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();

像如许间能够简朴地构建一个shell范例运用,上面的代码运转时会像如许:

welcome to my shell program
$

当你输入 ‘echo hello world’:

welcome to my shell program
$ echo hello world
hello world

当你输入 ‘add 7 9’:

welcome to my shell program
$ add 7 9
16

就像如许,每当你想要为你本身的shell运用增加一条指令,只需要增加它的相应即可

API

装置:

npm install quick-shell

链式挪用:

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

设置迎接笔墨:

shell
    .welcome('your welcome text');

设置提醒符:

shell
    .prompt('# ');

自定义毛病提醒:

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

建立一个指令监听器:

// 这里的 params 以 'param param param' 的情势存在
shell
    .listen('echo', (params) => {
        console.log(params);
    });

假如你照样不满足于现有的功用,你能够运用内部定义的事宜来举行自定义操纵:

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
    });

最先运转顺序:

shell
    .start();

参考

    原文作者:流渚微梦
    原文地址: https://segmentfault.com/a/1190000015593084
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞