项目作者: ldarren

项目描述 :
pico command line arguments parser
高级语言: JavaScript
项目地址: git://github.com/ldarren/pico-args.git
创建时间: 2016-07-26T15:01:08Z
项目社区:https://github.com/ldarren/pico-args

开源协议:MIT License

下载


pico Arguments Library

Yet another barebone command line arguments library

Usage

defined default arguments

  1. var defaults={
  2. name: ['{DEFAULT_NAME}','{DESCRIPTION}'],
  3. n:'@name'
  4. }

this is the default for

  1. CMD --name xyz

or

  1. CMD -n xyz

data type

supported 4 datatypes: string, boolean, number and object/array
to set string type

  1. var defaults={
  2. str: ['default','default str is "default"'],
  3. s:'@str'
  4. }

to set boolean type

  1. var defaults={
  2. bool: [false,'default bool is false'],
  3. b:'@bool'
  4. }

set it to true

  1. CMD -b # or CMD --bool

set it to false

  1. CMD -B # or CMD --BOOL

to set number type

  1. var defaults={
  2. float: [0,'default float is 0'],
  3. f:'@float'
  4. }

to set object type

  1. var defaults={
  2. obj: [{foo:"bar"},'default obj is {foo:"bar"}'],
  3. o:'@obj'
  4. }

or

  1. var defaults={
  2. obj: [['foo','bar'],'default obj is ["foo","bar"]'],
  3. o:'@obj'
  4. }
  1. CMD -o '{"hello":"world"}' #or CMD --obj '{"hello":"world"}'

parse arguments

  1. var
  2. args=require('pico-args'),
  3. options=args.parse(defaults)
  4. console.log(options.name)
  5. console.log(options.n)

print arguments

this function requires pico-common module

  1. args.print('{TITLE}',options)

print usage

this function requires pico-common module

  1. args.usage(defaults)

argument combo

single character arguments can be string in one word

  1. var defaults={
  2. a:[true,'flag a'],
  3. b:[false,'flag b'],
  4. c:[true,'flag c'],
  5. d:['/opt/','path']
  6. }
  1. CMD -Abcd '~/src'