教你用 Node 创建 CLI 工具

最新推荐文章于 2023-04-06 22:33:16 发布

ronghua_yang

最新推荐文章于 2023-04-06 22:33:16 发布

阅读量673

点赞数

分类专栏： javascript 文章标签： nodejs node创建cli工具

本文链接：https://blog.csdn.net/qq_43327962/article/details/111062463

版权

本文详细介绍了如何使用Node.js创建命令行界面（CLI）工具，包括准备工作、搭建命令行界面、安装依赖以及自动启动界面。通过创建bin目录、识别命令行、封装下载和安装过程，以及使用open库打开浏览器，实现了一个完整的CLI工具开发流程。

摘要由CSDN通过智能技术生成

准备工作

创建工程

mkdir my-cli
cd my-cli
npm init -y
npm i commander download-git-repo ora handlebars figlet clear chalk open watch -S

package.json 添加 bin 字段，将自定义的命令软连到全局环境，同时执行 npm link 创建链接。

 "bin": {
   
    "wbiao": "./bin//index.js"
  }

在根目录下创建 bin 文件夹，新建 index.js 文件，行首增加一行#!/usr/bin/env node指定当前脚本由 node.js 进行解析。

#!/usr/bin/env node

console.log("Hello World!!!");

命令行执行npm link,相当于把这个包连接到全局。
如果 npm link 报错，windows/mac 尝试使用管理员身份输入。
在命令行执行wbiao

2. 搭建命令行界面

插件名称	说明
commander	一个解析命令行命令和参数工具
inquirer	常用交互式命令行用户界面的集合
fuzzy	字符串模糊匹配的插件，根据输入关键词进行模糊匹配
json-format	json 美化/格式化工具

识别命令行 - commander
command 后面可跟一个 name，用空格隔开。

alias: 定义一个更短的命令行指令
description：描述，他在 help 里展示
action：注册一个回调函数
parse：解析命令行

const program = require("commander");
program.version(require("../package.json").version);

program
  .command("init <name>")
  .alias("i")
  .description("init project")
  .action((name) => {
   
    console.log(`项目名称为:${
     name}`);
  });

// 解析主进程的参数
program.parse(process.argv);

输出欢迎界面 - figlet/clear/chalk
输入 wbiao init 就会输出以下欢迎界面，那么需要什么工具？
在这里插入图片描述
工具：

figlet: 创建字符图案
clear: 清屏
chalk: 改变 log 颜色的工具

做法：

新建文件夹 lib，新建 init.js

const {
    promisify } = require("util");

const figlet = promisify(require("figlet")); // 字符画
const clear = require("clear"); // 清屏

最低0.47元/天解锁文章