【总结】1591- 从入门到精通：使用 TypeScript 开发超强的 CLI 工具

news2025/5/28 4:04:44

作为一名开发者，掌握 CLI 工具的开发能力是非常重要的。本文将指导你如何使用 TypeScript 和 CAC 库开发出功能强大的 CLI 工具。

快速入门

首先，需要先安装 Node.js 和 npm（Node Package Manager），然后在项目目录中创建一个 package.json 文件：

npm init -y

接下来安装 CAC 和 TypeScript：

npm install cac typescript --save-dev

现在我们就准备好开始我们的 CLI 项目了。

简单示例

让我们创建一个简单的 CLI 工具，可以接受用户的名字并输出“Hello, Pingan8787”。

首先，创建一个名为 index.ts 的文件，然后输入以下代码：

import cac from "cac";

const cli = cac();

cli.command("greet [name]", "Greet user with his name").action((name) => {
  console.log(`Hello, ${name || "unknown"}`);
});

cli.parse();

然后，运行以下命令以编译 TypeScript 代码：

tsc index.ts

最后，我们可以在终端中运行以下命令：

node index.js greet Pingan8787

我们将会看到输出“Hello, Pingan8787”。

实际案例

让我们考虑一个更复杂的例子，我们将创建一个能够计算数学表达式的 CLI 工具。

首先，我们需要安装一个简单的计算库，如「mathjs」：

npm install mathjs

然后，在 mathjs.ts 文件中添加以下代码：

import cac from "cac";
import math from "mathjs";

const cli = cac();

cli
  .command("calculate [expression]", "Calculate a math expression")
  .action((args) => {
    console.log(`Result: ${math.eval(args.expression)}`);
  });

cli.parse();

运行以下命令编译代码：

tsc mathjs.ts

最后，我们可以在终端中运行以下命令：

node index.js calculate [Expression]

我们将会看到输出「Result: [Expression Result]」。

示例补充：commander

当然，也可以使用 commander 库开发 CLI 工具时，下面是一个使用 commander 库开发的简单 CLI 工具的代码示例：

#!/usr/bin/env node

import { Command, CommanderStatic } from "commander";

const program: CommanderStatic = new Command();

program
  .version("0.1.0")
  .description("A simple CLI tool built with CAC library")
  .option("-n, --name [value]", "Your name")
  .action((options) => {
    console.log(`Hello, ${options.name || "world"}!`);
  });

program.parse(process.argv);

在上面的代码中，我们创建了一个简单的 CLI 工具，它接受一个名字作为参数，并打印一条消息。

该工具参数：

program.version 方法指定版本号；
program.description 方法指定描述；
program.option 方法指定选项；
program.action 方法指定要执行的操作。

我们可以通过运行 node filename.ts 来测试该工具，并通过添加不同的选项来查看不同的输出结果。

这仅仅是一个简单的示例，我们可以通过继续学习和实践来扩展其功能。希望大家能从这个示例中受益。

拓展使用

CAC 还有许多其他有用的特性，比如选项和参数，帮助信息，自定义错误处理等。我们可以在官方文档中了解更多内容：https://github.com/cacjs/cac。

高级主题和拓展 CLI 工具

如果你想进一步深入了解 CLI 工具的开发，可以阅读以下内容：

如何构建 CLI 工具：https://developer.atlassian.com/blog/2019/02/how-to-build-a-cli-tool-with-node-js/
如何使用 Commander.js 开发 CLI 工具：https://github.com/tj/commander.js/
如何使用 Oclif 开发 CLI 工具：https://oclif.io/
如何使用 Ink 开发 CLI 工具界面：https://github.com/vadimdemedes/ink

以上内容可以帮助你深入了解 CLI 工具的开发，并学习如何开发出更加复杂的 CLI 工具。

总之，CLI 工具是一种功能强大且易于使用的工具，可以帮助我们在命令行环境中快速完成任务。使用 CAC 库和 TypeScript 开发 CLI 工具是一种不错的选择，因为它简单易用且功能强大。希望本文能够帮助你快速入门 CLI 工具的开发，并取得成功。