├── .gitignore
├── test
    ├── config
    │   └── test-config.json
    ├── test.demand.js
    ├── test.description.js
    ├── test.oneof.js
    ├── test.comboof.js
    ├── test.load.js
    └── test.command.demand.js
├── .jshintrc
├── package.json
├── example
    └── example.js
├── LICENSE
├── README.md
└── lib
    └── start.js


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | 
3 | 


--------------------------------------------------------------------------------
/test/config/test-config.json:
--------------------------------------------------------------------------------
1 | {
2 |   "foo": "bar",
3 |   "baz": "buz"
4 | }
5 | 


--------------------------------------------------------------------------------
/.jshintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "passfail": false,
 3 |   "maxerr": 100,
 4 |   "node": true,
 5 |   "forin": false,
 6 |   "boss": true,
 7 |   "noarg": true,
 8 |   "undef": true,
 9 |   "unused": true,
10 |   "browser": true,
11 |   "laxbreak": true,
12 |   "laxcomma": true,
13 |   "eqeqeq": true,
14 |   "eqnull": true,
15 |   "expr": true,
16 |   "indent": 2,
17 |   "white": false,
18 |   "predef": [
19 |     "exports", 
20 |     "require",
21 |     "process"
22 |   ],
23 |   "es5": true,
24 |   "esnext": true,
25 |   "shadow": false,
26 |   "supernew": false,
27 |   "strict": false
28 | }
29 | 


--------------------------------------------------------------------------------
/test/test.demand.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       should  = require('should');
 7 | 
 8 | program
 9 |     .version('0.0.1')
10 |     .option('-f, --foo <foo_type>', 'add some <foo_type>')
11 |     .demand('foo');
12 | 
13 | var helpInfo = program.helpInformation();
14 | helpInfo.should.include("[required] add some <foo_type>");
15 | 
16 | 


--------------------------------------------------------------------------------
/test/test.description.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       path    = require('path'),
 7 |       should  = require('should');
 8 | 
 9 | program
10 |     .version('0.0.1')
11 |     .description('a little useful text to explain the purpose of the tool')
12 |     .parse(['node', 'test', '--help']);
13 | 
14 | var helpInfo = program.helpInformation();
15 | helpInfo.should.include("a little useful text");
16 | 
17 | 


--------------------------------------------------------------------------------
/test/test.oneof.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       path    = require('path'),
 7 |       should  = require('should');
 8 | 
 9 | program
10 |     .version('0.0.1')
11 |     .option('--onlyone <option>', 'User must choose one from list')
12 |     .oneof('onlyone', ['option_a', 'option_b', 'option_c']);
13 | 
14 | var helpInfo = program.helpInformation();
15 | helpInfo.should.include("option_a");
16 | helpInfo.should.include("option_b");
17 | helpInfo.should.include("option_c");
18 | 


--------------------------------------------------------------------------------
/test/test.comboof.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       path    = require('path'),
 7 |       should  = require('should');
 8 | 
 9 | program
10 |     .version('0.0.1')
11 |     .option('--comboof <option>', 'User can create combinations of options')
12 |     .comboof('comboof', ['option_a', 'option_b', 'option_c']);
13 | 
14 | var helpInfo = program.helpInformation();
15 | helpInfo.should.include("option_a");
16 | helpInfo.should.include("option_b");
17 | helpInfo.should.include("option_c");
18 | 
19 | program.parse(['node', 'test', '--comboof', 'option_a+option_b']);
20 | 


--------------------------------------------------------------------------------
/test/test.load.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       path    = require('path'),
 7 |       should  = require('should');
 8 | 
 9 | program
