1 var path = require('path');
2 var minimist = require('minimist');
3 var wordwrap = require('wordwrap');
5 /* Hack an instance of Argv with process.argv into Argv
7 require('optimist')(['--beeble=1','-z','zizzle']).argv
8 to parse a list of args and
9 require('optimist').argv
10 to get a parsed version of process.argv.
13 var inst = Argv(process.argv.slice(2));
14 Object.keys(inst).forEach(function (key) {
15 Argv[key] = typeof inst[key] == 'function'
16 ? inst[key].bind(inst)
20 var exports = module.exports = Argv;
21 function Argv (processArgs, cwd) {
23 if (!cwd) cwd = process.cwd();
25 self.$0 = process.argv
28 var b = rebase(cwd, x);
29 return x.match(/^\//) && b.length < x.length
35 if (process.env._ != undefined && process.argv[1] == process.env._) {
36 self.$0 = process.env._.replace(
37 path.dirname(process.execPath) + '/', ''
48 self.boolean = function (bools) {
49 options.boolean.push.apply(options.boolean, [].concat(bools));
53 self.string = function (strings) {
54 options.string.push.apply(options.string, [].concat(strings));
58 self.default = function (key, value) {
59 if (typeof key === 'object') {
60 Object.keys(key).forEach(function (k) {
61 self.default(k, key[k]);
65 options.default[key] = value;
70 self.alias = function (x, y) {
71 if (typeof x === 'object') {
72 Object.keys(x).forEach(function (key) {
73 self.alias(key, x[key]);
77 options.alias[x] = (options.alias[x] || []).concat(y);
83 self.demand = function (keys) {
84 if (typeof keys == 'number') {
85 if (!demanded._) demanded._ = 0;
88 else if (Array.isArray(keys)) {
89 keys.forEach(function (key) {
94 demanded[keys] = true;
101 self.usage = function (msg, opts) {
102 if (!opts && typeof msg === 'object') {
109 if (opts) self.options(opts);
114 function fail (msg) {
116 if (msg) console.error(msg);
121 self.check = function (f) {
126 var descriptions = {};
127 self.describe = function (key, desc) {
128 if (typeof key === 'object') {
129 Object.keys(key).forEach(function (k) {
130 self.describe(k, key[k]);
134 descriptions[key] = desc;
139 self.parse = function (args) {
140 return parseArgs(args);
143 self.option = self.options = function (key, opt) {
144 if (typeof key === 'object') {
145 Object.keys(key).forEach(function (k) {
146 self.options(k, key[k]);
150 if (opt.alias) self.alias(key, opt.alias);
151 if (opt.demand) self.demand(key);
152 if (typeof opt.default !== 'undefined') {
153 self.default(key, opt.default);
156 if (opt.boolean || opt.type === 'boolean') {
159 if (opt.string || opt.type === 'string') {
163 var desc = opt.describe || opt.description || opt.desc;
165 self.describe(key, desc);
173 self.wrap = function (cols) {
178 self.showHelp = function (fn) {
179 if (!fn) fn = console.error;
183 self.help = function () {
184 var keys = Object.keys(
185 Object.keys(descriptions)
186 .concat(Object.keys(demanded))
187 .concat(Object.keys(options.default))
188 .reduce(function (acc, key) {
189 if (key !== '_') acc[key] = true;
194 var help = keys.length ? [ 'Options:' ] : [];
197 help.unshift(usage.replace(/\$0/g, self.$0), '');
200 var switches = keys.reduce(function (acc, key) {
201 acc[key] = [ key ].concat(options.alias[key] || [])
203 return (sw.length > 1 ? '--' : '-') + sw
210 var switchlen = longest(Object.keys(switches).map(function (s) {
211 return switches[s] || '';
214 var desclen = longest(Object.keys(descriptions).map(function (d) {
215 return descriptions[d] || '';
218 keys.forEach(function (key) {
219 var kswitch = switches[key];
220 var desc = descriptions[key] || '';
223 desc = wordwrap(switchlen + 4, wrap)(desc)
224 .slice(switchlen + 4)
228 var spadding = new Array(
229 Math.max(switchlen - kswitch.length + 3, 0)
232 var dpadding = new Array(
233 Math.max(desclen - desc.length + 1, 0)
238 if (options.boolean[key]) type = '[boolean]';
239 if (options.string[key]) type = '[string]';
241 if (!wrap && dpadding.length > 0) {
245 var prelude = ' ' + kswitch + spadding;
252 options.default[key] !== undefined
253 ? '[default: ' + JSON.stringify(options.default[key]) + ']'
256 ].filter(Boolean).join(' ');
258 var body = [ desc, extra ].filter(Boolean).join(' ');
261 var dlines = desc.split('\n');
262 var dlen = dlines.slice(-1)[0].length
263 + (dlines.length === 1 ? prelude.length : 0)
265 body = desc + (dlen + extra.length > wrap - 2
267 + new Array(wrap - extra.length + 1).join(' ')
269 : new Array(wrap - extra.length - dlen + 1).join(' ')
274 help.push(prelude + body);
278 return help.join('\n');
281 Object.defineProperty(self, 'argv', {
282 get : function () { return parseArgs(processArgs) },
286 function parseArgs (args) {
287 var argv = minimist(args, options);
290 if (demanded._ && argv._.length < demanded._) {
291 fail('Not enough non-option arguments: got '
292 + argv._.length + ', need at least ' + demanded._
297 Object.keys(demanded).forEach(function (key) {
298 if (!argv[key]) missing.push(key);
301 if (missing.length) {
302 fail('Missing required arguments: ' + missing.join(', '));
305 checks.forEach(function (f) {
307 if (f(argv) === false) {
308 fail('Argument check failed: ' + f.toString());
319 function longest (xs) {
320 return Math.max.apply(
322 xs.map(function (x) { return x.length })
329 // rebase an absolute path to a relative one with respect to a base directory
330 // exported for tests
331 exports.rebase = rebase;
332 function rebase (base, dir) {
333 var ds = path.normalize(dir).split('/').slice(1);
334 var bs = path.normalize(base).split('/').slice(1);
336 for (var i = 0; ds[i] && ds[i] == bs[i]; i++);
337 ds.splice(0, i); bs.splice(0, i);
339 var p = path.normalize(
340 bs.map(function () { return '..' }).concat(ds).join('/')
341 ).replace(/\/$/,'').replace(/^$/, '.');
342 return p.match(/^[.\/]/) ? p : './' + p;