npm 包 terminal-kit 使用教程

阅读时长 7 分钟读完

介绍

Terminal-kit 是一个在 Node.js 环境下操作终端的库。使用 terminal-kit,可以在终端上输出彩色的文字、创建交互式界面、监听键盘输入等等。在前端开发中,我们也经常需要在终端界面下进行一些操作,如启动项目、调试代码等。而 terminal-kit 就可以帮助我们更方便地完成这些任务。

安装

要安装 terminal-kit,需要先安装 Node.js 和 npm。在终端中输入以下命令即可安装:

基本用法

下面我们来看一下 terminal-kit 的基本用法。

输出彩色文字

在这段代码中,我们先使用 require 引入了 terminal-kit 包,并将其实例化为 term。然后通过调用 term.blueterm.redterm.yellow 方法,分别向终端输出带有不同颜色的文字。使用 \n 换行符来换行。运行代码后,终端效果如下所示:

创建交互式命令行界面

-- -------------------- ---- -------
----- ---- - ---------------------------------

-----------------
-------------

------------------ -- --- ----------- ----------------

---------------------- --- ------- --- ------- ---- ------- --------- -- -
  -- ------- -
    ----------------------- -------
    -------
  -

  ------------- --------- --------------------------------
  -----------
  ---------------
---
展开代码

在这段代码中,我们使用 term.grabInput 方法来开启键盘输入接收功能。然后调用 term.clear 方法清空终端内容。接着使用 term.cyan 方法输出带颜色的欢迎信息。最后调用 term.gridMenu 方法创建一个网格菜单,等待用户选择。当用户选择完毕后,term.gridMenu 回调函数中会传递两个参数:errorresponse。我们可以根据用户选择的内容来进行下一步操作。在本例中,我们输出用户选择的内容,并使用 process.exit 方法退出程序。

运行代码后,终端效果如下所示:

监听键盘输入

-- -------------------- ---- -------
----- ---- - ---------------------------------

-----------------
-------------

----------- --- --- -- ----- ------------

-------------- ------ -- -
  -- ----- --- --------- -
    ----------------------
    -------------------------- ---------- -- ----------
    ---------------
  -

  -------------------------------
---
展开代码

在这段代码中,我们依然使用 term.grabInput 方法来开启键盘输入接收功能。然后调用 term.clear 方法清空终端内容,并输出一条提示信息。接着使用 term.on 方法监听键盘输入事件。当监听到用户输入按键时,term.on 会回调传递一个参数 name,代表所输入的按键名称。我们可以根据名称来进行下一步操作。在本例中,我们将所有按键名称转换为大写并输出到终端上。当用户按下 CTRL+C 键时,我们终止键盘输入功能,提示用户程序已终止。

运行代码后,终端效果如下所示:

综合示例

下面的示例将以上三个例子综合在一起。在开头的交互式菜单中,选择不同的选项将会跳转到不同的示例。

-- -------------------- ---- -------
----- ---- - ---------------------------------

-----------------
-------------

------------------ -- --- ----------- ----------------

---------------------- ------- ------ ------- ----------- ----- ------- -- -------- -------- ------- --------- -- -
  -- ------- -
    ----------------------- -------
    -------
  -

  ------------- --------- --------------------------------
  -------------

  ------ ------------------------ -
    ---- --
      --------------------
      ------
    ---- --
      -----------------------
      ------
    ---- --
      ------------------------
      ------
  -
---

-------- ------------------- -
    --------------- ---------
    ------------- ---------
    ------------------- ---------
    ---------------  
-
  
-------- ---------------------- -
    ----------------- ----- ---- ----- ---
    ------------------------------- ------ -
        -- ------- -
          ----------------------- -------
          -------
        -
        -------------- -----------------------------------
        ---------------
    ---
-
  
-------- ----------------------- -
    ----------- --- --- -- ----- ------------
    
    -------------- -------------- -
        -- ----- --- --------- -
          ----------------------
          -------------------------- ---------- -- ----------
          ---------------
        -
    
        -------------------------------
    
        -- ----- --- -------- -
          -----------
        -
      ---
-
展开代码

在本示例中,我们首先创建了一个网格菜单,让用户选择不同的功能。当用户做出选择后,我们使用 switch 语句根据用户选择调用不同的函数。三个函数分别对应本教程前文所述的方法:输出彩色文字、创建交互式 CLI 和监听键盘输入。当用户完成某个功能操作后,程序将会停止运行并退出。

运行代码后,终端效果如下所示:

总结

本文介绍了如何使用 npm 包 terminal-kit 来操作终端。我们学习了如何输出彩色的文字、创建交互式命令行界面以及监听键盘输入。我们看到,terminal-kit 提供了很多工具让我们更加便捷地在终端下进行操作。同时,我们也了解了 Node.js 在前端开发中的优越性,也为未来的学习工作打下了基础。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/67343

纠错
反馈

纠错反馈