命令行基础 - 解析命令行参数 - 使用 commander.js

Node.js 命令行基础 - 解析命令行参数 - 使用 commander.js

在 Node.js 开发中，处理命令行参数是一个常见的需求。当我们编写脚本或者工具时，往往需要从命令行获取用户输入的参数，以便根据不同的参数执行不同的操作。commander.js 是一个强大且流行的 Node.js 库，专门用于解析命令行参数，它可以帮助我们轻松地创建用户友好的命令行接口。本文将详细介绍如何使用 commander.js 来解析命令行参数。

安装 commander.js

首先，我们需要安装 commander.js。可以使用 npm 或者 yarn 进行安装：

npm install commander
# 或者
yarn add commander

基本使用示例

下面是一个简单的示例，展示了如何使用 commander.js 来解析命令行参数：

const { program } = require('commander');
// 设置程序的版本
program.version('1.0.0');
// 定义一个选项
program.option('-n, --name <name>', 'Your name');
// 解析命令行参数
program.parse(process.argv);
// 获取选项的值
const options = program.opts();
if (options.name) {
    console.log(`Hello, ${options.name}!`);
} else {
    console.log('Hello, stranger!');
}

在上述代码中，我们首先引入了 commander 库，并从中解构出 program 对象。然后，我们使用 program.version 方法设置了程序的版本号。接着，使用 program.option 方法定义了一个选项 -n 或 --name，该选项后面需要跟随一个参数 <name>，用于指定用户的姓名。最后，使用 program.parse 方法解析命令行参数，并通过 program.opts 方法获取选项的值。

运行示例

将上述代码保存为 hello.js，然后在命令行中运行：

node hello.js -n John

输出结果：

Hello, John!

如果不提供 -n 选项，运行：

node hello.js

输出结果：

Hello, stranger!

定义命令

除了选项，commander.js 还支持定义命令。下面是一个示例：

const { program } = require('commander');
// 定义一个命令
program
 .command('add <a> <b>')
 .description('Add two numbers')
 .action((a, b) => {
    const result = parseInt(a) + parseInt(b);
    console.log(`${a} + ${b} = ${result}`);
  });
// 解析命令行参数
program.parse(process.argv);

在上述代码中，我们使用 program.command 方法定义了一个名为 add 的命令，该命令后面需要跟随两个参数 <a> 和 <b>。使用 program.description 方法为命令添加了描述信息。最后，使用 program.action 方法定义了命令的执行逻辑。

运行示例

将上述代码保存为 add.js，然后在命令行中运行：

node add.js add 2 3

输出结果：

2 + 3 = 5

选项和参数的类型

commander.js 支持为选项和参数指定类型。下面是一个示例：

const { program } = require('commander');
// 定义一个选项，指定类型为数字
program.option('-p, --port <number>', 'Port number', parseInt);
// 解析命令行参数
program.parse(process.argv);
// 获取选项的值
const options = program.opts();
if (options.port) {
    console.log(`Listening on port ${options.port}`);
}

在上述代码中，我们使用 parseInt 函数作为选项 -p 或 --port 的类型转换器，确保输入的参数为数字。

运行示例

将上述代码保存为 port.js，然后在命令行中运行：

node port.js -p 8080

输出结果：

Listening on port 8080

总结

通过以上介绍，我们可以看到 commander.js 提供了丰富的功能，使得我们可以轻松地创建用户友好的命令行接口。无论是简单的脚本还是复杂的工具，commander.js 都能帮助我们高效地处理命令行参数。希望本文对你有所帮助，让你在 Node.js 开发中更加得心应手。