-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.js
642 lines (579 loc) · 20.6 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
"use strict";
const events = require("events")
, ul = require("ul")
, clp = require("clp")
, iterateObject = require("iterate-object")
, isUndefined = require("is-undefined")
, deffy = require("deffy")
, arrsToObj = require("arrs-to-obj")
, errors = require("./errors")
, Err = require("err")
, Table = require("le-table")
, isEmptyObj = require("is-empty-obj")
, textWrap = require("wrap-text")
, indento = require("indento")
, removeEmptyLines = require("remove-blank-lines")
, ansiParser = require("ansi-parser")
, typpy = require("typpy")
, rJson = require("r-json")
, camelo = require("camelo")
, prompt = require("promptify")
, debugMode = require("debug-mode")
, autoparse = require("auto-parse")
;
const TABLE_OPTIONS = {
cell: {
hAlign: "left"
}
, noAnsi: true
, marks: {
nw: " "
, n: " "
, ne: " "
, e: " "
, se: " "
, s: " "
, sw: " "
, w: " "
, b: " "
, mt: " "
, ml: " "
, mr: " "
, mb: " "
, mm: " "
}
};
class TildaOption {
/**
* TildaOption
* The `TildaOption` class used for creating option objects.
*
* @name TildaOption
* @function
* @param {Object} input An object containing the following fields:
*
* - `name` (String): The option name (optional).
* - `description` (String): The option description.
* - `opts` (Array): An array of aliases (e.g. `["age", "a"]`).
* - `default` (Anything): The default value.
* - `handler` (Function): The option handler which will be called when the
* option is found in the arguments. The first parameter is the option
* object and the second argument is the action where the option belongs to.
* - `required` (Boolean): A flag representing if the option is mandatory or not (default: `false`).
* - `type` (Class|String): The type class (e.g. `String`) or its stringified representation (e.g. `"string"`).
* - `prompt` (Boolean|Object): If `false`, it will disable the prompt even if the option is required. If it's an object, it will passed as options to `prompt-sync`.
*
* @returns {TildaOption} The `TildaOption` instance.
*
* - `description` (String): The option description.
* - `opts` (Array): An array of aliases (e.g. `["age", "a"]`).
* - `aliases` (Array): An array of strings containing the computed aliases,
* the single letter ones being the first (e.g. `["-n", "--name"]`).
* - `value` (null|String|DefaultValue): The option value which was found
* after processing the arguments.
* - `def` (Anything): The provided default value.
* - `is_provided` (Boolean): A flag if the option was or not been provided.
* - `handler` (Function): The handler function.
* - `required` (Boolean): The required value.
* - `type` (Class|String): The option value type.
* - `prompt` (Boolean|Object): The prompt settings..
*/
constructor (input) {
this.name = input.name;
this.description = input.description || input.desc;
this.opts = input.opts;
this.value = null;
if (!isUndefined(input.default)) {
this.value = this.default = input.default;
}
this.opts.sort(a => a.length === 1 ? -1 : 1);
this.aliases = this.opts.map(c => {
return (c.length === 1 ? "-" : "--") + c
});
this.is_provided = false;
this.handler = input.handler;
this.required = input.required || false;
this.type = input.type;
this.prompt = input.prompt;
}
}
class TildaActionArg {
constructor (input) {
if (typpy(input, String)) {
input = { name: input };
}
this.name = input.name;
this.description = input.desc || input.description || "";
this.type = input.type;
this.stdin = input.stdin || false;
this.prompt = input.prompt;
}
}
class TildaAction extends events.EventEmitter {
/**
* TildaAction
* The `TildaAction` class used for creating action objects.
*
* This is extended `EventEmitter`.
*
* @name TildaAction
* @function
* @param {String|Object} info The path to a containing the needed information or an object containing:
*
* - `description|desc` (String): The action description.
* - `name` (String): The action name.
* - `bin` (Object): A `package.json`-like `bin` field (optional).
* - `args` (Array): An array of strings/objects representing the action argument names (default: `[]`).
* - `examples` (Array): An array of strings containing examples how to use the action.
* - `notes` (String): Additional notes to display in the help command.
* - `documentation` (String): Action-related documentation.
*
* @param {Object} options An object containing the following fields (if
* provided, they have priority over the `info` object):
*
* - `args` (Array): An array of strings/objects representing the action argument names (default: `[]`).
* - `examples` (Array): An array of strings containing examples how to use the action.
* - `notes` (String): Additional notes to display in the help command.
* - `documentation` (String): Action-related documentation.
*
* @returns {TildaAction} The `TildaAction` instance containing:
*
* - `options` (Object): The action options.
* - `description` (String): The action description.
* - `name` (String): The action name.
* - `uniqueOpts` (Array): An array of unique options in order.
* - `_args` (Array): The action arguments.
* - `argNames` (Array): The action argument names.
* - `args` (Object): The arguments' values.
* - `examples` (Array): An array of strings containing examples how to use the action.
* - `notes` (String): Additional notes to display in the help command.
* - `documentation` (String): Action-related documentation.
* - `stdinData` (String): The stdin data.
*
*/
constructor (info, options) {
info = TildaAction.readInfo(info);
super();
options = options || {};
this.options = {};
this.description = info.description || info.desc || "";
this.name = Object.keys(info.bin || {})[0] || info.name;
this.uniqueOpts = [];
this._args = Tilda.convertTo(TildaActionArg, options.args || info.args || []);
this.argNames = this._args.map(x => x.name);
this.args = {};
this.examples = options.examples || info.examples || [];
this.notes = options.notes || info.notes || "";
this.documentation = info.homepage || options.documentation || info.documentation || "";
}
/**
* readInfo
* Converts the info input into json output.
*
* @name readInfo
* @function
* @param {String|Object} info The info object or path to a json file.
* @returns {Object} The info object.
*/
static readInfo (info) {
if (typeof info === "string") {
info = rJson(info);
}
return info;
}
/**
* option
* Adds one or more options to the action object.
*
* @name option
* @function
* @param {Array|Object} input An array of option objects or an object
* passed to the `TildaOption` class.
*/
option (input) {
if (!input) { return; }
if (Array.isArray(input)) {
input.forEach(c => this.option(c));
return this;
}
if (!Array.isArray(input.opts)) {
throw new Error("The opts array is mandatory.");
}
let opt = Tilda.convertTo(TildaOption, input);
opt.opts.forEach(c => {
let cc = camelo(c);
if (this.options[cc] || this.options[c]) {
throw new Error(`Found duplicated option: ${c}. The option names should be unique.`);
}
this.options[cc] = this.options[c] = opt;
});
this.uniqueOpts.push(opt);
return this;
}
}
const Tilda = module.exports = class Tilda extends TildaAction {
/**
* Tilda
* Creates the parser instance.
*
* @name Tilda
* @function
* @param {Object} info The `info` object passed to `TildaAction`.
* @param {Object} options The `options` passed to `TildaAction`, extended with:
*
* - `defaultOptions` (Array): Default and global options (default: help and version options).
* - `argv` (Array): A cutom array of arguments to parse (default: process arguments).
* - `stdin` (Boolean): Whether to listen for stdin data or not (default: `false`).
*
* @returns {Tilda} The `Tilda` instance containing:
*
* - `actions` (Object): An object containing the action objects.
* - `version` (String): The version (used in help and version outputs).
* - `argv` (Array): Array of arguments to parse.
* - `_globalOptions` (Array): The global options, appended to all the actions.
* - `actionNames` (Array): Action names in order.
*/
constructor (info, options) {
options = ul.merge(options, {
defaultOptions: [
{
opts: ["help", "h"]
, description: "Displays this help."
, handler: (opt, action) => {
this.displayHelp(action);
}
}
, {
opts: ["version", "v"]
, description: "Displays version information."
, handler: () => {
this.displayVersion();
}
}
]
, options: []
, autoparse: true
, argv: process.argv.slice(2)
, stdin: options && options.args ? options.args.some(c => c.stdin) : false
});
info = TildaAction.readInfo(info);
super(info, options);
this.actions = {};
this.version = info.version;
this.argv = options.argv;
this._globalOptions = [];
this.actionNames = [];
this.globalOption(options.defaultOptions);
this.option(options.options);
process.nextTick(_ => {
this.stdinData = "";
if (!options.stdin || debugMode() || process.stdin.isTTY) {
this.parse()
} else {
process.stdin.setEncoding("utf8");
process.stdin.on("data", chunk => {
this.stdinData += chunk;
});
process.stdin.on("close", () => {
this.parse()
});
}
});
}
/**
* globalOption
* Adds a global option for all the actions.
*
* @name globalOption
* @function
* @param {Array|Object} input The option object.
*/
globalOption (input) {
input = Tilda.convertTo(TildaOption, input);
this._globalOptions.push(input);
iterateObject(this.actions, action => {
action.option(input);
});
return this.option(input);
}
/**
* action
* Adds a new action.
*
* @name action
* @function
* @param {Object} input The info object passed to `TildaAction`.
* @param {Array} opts The action options.
*/
action (input, opts) {
if (Array.isArray(input)) {
input.forEach(c => this.action(c));
return this;
}
let nAction = Tilda.convertTo(TildaAction, input, opts);
nAction.option(input.options);
this._globalOptions.forEach(c => nAction.option(c));
this.actionNames.push(nAction.name);
if (this.actions[nAction.name]) {
throw new Err("Duplicated action name '<actionName>'", {
actionName: nAction.name
});
}
this.actions[nAction.name] = this.actions[camelo(nAction.name)] = nAction;
return this;
}
/**
* exit
* Exits the process.
*
* @name exit
* @function
* @param {String|Object} msg The stringified message or an object containing the error code.
* @param {Number} code The exit code (default: `0`).
*/
exit (msg, code) {
code = code || 0;
if (typeof msg === "string") {
console.log(msg);
return process.exit(code);
} else if (msg) {
if (msg.code && errors[msg.code]) {
msg = new Err(errors[msg.code], msg);
}
return this.exit(msg.message, 1);
}
}
/**
* parse
* Parses the arguments. This is called internally.
*
* This emits the action names as events.
*
* @name parse
* @function
*/
parse () {
let res = clp(this.argv)
, actionName = res._[0]
, action = this.actions[actionName] || this
;
// Parse the options
iterateObject(action.uniqueOpts, c => {
let optValue = null
, name = null
;
// Find the option value
iterateObject(c.opts, cOpt => {
if (!isUndefined(res[cOpt])) {
optValue = res[cOpt];
name = cOpt;
return false;
}
});
// Handle required options
if (optValue === null && c.required) {
if (c.prompt !== false) {
let pr = c.prompt || {};
if (c.name === "password") {
pr.echo = pr.echo || "*";
}
pr.value = pr.value || "";
optValue = c.value = prompt(`${c.name} (${c.description})`, undefined, pr) || "";
} else {
this.exit({
code: "MISSING_REQUIRED_OPTION"
, option: c.aliases[1] || c.aliases[0]
, exe: this.name
});
return false;
}
}
// Ignore empty options
if (optValue === null) { return; }
// Missing value?
if (c.name && typeof optValue === "boolean" && c.type !== Boolean) {
this.exit({
code: "MISSING_VALUE"
, option: c.aliases[c.opts.indexOf(name)]
, exe: this.name
});
}
if (c.type) {
optValue = autoparse(optValue, c.type);
}
// Handle validate option value type
if (c.type && !typpy(optValue, c.type)) {
this.exit({
code: "INVALID_OPTION_VALUE"
, option: c.aliases[c.opts.indexOf(name)]
, exe: this.name
});
return false;
}
// Valid option value
c.value = optValue;
c.is_provided = true;
if (c.handler) {
c.handler(c, action);
}
});
// Handle the action args
if (action._args.length) {
let values = res._.slice(action.actions ? 0 : 1);
action._args.forEach((arg, i) => {
if (this.stdinData && arg.stdin) {
arg.type = arg.type || String;
values[i] = this.stdinData;
} else if (!values[i] && arg.prompt !== false) {
let pr = arg.prompt || {};
if (arg.name === "password") {
pr.echo = pr.echo || "*";
}
pr.value = pr.value || "";
values[i] = prompt(`${arg.name} (${arg.description})`, pr) || "";
}
});
let diff = action._args.length - values.length;
if (diff > 0) {
return this.exit({
code: "MISSING_ACTION_ARG"
, argName: action.argNames[diff - 1]
, exe: this.name
});
} else if (diff < 0) {
return this.exit({
code: "TOO_MANY_ACTION_ARGS"
, exe: this.name
});
}
iterateObject(values, (c, i) => {
let arg = action._args[i];
if (!arg.type) { return; }
if (arg.type) {
c = values[i] = autoparse(values[i], arg.type);
}
if (arg.type && !typpy(c, arg.type)) {
return this.exit({
code: "INVALID_ARG_VALUE"
, exe: this.name
, arg: arg
});
}
});
action.args = arrsToObj(action.argNames, values);
}
this.emit(action.name, action);
}
/**
* displayVersion
* Returns the version information.
*
* @name displayVersion
* @function
* @return {String} The version information.
*/
displayVersion () {
this.exit(this.name + " " + this.version);
}
/**
* displayHelp
* Displays the help output.
*
* @name displayHelp
* @function
* @param {TildaAction} action The action you want to display help for.
*/
displayHelp (action) {
action = action || this;
let isMain = !!action.actions
, hasActions = !isEmptyObj(action.actions || {})
, hasOptions = !isEmptyObj(action.options)
, helpOutput = ""
;
helpOutput += "Usage: " + this.name
+ (isMain ? hasActions ? " <command>" : "" : " " + action.name)
+ action.argNames.map(x => " <" + x + ">").join("")
+ (hasOptions ? " [options]" : "")
+ `\n\n${textWrap(action.description, 80)}\n`
;
if (action._args.length) {
helpOutput += "\nCommand arguments:\n";
let tbl = new Table(TABLE_OPTIONS);
action._args.forEach(c => {
tbl.addRow(["<" + c.name + ">", textWrap(c.description, 50)]);
});
helpOutput += removeEmptyLines(
tbl.stringify()
);
}
if (hasActions) {
helpOutput += "\nCommands:\n";
let tbl = new Table(TABLE_OPTIONS);
action.actionNames.forEach(cActionName => {
let cAct = action.actions[cActionName];
tbl.addRow([cAct.name, textWrap(cAct.description, 50)]);
});
helpOutput += removeEmptyLines(
tbl.stringify()
);
}
if (hasOptions) {
helpOutput += "\nOptions:\n";
let tbl = new Table(TABLE_OPTIONS);
action.uniqueOpts.sort(x => {
return ~x.aliases.indexOf("-h") || ~x.aliases.indexOf("-v") ? 1 : -1;
}).forEach(cOpt => {
let optStr = cOpt.aliases.join(", ");
if (cOpt.name) {
optStr += " <" + cOpt.name + ">";
}
tbl.addRow([optStr, textWrap(cOpt.description, 50)]);
});
helpOutput += removeEmptyLines(
tbl.stringify()
);
}
if (action.examples.length) {
helpOutput += "\nExamples:";
helpOutput += "\n" + action.examples.map(c => indento((/^(\$|\#)/.test(c) ? "" : "$ ") + c, 2)).join("\n") + "\n";
}
if (action.notes.length) {
helpOutput += "\n" + textWrap(action.notes, 80) + "\n";
}
if (this.documentation) {
helpOutput += `\nDocumentation can be found at ${this.documentation}.`;
}
this.exit(helpOutput);
}
/**
* main
* Append a handler when the main action is used.
*
* @name main
* @function
* @param {Function} cb The callback function.
*/
main (cb) {
return this.on(this.name, cb);
}
/**
* convertTo
* Converts an input into a class instance.
*
* @name convertTo
* @function
* @param {Class} classConst The class to convert to.
* @param {Object|Array} input The object info.
* @param {Object} opts The options object (optional).
* @returns {TildaAction|TildaOption} The input converted into a class instance.
*/
static convertTo (classConst, input, opts) {
if (typpy(input, classConst)) {
return input;
}
if (typpy(input, Array)) {
return input.map(x => new classConst(x, opts));
}
return new classConst(input, opts);
}
};