专栏首页前端全栈开发者【实战】从零开始使用JavaScript制作自己的命令行(CLI工具)

【实战】从零开始使用JavaScript制作自己的命令行(CLI工具)

我们每天都使用CLI程序(例如Terminal,cmd,Powershell等)进行软件开发。你使用的每个工具本质上都是其他软件工程师的产品,我们也可以制作自己的CLI工具。

从零开始的简单CLI,让我们开始吧!

首先,让我们制作一个简单的CLI工具,该工具会打印“ HelloWord”

要制作CLI,您需要制作两个文件

  • package.json:将设置和配置指定入口
  • index.js:根据CLI命令的可执行文件

添加Package.json 文件

// package.json
{
  "name": "my-cli",
  "version": "0.0.1",
  "description": "nodejs cli program",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Dunizb",
  "license": "ISC"
}

在package.json中,指定有关当前CLI程序的元数据, nameversiondescriptionauthor等。

创建 index.js 可执行文件

// index.js
#! /usr/bin/env node
console.log('Hello CLI');

那么,第一句话是什么意思?

Linux和基于Unix的操作系统(例如Mac)中,#! / usr / bin / env node 不仅仅是一个注释。它使用在 /usr/bin/env 中注册的node命令来运行文件。

但是,在Windows中,这只是一个注释。

添加bin属性

我们添加 bin 属性来实际运行 index.js 文件

// package.json
{
  "name": "my-cli",
  "version": "0.0.1",
  ...
  ...
  "license": "ISC",
  "bin": {
    "cli": "./index.js"
  }
}

bin 属性具有可执行文件,cli 命令要求运行 index.js 文件。

运行CLI

最后,让我们运行CLI在控制台上打印Hello CLI。通过运行 npm i -g 在package.json中安装配置。

下次你在控制台上运行 npm i -g,您获得了 updated 1 package...,而不是 added 1 package ...

然后运行 cli 命令。终于, Hello CLI!

你可能需要在Mac和Linux环境中附加 sudo 命令(即 sudo cli),没有 node_modules 文件夹,因为你没有安装依赖项。

CLI中的Process.argv

// index.js
#! /usr/bin/env node
console.log('Hello CLI', process.argv);

你可以使用 process.argv 在命令中找到选项,选项以数组形式显示。

你不需要在每次更新 index.js 代码时再次运行 npm i -g,因为你已经将 package.jsonbin 属性连接到 cli 命令和 index.js 文件。因此,每次调用 cli 命令时,都可以执行 index.js 文件(它不是来自缓存的,因此您可以运行新的更新内容)。

在终端中运行命令:

cli one two three four

结果

数组中的前两个元素nodecli 命令的路径。(对于Windows系统,它可能会打印出不同的输出)输出可能会因您的计算机设置和环境而异(这取决于您在计算机上安装nodecli命令的位置)。

此外,one two three four 表示为数组类型

其次,通过“用户输入”与用户交互的简单CLI工具

使用称为readline的本机Node模块从用户那里获取输入。

// index.js
#! /usr/bin/env node
const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
});

rl.question("你今天好吗(快乐, 悲伤)?", (answer) => {
  if(answer === "快乐") {
    console.log("听你这么说我很高兴");
  } else if (answer === "悲伤") {
    console.log("希望你明天感觉好些")
  } else {
    console.log("你是快乐还是悲伤?");
  }
	rl.close();
});

你可以使用 readline 模块中的 createInterface 方法创建 rl 对象。

process.stdinprocess.stdout 是控制台输入和输出流。

readline 模块接受来自用户的输入,rl 对象提问法是向用户提问的一种方法,回调函数具有一个 answer 参数(来自用户的输入),如果所有 I/O(输入和输出)完成,则关闭 rl 对象。

我们是否可以通过再次询问用户在这种情况下是否既不回答“高兴”也不回答“悲伤”来进一步提高CLI ?

再次询问用户时,是否回答错误

#! /usr/bin/env node
const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
});

console.clear();

const answerCallback = (answer) => {
  if (answer === "快乐") {
    console.log("听你这么说我很高兴");
    rl.close();
  } else if (answer === "悲伤") {
    console.log("希望你明天感觉好些");
    rl.close();
  } else {
    console.log("你是快乐还是悲伤?");
    rl.question("你今天好吗(快乐,悲伤)? ", answerCallback);
  }
};

rl.question("你今天好吗(快乐,悲伤)?", answerCallback);

当程序开始使用 console. Clear 时清除控制台,然后使用 rl.question 方法询问用户输入并使用answerCallback 函数获得答案。

如果答案既不是悲伤也不是快乐,请清除控制台,然后递归再次提问,如果答案是悲伤或快乐,关闭输入控制台。

总结

在本文中,我们练习了一种制作简单的CLI工具(要求用户输入)的方法。。


本文首发于微信公众号《前端外文精选》,关注即送大礼包,准能为你节省不少钱!

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 译|通过构建自己的JavaScript测试框架来了解JS测试

    测试(单元或集成)是编程中非常重要的一部分。在当今的软件开发中,单元/功能测试已成为软件开发的组成部分。随着 Nodejs 的出现,我们已经看到了许多超级 JS...

    Dunizb
  • 使用POI组件导出数据为Excel文件

    Dunizb
  • HTML5 VideoAPI,打造自己的Web视频播放器

    注意:audio和video元素必须同时包含开始和结束标签,不能使用<audio />这样的空元素语法形式。

    Dunizb
  • C++之函数模板(一)

    C++是一门非常强大,非常复杂,非常庞大的语言。C++本身从C语言发展而来,它一开始就具备了面向过程编程和面向对象编程这两种编程范式(编程风格,其实就是程序设计...

    zy010101
  • 宝塔Linux面板wordpress网站伪静态设置教程

    赵帆同学GXUZF.COM
  • 深度学习---反向传播的具体案例

    最近遇到一位小师弟,他让我给他推导一下前向传播和反向传播过程,于是我埋头在白纸上一步一步推导,最后,小师弟特别开心,在此过程中,我也更一步认识了这个知识点,感觉...

    计算机视觉研究院
  • AirTest 基本使用及框架浅剖析——五分钟上手制作游戏辅助

    Airtest Project 是为编写自动化脚本,达到提升测试效率的一整套解决方案。它可以轻松的扩展到多平台、多引擎上;如基础的 Android和IOS手机应...

    1_bit
  • Java基础-判断语句

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明...

    cwl_java
  • 编写通用 Hello World 驱动程序 (KMDF)

    本主题介绍了如何使用内核模式驱动程序框架 (KMDF) 编写非常小的通用 Windows 驱动程序。

    战神伽罗
  • PHP 编码规范

    PHP 编码规范。 关键字必须小写 true, false, null。 类 类的 属性 和 方法 必须添加访问修饰符(private、protected 以及...

    康怀帅

扫码关注云+社区

领取腾讯云代金券