用Node轻松打造CLI工具，手把手教学

2023-11-19 23:53:00

前言

在开始本教程之前，我们先用5W法来了解下本文的基调：

What（什么）： CLI是command-line interface的缩写，用码农圈的黑话来说就是命令行界面。它有个好基友叫GUI（Graphical User Interface，图形用户界面）。
Why（为什么）： CLI之所以存在，是因为它有许多GUI不具备的优点。比如，它可以让你更快速地完成任务，因为你不需要点击鼠标或在菜单中寻找选项。而且，CLI通常比GUI更轻量级，这意味着它占用更少的资源，可以在更老旧的计算机上运行。
When（什么时候）： CLI非常适合那些需要经常重复执行的任务。比如，你可以使用CLI来检查文件系统、管理文件、运行程序，甚至可以用来写代码。
Where（哪里）： CLI可以在任何地方使用，只要你有计算机和终端模拟器。
Who（谁）： CLI对所有人开放，只要你有兴趣学习，都可以使用它来提高自己的工作效率。

开始教程

1. 设置项目

首先，你需要创建一个新的Node.js项目。你可以使用以下命令来做到这一点：

mkdir my-cli-tool
cd my-cli-tool
npm init -y

这将在你的当前目录中创建一个名为my-cli-tool的新文件夹，并在其中创建一个新的Node.js项目。

接下来，你需要安装一些必需的依赖项。你可以使用以下命令来做到这一点：

npm install commander

这个依赖项将允许你轻松地创建和管理CLI工具。

2. 编写脚本

现在，你可以开始编写CLI工具的脚本了。在你的项目目录中创建一个名为index.js的新文件。然后，将以下代码复制到该文件中：

const commander = require('commander');

commander
  .version('0.1.0')
  .option('-f, --file <file>', 'The file to be processed')
  .option('-o, --output <output>', 'The output file')
  .action((options) => {
    // Your code here
  })
  .parse(process.argv);

这段代码将创建一个新的CLI工具，它可以接受两个选项：-f或--file，用于指定要处理的文件；-o或--output，用于指定输出文件。

3. 处理用户输入

在上面的代码中，你可以在action函数中处理用户输入。这个函数将在用户运行CLI工具时被调用。你可以使用options对象来访问用户提供的选项。

例如，以下代码将读取用户提供的文件，并将其内容输出到控制台：

const fs = require('fs');

commander
  .version('0.1.0')
  .option('-f, --file <file>', 'The file to be processed')
  .action((options) => {
    const data = fs.readFileSync(options.file, 'utf8');
    console.log(data);
  })
  .parse(process.argv);