/
parser.ts
395 lines (343 loc) · 11.4 KB
/
parser.ts
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
/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*
*/
import { BaseException, logging, strings } from '@angular-devkit/core';
import { Arguments, Option, OptionType, Value } from './interface';
export class ParseArgumentException extends BaseException {
constructor(
public readonly comments: string[],
public readonly parsed: Arguments,
public readonly ignored: string[],
) {
super(`One or more errors occured while parsing arguments:\n ${comments.join('\n ')}`);
}
}
function _coerceType(str: string | undefined, type: OptionType, v?: Value): Value | undefined {
switch (type) {
case OptionType.Any:
if (Array.isArray(v)) {
return v.concat(str || '');
}
return _coerceType(str, OptionType.Boolean, v) !== undefined
? _coerceType(str, OptionType.Boolean, v)
: _coerceType(str, OptionType.Number, v) !== undefined
? _coerceType(str, OptionType.Number, v)
: _coerceType(str, OptionType.String, v);
case OptionType.String:
return str || '';
case OptionType.Boolean:
switch (str) {
case 'false':
return false;
case undefined:
case '':
case 'true':
return true;
default:
return undefined;
}
case OptionType.Number:
if (str === undefined) {
return 0;
} else if (str === '') {
return undefined;
} else if (Number.isFinite(+str)) {
return +str;
} else {
return undefined;
}
case OptionType.Array:
return Array.isArray(v)
? v.concat(str || '')
: v === undefined
? [str || '']
: [v + '', str || ''];
default:
return undefined;
}
}
function _coerce(str: string | undefined, o: Option | null, v?: Value): Value | undefined {
if (!o) {
return _coerceType(str, OptionType.Any, v);
} else {
const types = o.types || [o.type];
// Try all the types one by one and pick the first one that returns a value contained in the
// enum. If there's no enum, just return the first one that matches.
for (const type of types) {
const maybeResult = _coerceType(str, type, v);
if (maybeResult !== undefined) {
if (!o.enum || o.enum.includes(maybeResult)) {
return maybeResult;
}
}
}
return undefined;
}
}
function _getOptionFromName(name: string, options: Option[]): Option | undefined {
const camelName = /(-|_)/.test(name)
? strings.camelize(name)
: name;
for (const option of options) {
if (option.name === name || option.name === camelName) {
return option;
}
if (option.aliases.some(x => x === name || x === camelName)) {
return option;
}
}
return undefined;
}
function _removeLeadingDashes(key: string): string {
const from = key.startsWith('--') ? 2 : key.startsWith('-') ? 1 : 0;
return key.substr(from);
}
function _assignOption(
arg: string,
args: string[],
{ options, parsedOptions, leftovers, ignored, errors, warnings }: {
options: Option[],
parsedOptions: Arguments,
positionals: string[],
leftovers: string[],
ignored: string[],
errors: string[],
warnings: string[],
},
) {
const from = arg.startsWith('--') ? 2 : 1;
let key = arg.substr(from);
let option: Option | null = null;
let value = '';
const i = arg.indexOf('=');
// If flag is --no-abc AND there's no equal sign.
if (i == -1) {
if (key.startsWith('no')) {
// Only use this key if the option matching the rest is a boolean.
const from = key.startsWith('no-') ? 3 : 2;
const maybeOption = _getOptionFromName(strings.camelize(key.substr(from)), options);
if (maybeOption && maybeOption.type == 'boolean') {
value = 'false';
option = maybeOption;
}
}
if (option === null) {
// Set it to true if it's a boolean and the next argument doesn't match true/false.
const maybeOption = _getOptionFromName(key, options);
if (maybeOption) {
value = args[0];
let shouldShift = true;
if (value && value.startsWith('-')) {
// Verify if not having a value results in a correct parse, if so don't shift.
if (_coerce(undefined, maybeOption) !== undefined) {
shouldShift = false;
}
}
// Only absorb it if it leads to a better value.
if (shouldShift && _coerce(value, maybeOption) !== undefined) {
args.shift();
} else {
value = '';
}
option = maybeOption;
}
}
} else {
key = arg.substring(0, i);
option = _getOptionFromName(_removeLeadingDashes(key), options) || null;
if (option) {
value = arg.substring(i + 1);
}
}
if (option === null) {
if (args[0] && !args[0].startsWith('-')) {
leftovers.push(arg, args[0]);
args.shift();
} else {
leftovers.push(arg);
}
} else {
const v = _coerce(value, option, parsedOptions[option.name]);
if (v !== undefined) {
if (parsedOptions[option.name] !== v) {
if (parsedOptions[option.name] !== undefined) {
warnings.push(
`Option ${JSON.stringify(option.name)} was already specified with value `
+ `${JSON.stringify(parsedOptions[option.name])}. The new value ${JSON.stringify(v)} `
+ `will override it.`,
);
}
parsedOptions[option.name] = v;
if (option.deprecated !== undefined && option.deprecated !== false) {
warnings.push(`Option ${JSON.stringify(option.name)} is deprecated${
typeof option.deprecated == 'string' ? ': ' + option.deprecated : ''}.`);
}
}
} else {
let error = `Argument ${key} could not be parsed using value ${JSON.stringify(value)}.`;
if (option.enum) {
error += ` Valid values are: ${option.enum.map(x => JSON.stringify(x)).join(', ')}.`;
} else {
error += `Valid type(s) is: ${(option.types || [option.type]).join(', ')}`;
}
errors.push(error);
ignored.push(arg);
}
}
}
/**
* Parse the arguments in a consistent way, but without having any option definition. This tries
* to assess what the user wants in a free form. For example, using `--name=false` will set the
* name properties to a boolean type.
* This should only be used when there's no schema available or if a schema is "true" (anything is
* valid).
*
* @param args Argument list to parse.
* @returns An object that contains a property per flags from the args.
*/
export function parseFreeFormArguments(args: string[]): Arguments {
const parsedOptions: Arguments = {};
const leftovers = [];
for (let arg = args.shift(); arg !== undefined; arg = args.shift()) {
if (arg == '--') {
leftovers.push(...args);
break;
}
if (arg.startsWith('--')) {
const eqSign = arg.indexOf('=');
let name: string;
let value: string | undefined;
if (eqSign !== -1) {
name = arg.substring(2, eqSign);
value = arg.substring(eqSign + 1);
} else {
name = arg.substr(2);
value = args.shift();
}
const v = _coerce(value, null, parsedOptions[name]);
if (v !== undefined) {
parsedOptions[name] = v;
}
} else if (arg.startsWith('-')) {
arg.split('').forEach(x => parsedOptions[x] = true);
} else {
leftovers.push(arg);
}
}
parsedOptions['--'] = leftovers;
return parsedOptions;
}
/**
* Parse the arguments in a consistent way, from a list of standardized options.
* The result object will have a key per option name, with the `_` key reserved for positional
* arguments, and `--` will contain everything that did not match. Any key that don't have an
* option will be pushed back in `--` and removed from the object. If you need to validate that
* there's no additionalProperties, you need to check the `--` key.
*
* @param args The argument array to parse.
* @param options List of supported options. {@see Option}.
* @param logger Logger to use to warn users.
* @returns An object that contains a property per option.
*/
export function parseArguments(
args: string[],
options: Option[] | null,
logger?: logging.Logger,
): Arguments {
if (options === null) {
options = [];
}
const leftovers: string[] = [];
const positionals: string[] = [];
const parsedOptions: Arguments = {};
const ignored: string[] = [];
const errors: string[] = [];
const warnings: string[] = [];
const state = { options, parsedOptions, positionals, leftovers, ignored, errors, warnings };
for (let arg = args.shift(); arg !== undefined; arg = args.shift()) {
if (arg == '--') {
// If we find a --, we're done.
leftovers.push(...args);
break;
}
if (arg.startsWith('--')) {
_assignOption(arg, args, state);
} else if (arg.startsWith('-')) {
// Argument is of form -abcdef. Starts at 1 because we skip the `-`.
for (let i = 1; i < arg.length; i++) {
const flag = arg[i];
// If the next character is an '=', treat it as a long flag.
if (arg[i + 1] == '=') {
const f = '-' + flag + arg.slice(i + 1);
_assignOption(f, args, state);
break;
}
// Treat the last flag as `--a` (as if full flag but just one letter). We do this in
// the loop because it saves us a check to see if the arg is just `-`.
if (i == arg.length - 1) {
const arg = '-' + flag;
_assignOption(arg, args, state);
} else {
const maybeOption = _getOptionFromName(flag, options);
if (maybeOption) {
const v = _coerce(undefined, maybeOption, parsedOptions[maybeOption.name]);
if (v !== undefined) {
parsedOptions[maybeOption.name] = v;
}
}
}
}
} else {
positionals.push(arg);
}
}
// Deal with positionals.
// TODO(hansl): this is by far the most complex piece of code in this file. Try to refactor it
// simpler.
if (positionals.length > 0) {
let pos = 0;
for (let i = 0; i < positionals.length;) {
let found = false;
let incrementPos = false;
let incrementI = true;
// We do this with a found flag because more than 1 option could have the same positional.
for (const option of options) {
// If any option has this positional and no value, AND fit the type, we need to remove it.
if (option.positional === pos) {
const coercedValue = _coerce(positionals[i], option, parsedOptions[option.name]);
if (parsedOptions[option.name] === undefined && coercedValue !== undefined) {
parsedOptions[option.name] = coercedValue;
found = true;
} else {
incrementI = false;
}
incrementPos = true;
}
}
if (found) {
positionals.splice(i--, 1);
}
if (incrementPos) {
pos++;
}
if (incrementI) {
i++;
}
}
}
if (positionals.length > 0 || leftovers.length > 0) {
parsedOptions['--'] = [...positionals, ...leftovers];
}
if (warnings.length > 0 && logger) {
warnings.forEach(message => logger.warn(message));
}
if (errors.length > 0) {
throw new ParseArgumentException(errors, parsedOptions, ignored);
}
return parsedOptions;
}