Nodejs命令行参数解析插件yargs的使用

Nodejs命令行参数解析插件yargs的使用
yargs 是一个用于 Node.js 的命令行参数解析库，它允许你轻松地解析命令行参数，并提供了一个友好的 API 来处理这些参数。下面是如何使用 yargs 的基本步骤和一些示例。

安装

首先，你需要安装 yargs。可以通过 npm 安装：

npm install yargs --save

基本用法

1. 解析简单的命令行参数

假设你有一个名为 app.js 的文件，内容如下：

const yargs = require('yargs');

// 解析命令行参数
const argv = yargs.argv;

console.log(argv);

运行这个脚本并传递一些参数：

node app.js --name "John Doe" --age 30

输出将会是：

{
  _: [],
  name: 'John Doe',
  age: 30,
  '$0': 'app.js'
}

这里 _ 数组包含所有未被识别的参数，$0 包含执行脚本的名称。

2. 使用别名

你可以为参数设置别名：

const yargs = require('yargs');

yargs.alias('n', 'name')
      .alias('a', 'age')
      .argv;

console.log(yargs);

现在，你可以使用别名来传递参数：

node app.js -n "Jane Doe" -a 25

3. 设置默认值

你可以为参数设置默认值：

const yargs = require('yargs');

yargs.default({ name: 'Default User', age: 20 })
      .argv;

console.log(yargs);

如果未提供 name 和 age 参数，它们将分别使用默认值 "Default User" 和 20。

4. 指定参数类型

你可以指定参数的类型，比如 boolean、string 等：

const yargs = require('yargs');

yargs.boolean('verbose')
      .argv;

console.log(yargs);

运行时，你可以通过以下方式传递布尔参数：

node app.js --verbose

或者

node app.js --no-verbose

5. 版本和帮助信息

你可以添加版本和帮助信息：

const yargs = require('yargs');

yargs.version('1.0.0')
      .help()
      .argv;

console.log(yargs);

现在，你可以使用 -v 或 --version 显示版本信息：

node app.js -v

同样，使用 -h 或 --help 显示帮助信息：

node app.js -h

示例：一个完整的应用

假设我们想要创建一个简单的 CLI 应用，它接受用户名和年龄，并显示一条问候消息：

const yargs = require('yargs');

const argv = yargs.usage('Usage: $0 --name <name> --age <age>')
              .demandOption(['name', 'age'])
              .argv;

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

运行：

node app.js --name "Alice" --age 30

输出：

Hello, Alice! You are 30 years old.

以上就是 yargs 的一些基本用法。通过这些功能，你可以创建非常强大的命令行工具。