如何在node.js中使用yargs處理命令行參數(shù)

今天就跟大家聊聊有關(guān)如何在node.js中使用yargs處理命令行參數(shù)，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

yargs庫(kù)能夠方便的處理命令行參數(shù)。

一、安裝 yargs

npm install yargs --save

二、讀取命令行參數(shù)

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

argv 對(duì)象用來(lái)保存命令行參數(shù)，傳遞參數(shù)時(shí)，參數(shù)名以 -- 開頭，中間使用 = 或 空格，然后接上值 。

argv 有一個(gè) 下劃線 屬性，該屬性用來(lái)獲取非連詞線開頭的參數(shù)

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

還可以給參數(shù)名取一個(gè)別名。

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]) 設(shè)置默認(rèn)值

.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', '目標(biāo)文件')
  .argv;
console.log(argv);

我們可以通過(guò) .option(key, [opt]) 配置所有設(shè)置

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: '目標(biāo)文件',
    type: 'string'
  })
  .argv;
console.log(argv);

有些時(shí)候我們只想知道某些參數(shù)有沒有設(shè)置，是 true 或是 false。

通過(guò) .boolean(key) 解析參數(shù)為布爾值。

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', '設(shè)置源文件')
  .epilog('copyright')
  .help('info')
  .argv;
console.log(argv);

看完上述內(nèi)容，你們對(duì)如何在node.js中使用yargs處理命令行參數(shù)有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。