什么是 hjs-getopt?
hjs-getopt 是一个 Node.js 中使用的命令行参数解析器,其 API 类似于 Python/Perl 的 Getopt::Long 模块。它是一个非常优秀的解析器,能够自动帮助开发者进行参数的解析,并且添加各种参数选项,让开发更加便利。
如何安装 hjs-getopt?
下载 hjs-getopt 命令行包,可在终端中使用以下指令:
$ npm install hjs-getopt --save
如何使用 hjs-getopt?
在 Node.js 脚本中,使用以下引用 hjs-getopt:
var Getopt = require('hjs-getopt');
创建声明
我们通过创建一个 Getopt
实例来声明我们需要的选项和参数,它接受一个对象作为选项和参数的列表。下面是一个示例:
var getopt = new Getopt([ ['v', 'verbose', 'be verbose'], ['h', 'help', 'this screen'] ]);
解析参数
使用 parse()
方法,可以将输入字符串解析为参数和命令行选项。下面是一个示例:
getopt.setHelp( "Usage: node yourscript.js [OPTION] [ARGUMENT]\n"+ "Manage your node application\n"+ "\n"+ "[[OPTIONS]]"+ "\n" ); var opt = getopt.parse(process.argv.slice(2));
获取参数
parse()
方法返回的是一个对象,可通过 getOption()
方法获取选项值,示例如下:
var verbose = getopt.getOption('verbose'); var help = getopt.getOption('help');
示例代码
下面是对 hjs-getopt 的一个简单使用示例:
-- -------------------- ---- ------- --- ------ - ---------------------- --- ------ - --- -------- ----- ---------- --- ---------- ----- ------- ----- -------- --- --------------- ------- ---- ------------- -------- -------------- ------- ---- ---- --------------- ----- -------------- ---- -- --- --- - ------------------------------------ --- ------- - ---------------------------- --- ---- - ------------------------- -- ------ - --------------------------------------- ---------------- - -- --------- - ----------------------------- ---- -- -------- -
这个示例中演示了 hjs-getopt 的基本使用方法,当输入 -h/--help
参数时,可以获取帮助信息。而 -v/--verbose
则会输出一段文字。开发者也可以自定义自己需要的参数和选项进行应用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005662a81e8991b448e2030