Node.js 中的 Yargs

2025年2月26日 | 4 分钟阅读

Yargs 是 Node.js 中用于构建命令行界面应用程序的库。它有助于创建新的命令，这些命令接受参数并根据所使用的命令执行操作。它也用于生成消息。

安装

开发人员可以使用 npm 安装此包。用于安装 yargs 库的命令是 "npm install yargs"。要检查版本，请使用命令 "npm version yargs"。

示例 1

让我们举一个例子来创建一个命令，用于在 Node.js 中查找二次方程的根。

 
const yargs = require('yargs');
class QuadraticEquation {
  constructor(a, b, c) {
    this.a = a;
    this.b = b;
    this.c = c;
  }
  calculateRoots() {
    const discriminant = this.b * this.b - 4 * this.a * this.c;
    if (discriminant > 0) {
      const root1 = (-this.b + Math.sqrt(discriminant)) / (2 * this.a);
      const root2 = (-this.b - Math.sqrt(discriminant)) / (2 * this.a);
      return { root1, root2 };
    } else if (discriminant === 0) {
      const root = -this.b / (2 * this.a);
      return { root };
    } else {
      return { error: 'No real roots' };
    }
  }
}
yargs
  .command({
    command: 'solve',
    describe: 'Solve a quadratic equation',
    builder: {
      a: {
        describe: 'Coefficient of x^2',
        demandOption: true,
        type: 'number',
      },
      b: {
        describe: 'Coefficient of x',
        demandOption: true,
        type: 'number',
      },
      c: {
        describe: 'Constant term',
        demandOption: true,
        type: 'number',
      },
    },
    handler: (argv) => {
      const { a, b, c } = argv;
      const equation = new QuadraticEquation(a, b, c);
      const roots = equation.calculateRoots();
      console.log('Roots:', roots);
    },
  })
  .demandCommand(1, 'You need to specify a command to run')
  .help()
  .alias('help', 'h')
  .argv;   

输出

说明

在这个例子中，我们首先使用 "npm init" 命令初始化 package.json 文件。接下来，使用上述命令安装 yargs 包。之后，创建一个 index.js 文件并将上述程序复制到 index.js 文件中。现在，为了使用创建的命令，请使用以下命令。

"node index.js solve -a 1 -b 3 -c 2"

在程序中，首先导入 yargs 库。之后，创建一个类，该类包含在给定系数时计算二次方程根的逻辑。此命令将 'a'、'b' 和 'c' 值作为系数。有一个名为 'calculate roo' 的方法，它将返回包含二次方程根的对象。如果没有根，它将返回一个表示没有实数根的对象。

yargs.command({}) 方法定义了一个名为 'solve' 的新命令，它描述了该命令并设置了构建器以接受用户输入的系数 'a'、'b' 和 'c' 的值。当调用 'solve' 命令时，将执行处理程序函数，创建 QuadraticEquation 类的实例并计算根。结果将记录到控制台。demandCommand(1, '您需要指定要运行的命令') 确保必须指定一个命令。help() 方法提供使用信息，并且 alias('help', 'h') 允许用户使用 -h 访问帮助功能。

示例 2

让我们举一个程序来为 Node.js 中的简单应用程序创建一个命令。

问题陈述

将有九个网格，用 1 到 9 表示，并用点指示。最初，球将在第 5 个位置，这意味着第 5 个位置将为零。现在，创建了四个命令，左命令将球从第 5 个位置移动到第 4 个位置，右命令将球移动到第 6 个位置，上命令将球移动到第 2 个位置，下命令将球移动到第 7 个位置。

Index.js

 
const yargs = require('yargs');
const Ball = require('./ball');
const ball = new Ball();
const moveBall = (direction) => {
  switch (direction) {
    case 'left':
      ball.moveLeft();
      break;
    case 'right':
      ball.moveRight();
      break;
    case 'up':
      ball.moveUp();
      break;
    case 'down':
      ball.moveDown();
      break;
  }
  ball.display();
};
yargs
  .command({
    command: 'left',
    describe: 'Move the ball to the left',
    handler: () => moveBall('left'),
  })
  .command({
    command: 'right',
    describe: 'Move the ball to the right',
    handler: () => moveBall('right'),
  })
  .command({
    command: 'up',
    describe: 'Move the ball up',
    handler: () => moveBall('up'),
  })
  .command({
    command: 'down',
    describe: 'Move the ball down',
    handler: () => moveBall('down'),
  })
  .demandCommand(1, 'You need to specify a direction to move the ball')
  .help()
  .alias('help', 'h')
  .argv;
ball.display();   

ball.js

 
class Ball {
    constructor() {
      this.x = 1;
      this.y = 1;
      this.gridSize = 3; 
      this.history = ['5'];
    }
    moveLeft() {
      if (this.x > 0) this.x -= 1;
      this.updateHistory();
    }
    moveRight() {
      if (this.x < this.gridSize - 1) this.x += 1;
      this.updateHistory();
    }
    moveUp() {
      if (this.y > 0) this.y -= 1;
      this.updateHistory();
    }
    moveDown() {
      if (this.y < this.gridSize - 1) this.y += 1;
      this.updateHistory();
    }
    updateHistory() {
      const position = this.y * this.gridSize + this.x + 1;
      this.history.push(position.toString());
    }
    display() {
      let grid = '';
      for (let i = 0; i < this.gridSize; i++) {
        for (let j = 0; j < this.gridSize; j++) {
          if (i === this.y && j === this.x) {
            grid += 'O ';
          } else {
            grid += '. ';
          }
        }
        grid += '\n';
      }
      console.clear();
      console.log(grid);
      console.log('Movement History:', this.history.join(' -> '));
    }
}
module.exports = Ball;   

输出

下一个主题ES6 和 Node.js 之间的区别

← 上一个下一个 →

Node.js 中的 Yargs

安装

示例 1

说明

示例 2

问题陈述

Index.js

ball.js

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Node.js 教程

Node.js MySQL

Node.js MongoDB

区别

其他

Node.js 选择题

Node.js Express

面试题

Node.js 中的 Yargs

安装

示例 1

说明

示例 2

问题陈述

Index.js

ball.js

相关帖子

Node.js 中的代码分割

Node.js console.groupCollapsed() 方法

Node.js Buffer.allocUnsafe() 方法

Node.js 中的 vm.measureMemory([options]) 函数

Node.js 和 Feathers.js 的区别

Node.js 中的 This

Node.js 中 WebSockets 和 Long Polling 的区别

Node.js 中 spawn() 和 fork() 方法的区别

Node.js 和 Nuxt.js 的区别

Node.js 中 npm i 和 npm ci 的区别

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器