node.js中使用yargs来处理命令行参数

时间: 2019-01-14阅读: 1589标签: 命令

yargs库能够方便的处理命令行参数。

 

一、安装 yargs

npm install yargs --save

  

二、读取命令行参数

const yargs = require(‘yargs‘);

let argv = yargs.argv;
console.log(argv);

argv 对象用来保存命令行参数,传递参数时,参数名以 -- 开头,中间使用 = 或 空格,然后接上值 。

argv 有一个 下划线 属性,该属性用来获取非连词线开头的参数

const yargs = require(‘yargs‘);

let argv = yargs.argv;
console.log(argv._);

还可以给参数名取一个别名。

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);

  

站长推荐

1.云服务推荐: 国内主流云服务商,各类云产品的最新活动,优惠券领取。地址:阿里云腾讯云华为云

链接: http://www.fly63.com/article/detial/1822

这7个npm命令将帮助您节省时间

作为JavaScript开发人员,NPM是我们一直使用的东西,并且我们的脚本在终端上连续运行。如果我们可以节省一些时间呢?

常用的搜索命令_高级搜索指令大全

作为一名资深SEO,不懂得搜索引擎高级指令的使用显然是说不过去的。搜索引擎高级指令就如同语言一样,用来建立搜索引擎与SEO人员直接沟通的“通道”,下面就为大家整理下常用的高级搜索命令

FFmpeg常用命令合集

视频裁剪滤镜(播放器大小裁剪): ffmpeg -i killer.mp4 -vf crop=in_w-200:in_h-200 -c:v libx264 -c:a copy out.mp4;视频裁剪(按时间裁剪): ffmpeg -i shanguangshaonv.mp4 -ss

Flutter 常用命令

查看flutter是否安装到位 环境是否正常;查看版本号;升级环境flutter upgrade;获取flutter packages包 (现在基本上已经是保存就自动导入的了 );以release 模式运行

Linux常用命令总汇

ls命令就是list的缩写,通过ls 命令不仅可以查看linux文件夹包含的文件,而且可以查看文件权限(包括目录、文件夹、文件权限)查看目录信息等等

7大Git实用技巧和命令总结

Git 是一个非常强大的工具,它包含丰富的工具用以维护项目。本文介绍了一些 Git 日常使用过程中的实用技巧和命令,希望这些内容能够对大家有所帮助

高频使用的Git命令

汇总下我在项目中高频使用的Git命令及姿势。不是入门文档,官方文档肯定比我全面,这里是结合实际业务场景输出。git status查看工作区状态的东东,不如GUI直观,但是命令行也有一些用的

每个Web开发者都该了解的12条命令行

在开发者的弹药箱里,命令行是最具生产力的工具之一。掌握它们可以给你的工作流程带来非常积极的影响。因为,许多日常任务都可以用一条命令然后按回车来解决。

Vim 常用操作命令整理

vim xxx,vim +num xxx 命令行打开文件,vim + filename 启动跳到文件结尾,vim +143 filename 打开跳到143行 调试代码有用,vim +/search-term filename 跳到第一个匹配

非常实用的9大网络命令

ping 是个使用频率极高的实用程序,主要用于确定网络的连通性。这对确定网络是否正确连接,以及网络连接的状况十分有用。简单的说,ping 就是一个测试程序,如果 ping 运行正确,大体上就可以排除网络访问层、网卡、Modem 的输入输出线路

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!