first commit
This commit is contained in:
		
							
								
								
									
										4
									
								
								node_modules/commander/.npmignore
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								node_modules/commander/.npmignore
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,4 @@ | ||||
| support | ||||
| test | ||||
| examples | ||||
| *.sock | ||||
							
								
								
									
										4
									
								
								node_modules/commander/.travis.yml
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								node_modules/commander/.travis.yml
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,4 @@ | ||||
| language: node_js | ||||
| node_js: | ||||
|   - 0.4 | ||||
|   - 0.6 | ||||
							
								
								
									
										107
									
								
								node_modules/commander/History.md
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										107
									
								
								node_modules/commander/History.md
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,107 @@ | ||||
|  | ||||
| 0.6.1 / 2012-06-01  | ||||
| ================== | ||||
|  | ||||
|   * Added: append (yes or no) on confirmation | ||||
|   * Added: allow node.js v0.7.x | ||||
|  | ||||
| 0.6.0 / 2012-04-10  | ||||
| ================== | ||||
|  | ||||
|   * Added `.prompt(obj, callback)` support. Closes #49 | ||||
|   * Added default support to .choose(). Closes #41 | ||||
|   * Fixed the choice example | ||||
|  | ||||
| 0.5.1 / 2011-12-20  | ||||
| ================== | ||||
|  | ||||
|   * Fixed `password()` for recent nodes. Closes #36 | ||||
|  | ||||
| 0.5.0 / 2011-12-04  | ||||
| ================== | ||||
|  | ||||
|   * Added sub-command option support [itay] | ||||
|  | ||||
| 0.4.3 / 2011-12-04  | ||||
| ================== | ||||
|  | ||||
|   * Fixed custom help ordering. Closes #32 | ||||
|  | ||||
| 0.4.2 / 2011-11-24  | ||||
| ================== | ||||
|  | ||||
|   * Added travis support | ||||
|   * Fixed: line-buffered input automatically trimmed. Closes #31 | ||||
|  | ||||
| 0.4.1 / 2011-11-18  | ||||
| ================== | ||||
|  | ||||
|   * Removed listening for "close" on --help | ||||
|  | ||||
| 0.4.0 / 2011-11-15  | ||||
| ================== | ||||
|  | ||||
|   * Added support for `--`. Closes #24 | ||||
|  | ||||
| 0.3.3 / 2011-11-14  | ||||
| ================== | ||||
|  | ||||
|   * Fixed: wait for close event when writing help info [Jerry Hamlet] | ||||
|  | ||||
| 0.3.2 / 2011-11-01  | ||||
| ================== | ||||
|  | ||||
|   * Fixed long flag definitions with values [felixge] | ||||
|  | ||||
| 0.3.1 / 2011-10-31  | ||||
| ================== | ||||
|  | ||||
|   * Changed `--version` short flag to `-V` from `-v` | ||||
|   * Changed `.version()` so it's configurable [felixge] | ||||
|  | ||||
| 0.3.0 / 2011-10-31  | ||||
| ================== | ||||
|  | ||||
|   * Added support for long flags only. Closes #18 | ||||
|  | ||||
| 0.2.1 / 2011-10-24  | ||||
| ================== | ||||
|  | ||||
|   * "node": ">= 0.4.x < 0.7.0". Closes #20 | ||||
|  | ||||
| 0.2.0 / 2011-09-26  | ||||
| ================== | ||||
|  | ||||
|   * Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs] | ||||
|  | ||||
| 0.1.0 / 2011-08-24  | ||||
| ================== | ||||
|  | ||||
|   * Added support for custom `--help` output | ||||
|  | ||||
| 0.0.5 / 2011-08-18  | ||||
| ================== | ||||
|  | ||||
|   * Changed: when the user enters nothing prompt for password again | ||||
|   * Fixed issue with passwords beginning with numbers [NuckChorris] | ||||
|  | ||||
| 0.0.4 / 2011-08-15  | ||||
| ================== | ||||
|  | ||||
|   * Fixed `Commander#args` | ||||
|  | ||||
| 0.0.3 / 2011-08-15  | ||||
| ================== | ||||
|  | ||||
|   * Added default option value support | ||||
|  | ||||
| 0.0.2 / 2011-08-15  | ||||
| ================== | ||||
|  | ||||
|   * Added mask support to `Command#password(str[, mask], fn)` | ||||
|   * Added `Command#password(str, fn)` | ||||
|  | ||||
| 0.0.1 / 2010-01-03 | ||||
| ================== | ||||
|  | ||||
|   * Initial release | ||||
							
								
								
									
										7
									
								
								node_modules/commander/Makefile
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								node_modules/commander/Makefile
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,7 @@ | ||||
|  | ||||
| TESTS = $(shell find test/test.*.js) | ||||
|  | ||||
| test: | ||||
| 	@./test/run $(TESTS) | ||||
|  | ||||
| .PHONY: test | ||||
							
								
								
									
										262
									
								
								node_modules/commander/Readme.md
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										262
									
								
								node_modules/commander/Readme.md
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,262 @@ | ||||
| # Commander.js | ||||
|  | ||||
|   The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/visionmedia/commander). | ||||
|  | ||||
|  [](http://travis-ci.org/visionmedia/commander.js) | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
|     $ npm install commander | ||||
|  | ||||
| ## Option parsing | ||||
|  | ||||
|  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. | ||||
|  | ||||
| ```js | ||||
| #!/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('  - pineappe'); | ||||
| 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. | ||||
|  | ||||
| ## Automated --help | ||||
|  | ||||
|  The help information is auto-generated based on the information commander already knows about your program, so the following `--help` info is for free: | ||||
|  | ||||
| ```   | ||||
|  $ ./examples/pizza --help | ||||
|  | ||||
|    Usage: pizza [options] | ||||
|  | ||||
|    Options: | ||||
|  | ||||
|      -V, --version        output the version number | ||||
|      -p, --peppers        Add peppers | ||||
|      -P, --pineapple      Add pineappe | ||||
|      -b, --bbq            Add bbq sauce | ||||
|      -c, --cheese <type>  Add the specified type of cheese [marble] | ||||
|      -h, --help           output usage information | ||||
|  | ||||
| ``` | ||||
|  | ||||
| ## Coercion | ||||
|  | ||||
| ```js | ||||
| function range(val) { | ||||
|   return val.split('..').map(Number); | ||||
| } | ||||
|  | ||||
| function list(val) { | ||||
|   return val.split(','); | ||||
| } | ||||
|  | ||||
| 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') | ||||
|   .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(' args: %j', program.args); | ||||
| ``` | ||||
|  | ||||
| ## Custom help | ||||
|  | ||||
|  You can display arbitrary `-h, --help` information | ||||
|  by listening for "--help". Commander will automatically | ||||
|  exit once you are done so that the remainder of your program | ||||
|  does not execute causing undesired behaviours, for example | ||||
|  in the following executable "stuff" will not output when | ||||
|  `--help` is used. | ||||
|  | ||||
| ```js | ||||
| #!/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'); | ||||
| ``` | ||||
|  | ||||
| yielding the following help output: | ||||
|  | ||||
| ``` | ||||
|  | ||||
| Usage: custom-help [options] | ||||
|  | ||||
| Options: | ||||
|  | ||||
|   -h, --help     output usage information | ||||
|   -V, --version  output the version number | ||||
|   -f, --foo      enable some foo | ||||
|   -b, --bar      enable some bar | ||||
|   -B, --baz      enable some baz | ||||
|  | ||||
| Examples: | ||||
|  | ||||
|   $ custom-help --help | ||||
|   $ custom-help -h | ||||
|  | ||||
| ``` | ||||
|  | ||||
| ## .prompt(msg, fn) | ||||
|  | ||||
|  Single-line prompt: | ||||
|  | ||||
| ```js | ||||
| program.prompt('name: ', function(name){ | ||||
|   console.log('hi %s', name); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
|  Multi-line prompt: | ||||
|  | ||||
| ```js | ||||
| program.prompt('description:', function(name){ | ||||
|   console.log('hi %s', name); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
|  Coercion: | ||||
|  | ||||
| ```js | ||||
| program.prompt('Age: ', Number, function(age){ | ||||
|   console.log('age: %j', age); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ```js | ||||
| program.prompt('Birthdate: ', Date, function(date){ | ||||
|   console.log('date: %s', date); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ## .password(msg[, mask], fn) | ||||
|  | ||||
| Prompt for password without echoing: | ||||
|  | ||||
| ```js | ||||
| program.password('Password: ', function(pass){ | ||||
|   console.log('got "%s"', pass); | ||||
|   process.stdin.destroy(); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| Prompt for password with mask char "*": | ||||
|  | ||||
| ```js | ||||
| program.password('Password: ', '*', function(pass){ | ||||
|   console.log('got "%s"', pass); | ||||
|   process.stdin.destroy(); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ## .confirm(msg, fn) | ||||
|  | ||||
|  Confirm with the given `msg`: | ||||
|  | ||||
| ```js | ||||
| program.confirm('continue? ', function(ok){ | ||||
|   console.log(' got %j', ok); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ## .choose(list, fn) | ||||
|  | ||||
|  Let the user choose from a `list`: | ||||
|  | ||||
| ```js | ||||
| var list = ['tobi', 'loki', 'jane', 'manny', 'luna']; | ||||
|  | ||||
| console.log('Choose the coolest pet:'); | ||||
| program.choose(list, function(i){ | ||||
|   console.log('you chose %d "%s"', i, list[i]); | ||||
| }); | ||||
| ``` | ||||
|  | ||||
| ## Links | ||||
|  | ||||
|  - [API documentation](http://visionmedia.github.com/commander.js/) | ||||
|  - [ascii tables](https://github.com/LearnBoost/cli-table) | ||||
|  - [progress bars](https://github.com/visionmedia/node-progress) | ||||
|  - [more progress bars](https://github.com/substack/node-multimeter) | ||||
|  - [examples](https://github.com/visionmedia/commander.js/tree/master/examples) | ||||
|  | ||||
| ## License  | ||||
|  | ||||
| (The MIT License) | ||||
|  | ||||
| Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca> | ||||
|  | ||||
| Permission is hereby granted, free of charge, to any person obtaining | ||||
| a copy of this software and associated documentation files (the | ||||
| 'Software'), to deal in the Software without restriction, including | ||||
| without limitation the rights to use, copy, modify, merge, publish, | ||||
| distribute, sublicense, and/or sell copies of the Software, and to | ||||
| permit persons to whom the Software is furnished to do so, subject to | ||||
| the following conditions: | ||||
|  | ||||
| The above copyright notice and this permission notice shall be | ||||
| included in all copies or substantial portions of the Software. | ||||
|  | ||||
| THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, | ||||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||||
| IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | ||||
| CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | ||||
| TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||||
| SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||||
							
								
								
									
										2
									
								
								node_modules/commander/index.js
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								node_modules/commander/index.js
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,2 @@ | ||||
|  | ||||
| module.exports = require('./lib/commander'); | ||||
							
								
								
									
										1026
									
								
								node_modules/commander/lib/commander.js
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1026
									
								
								node_modules/commander/lib/commander.js
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										13
									
								
								node_modules/commander/package.json
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								node_modules/commander/package.json
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,13 @@ | ||||
| { | ||||
|     "name": "commander" | ||||
|   , "version": "0.6.1" | ||||
|   , "description": "the complete solution for node.js command-line programs" | ||||
|   , "keywords": ["command", "option", "parser", "prompt", "stdin"] | ||||
|   , "author": "TJ Holowaychuk <tj@vision-media.ca>" | ||||
|   , "repository": { "type": "git", "url": "https://github.com/visionmedia/commander.js.git" }   | ||||
|   , "dependencies": {} | ||||
|   , "devDependencies": { "should": ">= 0.0.1" } | ||||
|   , "scripts": { "test": "make test" } | ||||
|   , "main": "index" | ||||
|   , "engines": { "node": ">= 0.4.x" } | ||||
| } | ||||
		Reference in New Issue
	
	Block a user