Node.js yargs 命令行参数配置与使用指南

本文详细介绍如何在 Node.js 项目中使用 yargs 库处理命令行参数。内容涵盖 yargs 的安装方法，以及如何通过 argv 对象读取参数、设置别名、定义必填项与默认值、配置布尔值解析，以及生成帮助文档和示例。通过具体代码示例，帮助开发者快速掌握 Node.js 命令行工具的开发技巧。

Node.js 使用 yargs 处理命令行参数详解

本文通过具体实例，讲解如何在 Node.js 环境中利用 yargs 库来解析和处理命令行参数，供读者参考学习。

yargs 是一个功能强大的库，能够简化命令行参数的解析过程。

安装 yargs

一、安装 yargs


npm install yargs --save

读取命令行参数

二、读取命令行参数


const yargs = require('yargs');
let argv = yargs.argv;
console.log(argv);

yargs 使用 argv 对象来存储解析后的命令行参数。在传递参数时，参数名需以双连字符 -- 开头，参数名与值之间可以使用等号 = 或空格分隔。

argv 对象包含一个下划线 _ 属性，该属性用于获取未以连字符开头的普通参数。


const yargs = require('yargs');
let argv = yargs.argv;
console.log(argv._);

参数别名与配置

此外，yargs 支持为参数设置别名，以便用户使用更简短的命令。


const yargs = require('yargs');
let argv = yargs
  .alias('n', 'name')
  .alias('s', 'save')
  .alias('w', 'width')
  .argv;
console.log(argv);

参数选项设置

.demandOption(key, msg) 用于指定某个参数是否为必填项，并可自定义未提供时的错误提示信息。

.default(key, value, [description]) 用于为参数设置默认值。

.describe(key, desc) 用于为参数添加描述信息，通常显示在帮助文档中。


const yargs = require('yargs');
let argv = yargs
  .alias('s', 'src')
  .alias('d', 'dst')
  .demandOption(['s', 'd'], 's 与 d 必须填写')
  .default('s', 'a.txt')
  .default('d', 'b.txt')
  .describe('s', '源文件')
  .describe('d', '目标文件')
  .argv;
console.log(argv);

开发者也可以通过 .option(key, [opt]) 方法统一配置所有参数选项。


const yargs = require('yargs');
let argv = yargs
  .option('s', {
    alias: 'src',
    demandOption: true,
    default: 'a.txt',
    describe: '源文件',
    type: 'string'
  })
  .option('d', {
    alias: 'dst',
    demandOption: true,
    default: 'b.txt',
    describe: '目标文件',
    type: 'string'
  })
  .argv;
console.log(argv);

布尔值与帮助信息

在某些场景下，我们仅需判断某个参数是否被传递，即其值为 true 或 false。

使用 .boolean(key) 可以将指定参数解析为布尔类型。


const yargs = require('yargs');
let argv = yargs
  .alias('s', 'save')
  .boolean(['s'])
  .argv;
console.log(argv);

.usage() 用于定义命令行的使用格式说明。

.example(cmd, desc) 用于提供具体的使用示例。

.help() 用于生成并显示帮助信息。

.epilog(str) 用于在帮助信息的末尾添加额外内容。


const yargs = require('yargs');
let argv = yargs
  .alias('s', 'save')
  .usage('Usage: --s <filename>')
  .example('--s a.txt', '设置源文件')
  .epilog('copyright')
  .help('info')
  .argv;
console.log(argv);

希望本文的内容能对从事 Node.js 程序设计的开发者有所帮助。

Node.js 使用 yargs 库处理命令行参数详解