10 |     .version('0.0.1')
11 |     .option('-b, --foo <foo_type>', 'add some <foo_type>')
12 |     .loadable('--foo')
13 |     .option('-z, --baz <baz_type>', 'add some <baz_type>')
14 |     .load(path.join(__dirname, "config", "test-config.json"))
15 |     .parse(['node', 'test']);
16 | 
17 | program.foo.should.be.equal("bar");
18 | 
19 | // option is defined in config but not marked as loadable. Will not be loaded.
20 | should.strictEqual(undefined, program.baz);
21 | 
22 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "Author": "Shane Tomlinson <shane@shanetomlinson.com> (https://shanetomlinson.com)",
 3 |   "name": "commodore",
 4 |   "description": "A complete command line library - extends commander with required options and load config from a file",
 5 |   "keywords": ["command", "option", "commander", "config"],
 6 |   "homepage": "https://github.com/shane-tomlinson/commodore",
 7 |   "repository": {
 8 |     "type": "git",
 9 |     "url": "https://github.com/shane-tomlinson/commodore.git"
10 |   },
11 |   "bugs": {
12 |     "url": "https://github.com/shane-tomlinson/commodore/issues"
13 |   },
14 |   "version": "0.0.1",
15 |   "engines": {
16 |     "node": ">= 0.6.x"
17 |   },
18 |   "main": "lib/start",
19 |   "dependencies": {
20 |     "commander": "1.1.1"
21 |   },
22 |   "devDependencies": { 
23 |     "should": ">= 0.0.1"
24 |   }
25 | }
26 | 


--------------------------------------------------------------------------------
/example/example.js:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env node
 2 | 
 3 | /* This Source Code Form is subject to the terms of the Mozilla Public
 4 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 5 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 6 | 
 7 | const program = require('../lib/start'),
 8 |       path    = require('path'),
 9 |       fs      = require('fs');
10 | 
11 | const CONFIG_PATH = path.join(getUserHome(), ".test", "config.json");
12 | 
13 | function getUserHome() {
14 |   return process.env[(process.platform === 'win32') ? 'USERPROFILE' : 'HOME'];
15 | }
16 | 
17 | 
18 | program
19 |     .version('0.0.1')
20 |     .option('-t, --type <type>', 'add support for <type>')
21 |     .demand('type')
22 |     .option('-p, --pie <pie>', 'specify a <pie>')
23 |     .demand('pie')
24 |     .option('-a, --an', 'an option')
25 |     .demand('a')
26 |     .load(CONFIG_PATH)
27 |     .parse(process.argv);
28 | 
29 | 
30 | console.log(program.pie, "pie with", program.type);
31 | 


--------------------------------------------------------------------------------
/test/test.command.demand.js:
--------------------------------------------------------------------------------
 1 | /* This Source Code Form is subject to the terms of the Mozilla Public
 2 |  * License, v. 2.0. If a copy of the MPL was not distributed with this
 3 |  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 4 | 
 5 | const program = require('../lib/start'),
 6 |       should  = require('should');
 7 | 
 8 | program
 9 |     .version('0.0.1')
10 |     .option('-f, --foo <foo_type>', 'add some <foo_type>')
11 |     .demand('foo');
12 | 
13 | program
14 |     .command('setup [env]')
15 |     .description('run setup commands for all envs')
16 |     .option("-s, --setup_mode <mode>", "Which setup mode to use")
17 |     .demand("setup_mode")
18 |     .action(function(env, options){
19 |       var mode = options.setup_mode || "normal";
20 |       env = env || 'all';
21 |       console.log('setup for %s env(s) with %s mode', env, mode);
22 |     });
23 | 
24 | var helpInfo = program.helpInformation();
25 | console.log(helpInfo);
26 | /*helpInfo.should.include("[required] Which setup mode to use");*/
27 | 
28 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | (The MIT License)
 2 | 
 3 | Copyright (c) 2013 Shane Tomlinson &lt;shane@shanetomlinson.com&gt;
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining
 6 | a copy of this software and associated documentation files (the
 7 | 'Software'), to deal in the Software without restriction, including
 8 | without limitation the rights to use, copy, modify, merge, publish,
 9 | distribute, sublicense, and/or sell copies of the Software, and to
