TypeScript 中使用 commander

在本文中，我们将介绍如何在 TypeScript 中使用 commander 这个命令行解析器。commander 是一个轻量级的库，它可以帮助我们创建命令行工具，并处理命令行参数和选项。

阅读更多：TypeScript 教程

安装 commander

要使用 commander，我们首先需要将它添加到我们的项目中。我们可以通过 npm 或者 yarn 进行安装。打开终端，导航到项目目录，并输入以下命令：

npm install commander

或者

yarn add commander

安装完成后，我们就可以在我们的 TypeScript 代码中引入 commander 并开始使用它了。

创建一个简单的命令行工具

首先，让我们来创建一个简单的命令行工具。我们假设我们要开发一个名为 “mycli” 的工具，它可以接受一个参数，并输出一些信息。在项目的根目录下创建一个名为 “mycli.ts” 的文件，并输入以下代码：

import { Command } from 'commander';

const program = new Command();
program.version('1.0.0');

program
  .option('-n, --name <name>', 'Your name')
  .option('-a, --age <age>', 'Your age');

program.parse(process.argv);

const options = program.opts();
const name = options.name || 'Anonymous';
const age = options.age || 'Unknown';

console.log(`Hello, {name}! You are{age} years old.`);

在上面的代码中，我们首先引入了 commander 的 Command 类，并创建了一个新的实例。然后，我们使用 version 方法定义了我们的命令行工具的版本号。

接下来，我们使用 option 方法定义了两个选项：name 和 age。这些选项可以使用短参数（-n 和 -a）或长参数（–name 和 –age）来指定，并且可以接受一个值。我们还使用第二个参数来定义选项的描述。

最后，我们调用 parse 方法来解析命令行参数，并使用 opts 方法获取选项的值。如果选项没有指定值，则使用默认值。

在代码的最后，我们使用 console.log 输出一条带有用户输入信息的消息。

运行命令行工具

要运行我们的命令行工具，我们需要先将 TypeScript 代码编译为 JavaScript 代码。打开终端，导航到项目目录，并执行以下命令：

tsc mycli.ts

这将生成一个名为 “mycli.js” 的 JavaScript 文件。

接下来，我们可以使用 node 命令来执行生成的 JavaScript 文件：

node mycli.js

当我们运行命令行工具时，它将提示我们输入一些信息。我们可以使用选项来指定这些信息，例如：

node mycli.js --name John --age 25

这将输出以下消息：

Hello, John! You are 25 years old.

如果我们没有指定选项的值，命令行工具将使用默认值。例如，如果我们不指定 name 和 age：

node mycli.js

这将输出以下消息：

Hello, Anonymous! You are Unknown years old.

处理命令

除了选项，commander 还允许我们定义命令。命令是命令行工具的主要操作，可以接受参数和选项，并执行相应的逻辑。

让我们扩展我们的命令行工具，使其可以执行两个命令：greet 和 calculate。在 “mycli.ts” 文件中，添加以下代码：

program
  .command('greet <name>')
  .description('Greet someone')
  .action((name) => {
    console.log(`Hello, {name}!`);
  });

program
  .command('calculate <operation> <num1> <num2>')
  .description('Perform a calculation')
  .action((operation, num1, num2) => {
    let result;
    switch (operation) {
      case 'add':
        result = Number(num1) + Number(num2);
        break;
      case 'subtract':
        result = Number(num1) - Number(num2);
        break;
      case 'multiply':
        result = Number(num1) * Number(num2);
        break;
      case 'divide':
        result = Number(num1) / Number(num2);
        break;
      default:
        console.log('Invalid operation');
        return;
    }
    console.log(`Result:{result}`);
  });

在上面的代码中，我们使用 command 方法定义了两个命令：greet 和 calculate。这些命令可以接受参数，并且都有一个描述。

对于 greet 命令，我们使用 action 方法定义了一个回调函数，它将在命令执行时调用。回调函数接受命令的参数，并在控制台输出一条问候消息。

对于 calculate 命令，我们也使用 action 方法定义了一个回调函数。在回调函数中，我们根据不同的操作执行相应的计算，并输出结果。

现在，我们可以尝试运行这些命令。例如，我们可以执行以下命令来打招呼：

node mycli.js greet John

这将输出以下消息：

Hello, John!

我们还可以执行以下命令进行计算：

node mycli.js calculate add 2 3

这将输出以下消息：

Result: 5

总结

在本文中，我们介绍了如何在 TypeScript 中使用 commander 这个命令行解析器。我们通过创建一个简单的命令行工具来演示了 commander 的基本用法，并展示了如何处理命令、参数和选项。

使用 commander，我们可以轻松地为我们的 TypeScript 项目添加命令行界面，并处理命令行输入。希望本文对你理解和使用 commander 有所帮助！