建立quick-shell.js庫的使用介紹

這篇文章主要介紹了關於創建quick-shell.js庫的使用介紹，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

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

以上就是本文的全部內容，希望對大家的學習有所幫助，更多相關內容請關注PHP中文網！

相關推薦：

關於Node異步I/O的介紹

#基於vue.js的dialog外掛art- dialog-vue2.0的發佈內容

以上是建立quick-shell.js庫的使用介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！