nodejs命令行参数处理模块commander使用实例

 更新时间:2014年09月17日 09:45:30   作者:乡村运维  
这篇文章主要介绍了nodejs命令行参数处理模块commander使用实例,commander是一个非常高大上的令行参数处理模块,需要的朋友可以参考下

诚然,之前处理都是使用内置的process.agrv ,这个能work,但是不好使,于是tj大神给写了一个,my god,完全的高大上:

1、安装

复制代码 代码如下:

npm install commander

2、option 解析

Options with commander are defined with the .option() method, also serving as documentation for the options. The example below parses args and options from process.argv, leaving remaining args as the program.args array which were not consumed by options.

复制代码 代码如下:

#!/usr/bin/env node
 
/**
 * Module dependencies.
 */
 
var program = require('commander');
 
program
  .version('0.0.1')
  .option('-p, --peppers', 'Add peppers')
  .option('-P, --pineapple', 'Add pineapple')
  .option('-b, --bbq', 'Add bbq sauce')
  .option('-c, --cheese [type]', 'Add the specified type of cheese [marble]', 'marble')
  .parse(process.argv);
 
console.log('you ordered a pizza with:');
if (program.peppers) console.log('  - peppers');
if (program.pineapple) console.log('  - pineapple');
if (program.bbq) console.log('  - bbq');
console.log('  - %s cheese', program.cheese);

Short flags may be passed as a single arg, for example -abc is equivalent to -a -b -c. Multi-word options such as “–template-engine” are camel-cased, becoming program.templateEngine etc.

3、自动生成help信息

复制代码 代码如下:

$ ./examples/pizza --help
 
  Usage: pizza [options]
 
  Options:
 
    -V, --version        output the version number
    -p, --peppers        Add peppers
    -P, --pineapple      Add pineapple
    -b, --bbq            Add bbq sauce
    -c, --cheese <type>  Add the specified type of cheese [marble]
    -h, --help           output usage information

当然你也可以手动生成:

复制代码 代码如下:

#!/usr/bin/env node
 
/**
 * Module dependencies.
 */
 
var program = require('../');
 
function list(val) {
  return val.split(',').map(Number);
}
 
program
  .version('0.0.1')
  .option('-f, --foo', 'enable some foo')
  .option('-b, --bar', 'enable some bar')
  .option('-B, --baz', 'enable some baz');
 
// must be before .parse() since
// node's emit() is immediate
 
program.on('--help', function(){
  console.log('  Examples:');
  console.log('');
  console.log('    $ custom-help --help');
  console.log('    $ custom-help -h');
  console.log('');
});
 
program.parse(process.argv);
 
console.log('stuff');

4、举个完整的例子

复制代码 代码如下:

function range(val) {
  return val.split('..').map(Number);
}
 
function list(val) {
  return val.split(',');
}
 
function collect(val, memo) {
  memo.push(val);
  return memo;
}
 
function increaseVerbosity(v, total) {
  return total + 1;
}
 
program
  .version('0.0.1')
  .usage('[options] <file ...>')
  .option('-i, --integer <n>', 'An integer argument', parseInt)
  .option('-f, --float <n>', 'A float argument', parseFloat)
  .option('-r, --range <a>..<b>', 'A range', range)
  .option('-l, --list <items>', 'A list', list)
  .option('-o, --optional [value]', 'An optional value')
  .option('-c, --collect [value]', 'A repeatable value', collect, [])
  .option('-v, --verbose', 'A value that can be increased', increaseVerbosity, 0)
  .parse(process.argv);
 
console.log(' int: %j', program.integer);
console.log(' float: %j', program.float);
console.log(' optional: %j', program.optional);
program.range = program.range || [];
console.log(' range: %j..%j', program.range[0], program.range[1]);
console.log(' list: %j', program.list);
console.log(' collect: %j', program.collect);
console.log(' verbosity: %j', program.verbose);
console.log(' args: %j', program.args);

相关文章

  • Node.js折腾记一:读指定文件夹,输出该文件夹的文件树详解

    Node.js折腾记一:读指定文件夹,输出该文件夹的文件树详解

    这篇文章主要介绍了Node.js读指定文件夹输出该文件夹文件树,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • 如何在Node.js中使用async函数的方法详解

    如何在Node.js中使用async函数的方法详解

    这篇文章主要为大家介绍了如何在Node.js中使用async函数的方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • koa2的中间件功能及应用示例

    koa2的中间件功能及应用示例

    这篇文章主要介绍了koa2的中间件功能及应用示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • nodejs+mongodb+vue前后台配置ueditor的示例代码

    nodejs+mongodb+vue前后台配置ueditor的示例代码

    本篇文章主要介绍了nodejs+mongodb+vue前后台配置ueditor的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • 使用koa-log4管理nodeJs日志笔记的使用方法

    使用koa-log4管理nodeJs日志笔记的使用方法

    这篇文章主要介绍了使用koa-log4管理nodeJs日志笔记的使用方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • node.js中的fs.lchown方法使用说明

    node.js中的fs.lchown方法使用说明

    这篇文章主要介绍了node.js中的fs.lchown方法使用说明,本文介绍了fs.lchown的方法说明、语法、接收参数、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12
  • Node.js内置模块events事件监听发射详解

    Node.js内置模块events事件监听发射详解

    这篇文章主要为大家介绍了Node.js内置模块events事件监听发射详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • 基于Node.js构建一个灵活的CLI命令行工具

    基于Node.js构建一个灵活的CLI命令行工具

    在软件开发中,命令行界面(CLI)工具是必不可少的助手,本文主要介绍了如何使用Node.js构建一个灵活的CLI工具,涵盖从基础命令处理到复杂的交互式问答和远程模板下载,需要的可以参考下
    2024-03-03
  • Node.js API详解之 timer模块用法实例分析

    Node.js API详解之 timer模块用法实例分析

    这篇文章主要介绍了Node.js API详解之 timer模块用法,结合实例形式分析了Node.js API中timer模块基本功能、原理、用法及操作注意事项,需要的朋友可以参考下
    2020-05-05
  • 用nodejs实现json和jsonp服务的方法

    用nodejs实现json和jsonp服务的方法

    本篇文章主要介绍了用nodejs实现json和jsonp服务的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08

最新评论