JavaScript (Node.js) 的 CLI 框架

JavaScript (Node.js) 的 CLI 框架：创建强大的控制台应用程序

命令行界面 (CLI) 的开发是 Node.js 生态系统中的关键任务之一。从简单的脚本到复杂的 DevOps 工具，CLI 应用程序无处不在。然而，手动编写参数解析器、处理子命令和输出帮助信息是一项繁琐且容易出错的工作。这时，JavaScript (Node.js) 的 CLI 框架 就派上了用场，它们承担了所有繁琐的工作。

在本文中，我们将详细解析两个最流行的框架：Commander.js 和 Yargs。您将学习如何快速创建支持参数、选项、彩色输出和自动生成帮助信息的专业级 CLI 应用程序。

Commander.js — 经典与简洁

Commander.js 是 Node.js 上最著名且使用最广泛的 CLI 创建框架。它被用于 Vue CLI、Angular CLI 等众多项目中。其主要优势在于基于链式调用的直观 API。

安装

npm install commander

基本示例

const { Command } = require('commander');const program = new Command();

program  .name('greet')  .description('用于问候的 CLI')  .version('1.0.0');

program  .command('hello')  .description('问候用户')  .argument('<name>', '用户名')  .option('-l, --language <lang>', '问候语言', '俄语')  .action((name, options) => {    if (options.language === '英语') {      console.log(`Hello, ${name}!`);    } else {      console.log(`Привет, ${name}!`);    }  });

program.parse(process.argv);

在此示例中，我们创建了一个命令 greet hello，它接受一个必需参数 name 和一个可选选项 --language。Commander 会自动为 --help 命令生成帮助信息。

子命令支持

Commander 能很好地处理命令层级结构。您可以创建嵌套命令，这对于复杂工具尤其有用：

const project = program.command('project');

project  .command('init')  .description('初始化项目')  .action(() => {    console.log('项目已初始化');  });

project  .command('build')  .description('构建项目')  .option('-p, --production', '生产构建')  .action((options) => {    console.log(options.production ? '生产构建' : '普通构建');  });

Yargs — 灵活与强大

Yargs 是另一个强大的框架，专注于参数解析并提供非常灵活的功能。当您需要精确控制解析器行为，或者构建复杂的多层界面时，它尤其出色。

安装

npm install yargs

Yargs 示例

const yargs = require('yargs/yargs');const { hideBin } = require('yargs/helpers');

const argv = yargs(hideBin(process.argv))  .command('serve [port]', '启动服务器', (yargs) => {    yargs      .positional('port', {        describe: '服务器端口',        default: 3000      });  }, (argv) => {    console.log(`服务器已在端口 ${argv.port} 上启动`);  })  .option('verbose', {    alias: 'v',    type: 'boolean',    description: '详细输出'  })  .example('$0 serve 8080', '在端口 8080 上启动服务器')  .demandCommand(1, '必须指定一个命令')  .help()  .argv;

Yargs 提供了一种更确定性的命令定义方法。您可以精确指定哪些参数是位置参数，为它们设置默认值，检查类型等等。