让你的Node.js CLI工具生动起来:ora、chalk和figlet的艺术

在开发命令行工具时,用户体验和实时反馈至关重要。它们不仅可以提升用户的互动体验,还能使命令行工具看起来更加专业和友好。本文将介绍如何使用Node.js及相关插件来增强命令行工具的用户体验和反馈,通过实现功能如下载进度指示、美化命令行输出和生成ASCII艺术字来丰富CLI工具的交互。

工具与技术栈

我们将利用以下几个Node.js库来实现我们的目标:

  • ora:用于显示加载指示器,提供实时的进度反馈。
  • chalk:用于在命令行中添加颜色和样式,美化输出。
  • figlet:生成ASCII艺术字,用于输出大型文字,增加视觉吸引力。

实施步骤

安装所需插件

首先,我们需要安装上述提到的npm包。

kotlin 复制代码
npm install ora@5 chalk@4 figlet

请确保使用合适的版本,以兼容CommonJS模块系统。

集成ora实现下载进度指示

我们使用ora库来显示下载进度。当开始下载项目模板时,显示一个旋转的加载指示器,下载完成后显示成功消息,如果下载失败则显示错误消息。

javascript 复制代码
const ora = require("ora");
const spinner = ora('Downloading source...').start();

// 伪代码示例
download(url, project, {clone: true}, (err) => {
  if (!err) {
    spinner.succeed('Download successful');
  } else {
    spinner.fail('Download failed');
  }
});

使用chalk美化命令行输出

接下来,我们用chalk库给命令行输出添加颜色,使其更加易读和吸引人。

javascript 复制代码
const chalk = require("chalk");

// 伪代码示例
console.log(chalk.blue('Download successful'));
console.error(chalk.red('Download failed'));

用figlet增加ASCII艺术字输出

最后,我们使用figlet库在特定事件(如下载完成)后输出ASCII艺术字,为用户提供独特的视觉体验。

javascript 复制代码
const figlet = require("figlet");

// 伪代码示例
console.log(figlet.textSync('Done!', { horizontalLayout: 'full' }));

综合应用

将以上技术结合,我们得到一个增强用户体验的下载功能实现。

javascript 复制代码
const download = require("download-git-repo");
const ora = require("ora");
const chalk = require("chalk");
const figlet = require('figlet');

const downloadFun = function (url, project) {
  const spinner = ora('Downloading source...').start();

  download(url, project, {clone: true}, (err) => {
    if (!err) {
      spinner.succeed(chalk.green('Download successful!'));
      console.log(chalk.yellow(figlet.textSync('Done!', { horizontalLayout: 'full' })));
      console.log(chalk.blue(`You can start by running:
cd ${project}
${chalk.green('npm install')}
${chalk.green('npm run dev')}`));
    } else {
      spinner.fail(chalk.red('Download failed'));
      console.error(chalk.red(err));
    }
  });
}

结语

通过使用ora、chalk和figlet等库,我们不仅增强了命令行工具的功能性,还大大提升了用户体验和工具的视觉吸引力。这些技巧能够帮助你构建更加专业和友好的Node.js命令行应用。

相关推荐
摇滚侠3 小时前
Spring Boot 3零基础教程,WEB 开发 静态资源默认配置 笔记27
spring boot·笔记·后端
天若有情6735 小时前
Java Swing 实战:从零打造经典黄金矿工游戏
java·后端·游戏·黄金矿工·swin
一只叫煤球的猫6 小时前
建了索引还是慢?索引失效原因有哪些?这10个坑你踩了几个
后端·mysql·性能优化
magic334165637 小时前
Springboot整合MinIO文件服务(windows版本)
windows·spring boot·后端·minio·文件对象存储
开心-开心急了8 小时前
Flask入门教程——李辉 第一、二章关键知识梳理(更新一次)
后端·python·flask
掘金码甲哥8 小时前
调试grpc的哼哈二将,你值得拥有
后端
小学鸡!8 小时前
Spring Boot实现日志链路追踪
java·spring boot·后端
用户21411832636029 小时前
OpenSpec 实战:用规范驱动开发破解 AI 编程协作难题
后端
Olrookie10 小时前
若依前后端分离版学习笔记(二十)——实现滑块验证码(vue3)
java·前端·笔记·后端·学习·vue·ruoyi
LucianaiB10 小时前
招聘可以AI面试,那么我制作了一个AI面试教练不过分吧
后端