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

OriesZhu • 2024年4月11日下午8:46 • NodeJS • 阅读 208

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

工具与技术栈

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

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

实施步骤

安装所需插件

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

npm install ora@5 chalk@4 figlet

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

集成ora实现下载进度指示

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

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库给命令行输出添加颜色，使其更加易读和吸引人。

const chalk = require("chalk");

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

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

用figlet增加ASCII艺术字输出

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

const figlet = require("figlet");

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

综合应用

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

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