Back

quick-shell.js 简介

自己闲来无事写了一个用于构建 shell 应用的 Node.js 包,本文将详细介绍 quick-shell.js 的安装、使用和 APIs。

🧐 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 应用添加一条指令,只需要添加它的响应即可

🧀 APIs

安装:

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

🎫 参考

©2017-2021 Copyright kindem.xyz / 湘ICP备17018771号-1
Built with Hugo
Theme Stack designed by Jimmy