10 | permit persons to whom the Software is furnished to do so, subject to
11 | the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be
14 | included in all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 | 
24 | 
25 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # commodore
 2 | 
 3 |   A complete solution for [node.js](http://nodejs.org) command-line interfaces. Commodore is an extension of [commander](https://github.com/visionmedia/commander.js) from TJ Holowaychuk, which is in turn inspired by Ruby's commander.
 4 | 
 5 | ## Installation
 6 | 
 7 |     $ npm install commander
 8 | 
 9 | ## Option parsing
10 | 
11 |   Since commodore is an extension of commander, all [commander options](https://github.com/visionmedia/commander.js/blob/master/Readme.md) are supported.
12 | 
13 | ## .demand(optionName)
14 |   Demand an option `optionName`
15 | 
16 | ```js
17 | program
18 |   .option('-f, --foo <foo_type>', 'type of foo')
19 |   .demand('foo')
20 | ```
21 | 
22 | ## .loadable(optionName)
23 |   Attempt to load `optionName` from the JSON config file declared in `.load`
24 | 
25 | ```js
26 | program
27 |   .option('-f, --foo <foo_type>', 'type of foo')
28 |   .loadable('foo')
29 | ```
30 | 
31 | ## .oneof(optionName, choices)
32 |   Demand that the value of `optionName` be one of `choices`
33 | 
34 | ```js
35 | program
36 |   .option('-f, --foo <foo_type>', 'type of foo')
37 |   .oneof('foo', ['bar', 'baz', 'buz'])
38 | ```
39 | 
40 | ## .comboof(optionName, choices)
41 |   Demand that the value of `optionName` be one or more combinations of `choices`
42 | 
43 | ```js
44 | program
45 |   .option('-f, --foo <foo_type>', 'type of foo')
46 |   .comboof('foo', ['bar', 'baz', 'buz'])
47 | ```
48 | 
49 | Combinations are joined with `+`, distinct options are joined with a `,`
50 | Possible matches:
51 | * `bar`
52 | * `buz`
53 | * `bar+baz`
54 | * `bar+baz+buz`
55 | * `bar+baz,buz`
56 | 
57 | ## .load(configPath)
58 |   Load `loadable` options from a configuration file.
59 | 
60 | ```js
61 | program
62 |   .option('-f, --foo <foo_type>', 'type of foo')
63 |   .loadable('foo')
64 |   .load('~/.commodore/config.json')
65 | ```
66 | 
67 | ## Why the fork/extension?
68 | 
69 | I love commander, I also love [optimist](https://github.com/substack/node-optimist).
70 | Both are missing features. TJ does not want to add complexity to the commander library,
71 | so I created a library on top of his to fulfill my own needs.
72 | 
73 | ## License
74 | (The MIT License)
75 | 
76 | Copyright (c) 2013 Shane Tomlinson &lt;shane@shanetomlinson.com&gt;
77 | 
78 | Permission is hereby granted, free of charge, to any person obtaining
79 | a copy of this software and associated documentation files (the
80 | 'Software'), to deal in the Software without restriction, including
81 | without limitation the rights to use, copy, modify, merge, publish,
82 | distribute, sublicense, and/or sell copies of the Software, and to
83 | permit persons to whom the Software is furnished to do so, subject to
84 | the following conditions:
85 | 
86 | The above copyright notice and this permission notice shall be
87 | included in all copies or substantial portions of the Software.
88 | 
89 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
90 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
91 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
92 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
93 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
94 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
95 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
96 | 
97 | 


--------------------------------------------------------------------------------
/lib/start.js:
--------------------------------------------------------------------------------
  1 | /*!
  2 |  * commodore
  3 |  * Copyright(c) 2013 Shane Tomlinson <shane@shanetomlinson.com>
  4 |  * MIT Licensed
  5 |  */
  6 | 
  7 | const commander = require('commander'),
  8 |       Command   = commander.Command,
  9 |       fs        = require('fs');
 10 | 
 11 | const MAX_LINE_WIDTH = 100;
 12 | 
 13 | function Commodore(name) {
 14 |   Command.call(this, name);
 15 | }
 16 | 
 17 | /**
 18 |  * Inherit from `Command.prototype`
 19 |  */
 20 | 
 21 | Commodore.prototype.__proto__ = Command.prototype;
 22 | 
 23 | module.exports = new Commodore();
 24 | 
 25 | /**
 26 |  * Attempt to load `optionName` from the JSON config file declared in `.load`
 27 |  *
 28 |  * @param {String} optionName
 29 |  * @api public
 30 |  */
 31 | 
 32 | Commodore.prototype.loadable = function(optionName) {
 33 |   var option = this.optionFor(optionName);
 34 |   if (!option) {
 35 |     this.invalidLoadableOption(optionName);
 36 |   }
 37 | 
 38 |   option.loadable = true;
 39 |   option.description = option.description + " (loadable)";
 40 | 
 41 |   return this;
 42 | };
 43 | 
 44 | /**
 45 |  * Load options from a configuration file.
 46 |  *
 47 |  * @param {String} configPath
 48 |  * @api public
 49 |  */
 50 | 
 51 | Commodore.prototype.load = function(configPath) {
 52 |   var data;
 53 |   try {
 54 |     data = fs.readFileSync(configPath, 'utf8');
 55 |   } catch(e) {
 56 |     if (e.code === "ENOENT") {
 57 |       // config file does not exist.
 58 |       data = "{}";
 59 |     } else {
 60 |       throw e;
 61 |     }
 62 |   }
 63 | 
 64 |   try {
 65 |     this.loadedData = JSON.parse(data);
 66 |     this.configPath = configPath;
 67 |   } catch(e) {
 68 |     this.invalidJSON(configPath, String(e));
 69 |   }
 70 | 
 71 |   return this;
 72 | };
 73 | 
 74 | /**
 75 |  * Demand an option `optionName`.
 76 |  *
 77 |  * @param {String} optionName
 78 |  * @api public
 79 |  */
 80 | 
 81 | Commodore.prototype.demand = function(optionName) {
 82 |   var option = this.optionFor(optionName);
 83 |   if (!option) {
 84 |     this.invalidDemandedOption(optionName);
 85 |   }
 86 | 
 87 |   option.description = '[required] ' + option.description;
 88 |   option.demand = true;
 89 | 
 90 |   return this;
 91 | };
 92 | 
 93 | /**
 94 |  * Demand that the value of `optionName` be one of `choices`.
 95 |  *
 96 |  * @param {String} optionName
 97 |  * @param {Array} choices
 98 |  * @api public
 99 |  */
100 | 
101 | Commodore.prototype.oneof = function(optionName, choices) {
102 |   var option = this.optionFor(optionName);
103 |   if (!option) {
104 |     this.invalidOneOfOption(optionName);
105 |   }
106 | 
107 |   option.description = option.description + " choices: [" + choices.join(", ") + "]";
108 | 
109 |   var self=this;
110 |   this.on(optionName, function(val) {
111 |     if (choices.indexOf(val) === -1) {
112 |       self.invalidOneOfChoice(optionName, val, choices);
113 |     }
114 |   });
115 |   return this;
116 | };
117 | 
118 | /**
119 |  * Demand that the value of `optionName` be one of `choices`.
120 |  *
121 |  * @param {String} optionName
122 |  * @param {Array} choices
123 |  * @api public
124 |  */
125 | 
126 | Commodore.prototype.comboof = function(optionName, choices) {
127 |   var option = this.optionFor(optionName);
128 |   if (!option) {
129 |     this.invalidComboOfOption(optionName);
130 |   }
131 | 
132 |   option.description = option.description +
133 |                           " To create combinations, join options with +. " +
134 |                           "e.g.: " + choices[0] + "+" +
135 |                           choices[choices.length - 1] + ". " +
136 |                           "choices: [" + choices.join(", ") + "]. ";
137 | 
138 |   var self=this;
139 |   this.on(optionName, function(val) {
140 |     // val can be "option_a+option_b,option_c
141 |     var comboOptions = val.split(',');
142 |     comboOptions.forEach(function(comboOption) {
143 |       var options = comboOption.split('+');
144 |       options.forEach(function(option) {
145 |         if (choices.indexOf(option) === -1) {
146 |           self.invalidComboOfChoice(optionName, option, choices);
147 |         }
148 |       });
149 |     });
150 | 
151 |     self[optionName] = comboOptions;
152 |   });
153 |   return this;
154 | };
155 | 
156 | /**
157 |  * Import data loaded by import into "this"
158 |  *
159 |  * @api private
160 |  */
161 | 
162 | Commodore.prototype.importLoadedData = function() {
163 |   // copy loaded data to this.
164 |   for (var optionName in this.loadedData) {
165 |     var option = this.optionFor(optionName);
166 |     if (option.loadable && !(optionName in this)) {
167 |       this[optionName] = this.loadedData[optionName];
168 |     }
169 |   }
170 | };
171 | 
172 | /**
173 |  * Check if all demanded options are specified
174 |  *
175 |  * @api private
176 |  */
177 | 
178 | Commodore.prototype.checkDemanded = function() {
179 |   // check required options.
180 |   var self = this;
181 |   this.options.forEach(function(option) {
182 |     if (option.demand && !(option.name() in self)) {
183 |       self.missingDemandedOption(option.flags);
184 |     }
185 |   });
186 | };
187 | 
188 | /**
189 |  * Override command exposed by Commander to create Commodore instances.
190 |  * @returns {Commodore} the new command
191 |  * @api public
192 |  */
193 | 
194 | Commodore.prototype.command = function(name, desc) {
195 |   var args = name.split(/ +/);
196 |   var cmd = new Commodore(args.shift());
197 |   if (desc) cmd.description(desc);
198 |   if (desc) this.executables = true;
199 |   this.commands.push(cmd);
200 |   cmd.parseExpectedArgs(args);
201 |   cmd.parent = this;
202 |   if (desc) return this;
203 |   return cmd;
204 | };
205 | 
206 | /**
207 |  * Parse `argv`, settings options and invoking commands when defined.
208 |  *
209 |  * @param {Array} argv
210 |  * @return {Command} for chaining
211 |  * @api public
212 |  */
213 | 
214 | Commodore.prototype.parse = function(argv) {
215 |   Command.prototype.parse.call(this, argv);
216 | 
217 |   this.importLoadedData();
218 |   this.checkDemanded();
219 | 
220 |   return this;
221 | };
222 | 
223 | /**
224 |  * Return program help documentation.
225 |  *
226 |  * @return {String}
227 |  * @api private
228 |  */
229 | 
230 | Commodore.prototype.helpInformation = function() {
231 |   var helpInfo = Command.prototype.helpInformation.call(this);
232 | 
233 |   if (this.description()) {
234 |     helpInfo = "\n  Description: " + this.description() + "\n" + helpInfo;
235 |   }
236 | 
237 |   if (this.configPath) {
238 |     helpInfo += "\n  Config file: " + this.configPath + "\n\n";
239 |   }
240 | 
241 |   return helpInfo;
242 | };
243 | 
244 | /**
245 |  * Return help for options.
246 |  *
247 |  * @return {String}
248 |  * @api private
249 |  */
250 | 
251 | Commodore.prototype.optionHelp = function() {
252 |   var optionHelp = Command.prototype.optionHelp.call(this);
253 |   return this.formatOptionHelp(optionHelp);
254 | };
255 | 
256 | /**
257 |  * Format option help text.
258 |  *
259 |  * @param {String} arg
260 |  * @return {String}
261 |  * @api private
262 |  */
263 | 
264 | Commodore.prototype.formatOptionHelp = function(optionHelp) {
265 |   var self = this;
266 |   var lines = optionHelp.split("\n");
267 | 
268 |   var formattedLines = [];
269 | 
270 |   lines.forEach(function(line) {
271 |     formattedLines = formattedLines.concat(breakLine(line));
272 |   });
273 | 
274 |   return formattedLines.join("\n");
275 | 
276 |   function breakLine(line) {
277 |     if (line.length <= MAX_LINE_WIDTH) return [line];
278 | 
279 |     var subLine = line.slice(0, MAX_LINE_WIDTH);
280 |     var breakAt = subLine.lastIndexOf(" ");
281 | 
282 |     // If there is no whitespace, break at the max line width
283 |     if (breakAt === -1) breakAt = MAX_LINE_WIDTH;
284 | 
285 |     var shortLine = subLine.slice(0, breakAt);
286 |     var restOfLine = line.slice(breakAt);
287 | 
288 |     // recursively call formatOptionHelp to break the remaining text.
289 |     var result = [shortLine].concat(
290 |                       self.formatOptionHelp(pad('', self.largestOptionLength()) + '     ' + restOfLine));
291 |     return result;
292 |   }
293 | }
294 | 
295 | /**
296 |  * Return an option matching `arg` if any.
297 |  *
298 |  * @param {String} arg
299 |  * @return {Option}
300 |  * @api private
301 |  */
302 | 
303 | Commodore.prototype.optionFor = function(arg) {
304 |   if (/-/.test(arg)) {
305 |     return Command.prototype.optionFor.call(this, arg);
306 |   }
307 | 
308 |   // arg does not have a -, search both short and long codes.
309 |   for (var i = 0, option; option = this.options[i]; ++i) {
310 |     if (option.is("-" + arg) || option.is("--" + arg)) {
311 |       return option;
312 |     }
313 |   }
314 | };
315 | 
316 | /**
317 |  * Invalid JSON in `config` file
318 |  *
319 |  * @param {String} configPath
320 |  * @param {Error} err
321 |  * @api private
322 |  */
323 | 
324 | Commodore.prototype.invalidJSON = function(configPath, err) {
325 |   displayErrorAndExit("  invalid JSON in %s", configPath, "\n", err);
326 | };
327 | 
328 | /**
329 |  * Option `optionName` not defined, cannot be loadable.
330 |  *
331 |  * @param {optionName}
332 |  * @api private
333 |  */
334 | 
335 | Commodore.prototype.invalidLoadableOption = function(optionName) {
336 |   displayErrorAndExit("  invalid loadable option `%s`", optionName);
337 | };
338 | 
339 | /**
340 |  * Option `optionName` not defined, cannot be required.
341 |  *
342 |  * @param {optionName}
343 |  * @api private
344 |  */
345 | 
346 | Commodore.prototype.invalidDemandedOption = function(optionName) {
347 |   displayErrorAndExit("  invalid required option `%s`", optionName);
348 | };
349 | 
350 | /**
351 |  * Option `optionName` not entered.
352 |  *
353 |  * @param {optionName}
354 |  * @api private
355 |  */
356 | 
357 | Commodore.prototype.missingDemandedOption = function(optionName) {
358 |   this.outputHelp();
359 |   displayErrorAndExit("  option `%s` missing", optionName);
360 | };
361 | 
362 | /**
363 |  * Option `optionName` not defined, cannot be required.
364 |  *
365 |  * @param {optionName}
366 |  * @api private
367 |  */
368 | 
369 | Commodore.prototype.invalidOneOfOption = function(optionName) {
370 |   displayErrorAndExit("  invalid oneof option `%s`", optionName);
371 | };
372 | 
373 | /**
374 |  * Invalid choice for option `optionName`
375 |  *
376 |  * @param {optionName}
377 |  * @api private
378 |  */
379 | 
380 | Commodore.prototype.invalidOneOfChoice = function(optionName, val, options) {
381 |   displayErrorAndExit("  `%s` must be one of: %s", optionName, options.join(', '));
382 | };
383 | 
384 | /**
385 |  * Option `optionName` not defined, cannot be required.
386 |  *
387 |  * @param {optionName}
388 |  * @api private
389 |  */
390 | 
391 | Commodore.prototype.invalidComboOfOption = function(optionName) {
392 |   displayErrorAndExit("  invalid comboof option `%s`", optionName);
393 | };
394 | 
395 | /**
396 |  * Invalid choice for option `optionName`
397 |  *
398 |  * @param {optionName}
399 |  * @api private
400 |  */
401 | 
402 | Commodore.prototype.invalidComboOfChoice = function(optionName, val, options) {
403 |   displayErrorAndExit("  `%s` must be a combination of: %s", optionName, options.join(', '));
404 | };
405 | 
406 | function displayErrorAndExit() {
407 |   var args = [].slice.call(arguments, 0);
408 | 
409 |   console.error();
410 |   console.error.apply(console, args);
411 |   console.error();
412 |   process.exit(1);
413 | }
414 | 
415 | /**
416 |  * Pad `str` to `width`.
417 |  *
418 |  * @param {String} str
419 |  * @param {Number} width
420 |  * @return {String}
421 |  * @api private
422 |  */
423 | 
424 | function pad(str, width) {
425 |   var len = Math.max(0, width - str.length);
426 |   return str + Array(len + 1).join(' ');
427 | }
428 | 
429 | 


--------------------------------------------------------------------------------