📜  Node.js Yargs 模块

📅  最后修改于: 2022-05-13 01:56:18.598000             🧑  作者: Mango

Node.js Yargs 模块

Yargs 模块用于在 node.js 中创建您自己的命令行命令,并有助于生成优雅的用户界面。该模块使命令行参数灵活且易于使用。

yargs模块的安装:

  1. 您可以访问链接安装 yargs 模块。您可以使用此命令安装此软件包。
    npm install yargs
  2. 安装 yargs 后,您可以使用命令在命令提示符中检查您的 yargs 版本。
    npm version yargs
  3. 之后,您可以创建一个文件夹并添加一个文件,例如 index.js,要运行此文件,您需要运行以下命令。
    node index.js

文件名:index.js

const yargs = require('yargs')
   
// Customize yargs version
yargs.version('1.1.0')
   
// Create add command
yargs.command({
    command: 'add',
    describe: 'Adds two number',
    builder: {
        firstNumber: {
            describe: 'First Number',
            demandOption: true,  // Required
            type: 'number'     
        },
        secondNumber: {  
            describe: 'Second Number',
            demandOption: true,
            type: 'number'
        }
    },
  
    // Function for your command
    handler(argv) {
        console.log("Result:", 
            (argv.firstNumber+argv.secondNumber))
    }
})
   
yargs.parse() // To set above changes

运行程序的步骤:

  1. 项目结构将如下所示:
    项目结构
  2. 确保您已使用以下命令安装 express 和 yargs 模块:
    npm install express
    npm install yargs
  3. 使用以下命令运行 index.js 文件:
    node index.js

    运行上述命令后,现在设置了 yargs 命令,您可以使用它,如下所示:

    node index.js add --firstNumber=4 --secondNumber=10

    上述命令的输出

所以这就是你如何使用 yargs 模块来制作你自己的命令行参数命令,从而使其更具交互性。