-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
467 lines (384 loc) · 14.3 KB
/
index.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
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
import assert from 'node:assert';
import { isNativeError } from 'node:util/types';
import { hideBin } from 'yargs/helpers';
import yargs from 'yargs/yargs';
import { getRootDebugLogger } from 'universe/debug';
import { discoverCommands } from 'universe/discover';
import { capitalize, wrapExecutionContext } from 'universe/util';
import {
AssertionFailedError,
CliError,
ErrorMessage,
isCliError,
isCommandNotImplementedError,
isGracefulEarlyExitError
} from 'universe/error';
import {
$executionContext,
FrameworkExitCode,
defaultHelpOptionName,
defaultHelpTextDescription,
defaultVersionOptionName,
defaultVersionTextDescription
} from 'universe/constant';
import type { Promisable } from 'type-fest';
import type { ConfigurationHooks, ConfigureErrorHandlingEpilogue } from 'types/configure';
import type {
ExecutionContext,
Executor,
NullArguments,
PreExecutionContext,
// ? Used by intellisense and in auto-generated documentation
// eslint-disable-next-line @typescript-eslint/no-unused-vars
Program
} from 'types/program';
// ? Used by intellisense and in auto-generated documentation
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import type { runProgram } from 'universe/util';
const debug = getRootDebugLogger().extend('index');
/**
* Create and return a {@link PreExecutionContext} containing fully-configured
* {@link Program} instances and an {@link Executor} entry point function.
*
* Command auto-discovery will occur at `commandModulePath`. An exception will
* occur if no commands are loadable from the given `commandModulePath`.
*
* **This function throws whenever an exception occurs**, making it not ideal as
* an entry point for a CLI. See {@link runProgram} for a wrapper function that
* handles exceptions and sets the exit code for you.
*/
export async function configureProgram<
CustomContext extends ExecutionContext = ExecutionContext
>(
/**
* Command auto-discovery will occur at `commandModulePath`. An exception will
* occur if no commands are loadable from the given `commandModulePath`.
*
* `'file://...'`-style URLs are also accepted.
*/
commandModulePath: string,
configurationHooks?: Promisable<ConfigurationHooks>
): Promise<PreExecutionContext> {
debug('configureProgram was invoked');
const finalConfigurationHooks = Object.assign(
{},
((await configurationHooks) || {}) as Required<ConfigurationHooks>
);
finalConfigurationHooks.configureArguments ??= (rawArgv) => rawArgv;
finalConfigurationHooks.configureExecutionPrologue ??= noopConfigurationHook;
finalConfigurationHooks.configureExecutionEpilogue ??= (argv) => argv;
finalConfigurationHooks.configureExecutionContext ??= (context) => {
return context as CustomContext;
};
finalConfigurationHooks.configureErrorHandlingEpilogue ??=
defaultErrorHandlingEpilogueConfigurationHook;
debug('command module auto-discovery path: %O', commandModulePath);
debug('configuration hooks: %O', finalConfigurationHooks);
debug('entering configureExecutionContext');
const context = asUnenumerable(
await finalConfigurationHooks.configureExecutionContext({
commands: new Map(),
debug: getRootDebugLogger(),
state: {
rawArgv: [],
initialTerminalWidth: yargs().terminalWidth(),
showHelpOnFail: true,
firstPassArgv: undefined,
deepestParseResult: undefined,
isGracefullyExiting: false,
isHandlingHelpOption: false,
isHandlingVersionOption: false,
didOutputHelpOrVersionText: false,
finalError: undefined,
globalHelpOption: {
name: defaultHelpOptionName,
description: defaultHelpTextDescription
},
globalVersionOption: {
name: defaultVersionOptionName,
description: defaultVersionTextDescription,
text: ''
}
}
})
);
debug('exited configureExecutionContext');
debug('configured execution context: %O', asEnumerable(context));
if (!context) {
throw new CliError(ErrorMessage.InvalidConfigureExecutionContextReturnType());
}
debug.message(
'to save space, ExecutionContext will be unenumerable from this point on'
);
await discoverCommands(commandModulePath, context);
const { programs: rootPrograms } = getRootCommand();
debug('entering configureExecutionPrologue');
await finalConfigurationHooks.configureExecutionPrologue(rootPrograms, context);
debug('exited configureExecutionPrologue');
debug('finalizing deferred command registrations');
context.commands.forEach((command, fullName) => {
debug('calling HelperProgram::command_finalize_deferred for command %O', fullName);
command.programs.helper.command_finalize_deferred();
});
debug('configureProgram invocation succeeded');
let alreadyInvoked = false;
const parseAndExecuteWithErrorHandling: Executor = async (argv_) => {
debug('execute was invoked');
if (alreadyInvoked) {
// * The documentation and issues literature is ambivalent on what level
// * of support exists for calling yargs::parse multiple times, but our
// * unit tests don't lie. It doesn't work. So let's formalize this
// * invariant.
// *
// * Since this error is thrown outside the primary try/catch block, this
// * assertion failure cannot be handled by
// * configureErrorHandlingEpilogue.
throw new AssertionFailedError(
ErrorMessage.AssertionFailureCannotExecuteMultipleTimes()
);
}
alreadyInvoked = true;
try {
debug('raw argv: %O', argv_);
debug('entering configureArguments');
const argv = await finalConfigurationHooks.configureArguments(
argv_?.length ? argv_ : hideBin(process.argv),
context
);
debug('exited configureArguments');
if (!Array.isArray(argv)) {
throw new AssertionFailedError(
ErrorMessage.InvalidConfigureArgumentsReturnType()
);
}
debug('context.state.globalHelpOption: %O', context.state.globalHelpOption);
debug('context.state.globalVersionOption: %O', context.state.globalVersionOption);
assert(
context.state.globalHelpOption === undefined ||
context.state.globalHelpOption.name?.length,
'bad context.state.globalHelpOption'
);
assert(
context.state.globalVersionOption === undefined ||
context.state.globalVersionOption.name?.length,
'bad context.state.globalVersionOption'
);
if (context.state.globalHelpOption) {
const helpOption = context.state.globalHelpOption.name;
const helpFlag = `${helpOption.length > 1 ? '--' : '-'}${helpOption}`;
const targetIndex = argv.indexOf(helpFlag);
context.state.isHandlingHelpOption = targetIndex >= 0;
} else {
debug.warn(
'disabled built-in help option since context.state.globalHelpOption was falsy'
);
}
debug(
'context.state.isHandlingHelpOption determination: %O',
context.state.isHandlingHelpOption
);
if (context.state.globalVersionOption) {
const versionOption = context.state.globalVersionOption.name;
const versionFlag = `${versionOption.length > 1 ? '--' : '-'}${versionOption}`;
const targetIndex = argv.indexOf(versionFlag);
context.state.isHandlingVersionOption = targetIndex >= 0;
} else {
debug.warn(
'disabled built-in version option since context.state.globalVersionOption was falsy'
);
}
debug(
'context.state.isHandlingVersionOption determination: %O',
context.state.isHandlingVersionOption
);
debug('configured argv (initialRawArgv): %O', argv);
context.state.rawArgv = argv;
debug('calling ::parseAsync on root program');
try {
// * Note how we discard the result of RouterProgram::parseAsync
await rootPrograms.router.parseAsync(argv, wrapExecutionContext(context));
} catch (error_) {
const error = context.state.finalError || error_;
if (error !== error_) {
debug.warn(
'root router parse warning: context.state.finalError !== caught error (caught error was discarded)'
);
}
if (isGracefulEarlyExitError(error)) {
debug.message(
'caught graceful early exit "error" in PreExecutionContext::execute'
);
context.state.isGracefullyExiting = true;
debug.warn(
'though runtime was gracefully interrupted, configureExecutionEpilogue will still be called and the program will exit normally'
);
} else {
throw error;
}
}
context.state.deepestParseResult ||= makeNullParseResult(context);
const finalArgv = context.state.deepestParseResult;
debug('final parsed argv: %O', finalArgv);
debug('context.state.isGracefullyExiting: %O', context.state.isGracefullyExiting);
debug('entering configureExecutionEpilogue');
const result = await finalConfigurationHooks.configureExecutionEpilogue(
finalArgv,
context
);
debug('exited configureExecutionEpilogue');
debug('execution epilogue returned: %O', result);
if (!result) {
throw new AssertionFailedError(
ErrorMessage.AssertionFailureConfigureExecutionEpilogue()
);
}
debug('final execution context: %O', asEnumerable(context));
debug('execution complete (no errors)');
debug.newline();
return result;
} catch (error) {
const debug_error = debug.extend('catch');
debug_error.error('caught fatal error (type %O): %O', typeof error, error);
context.state.deepestParseResult ||= makeNullParseResult(context);
const finalArgv = context.state.deepestParseResult;
debug_error('final parsed argv: %O', finalArgv);
if (isGracefulEarlyExitError(error)) {
debug.message('caught (and released) graceful early exit "error" in catch block');
} else {
// ? Ensure [$executionContext] always exists
finalArgv[$executionContext] ??= context;
let message = ErrorMessage.Generic();
let exitCode = FrameworkExitCode.DefaultError;
const { isAssertionSystemError } = await import('universe/util');
if (typeof error === 'string') {
message = error;
} else if (isNativeError(error)) {
message = error.message;
exitCode =
isAssertionSystemError(error) || isAssertionSystemError(error.cause)
? FrameworkExitCode.AssertionFailed
: isCliError(error)
? error.suggestedExitCode
: FrameworkExitCode.DefaultError;
} else {
message = `${error}`;
}
debug_error('theoretical error message: %O', message);
debug_error('theoretical exit code: %O', exitCode);
debug_error('entering configureErrorHandlingEpilogue');
await finalConfigurationHooks.configureErrorHandlingEpilogue(
{ message, error, exitCode },
finalArgv,
context
);
debug_error('exited configureErrorHandlingEpilogue');
debug_error('final execution context: %O', asEnumerable(context));
if (!isCliError(error)) {
debug_error('wrapping error with CliError');
// eslint-disable-next-line no-ex-assign
error = new CliError(message, { suggestedExitCode: exitCode });
}
}
debug_error.warn('forwarding error to top-level error handler');
throw error;
}
};
return {
rootPrograms,
execute: parseAndExecuteWithErrorHandling,
executionContext: context,
...asEnumerable(context)
};
function getRootCommand() {
const root = context.commands.get(context.commands.keys().next().value);
assert(root !== undefined, ErrorMessage.GuruMeditation());
return root;
}
}
/**
* @internal
*/
export function defaultErrorHandlingEpilogueConfigurationHook(
...[
{ message, error },
_,
{
state: { didOutputHelpOrVersionText }
}
]: Parameters<ConfigureErrorHandlingEpilogue>
) {
if (didOutputHelpOrVersionText) {
/* istanbul ignore next */
if (!isCommandNotImplementedError(error)) {
// eslint-disable-next-line no-console
console.error();
outputErrorMessage();
}
} else {
outputErrorMessage();
}
function outputErrorMessage() {
// eslint-disable-next-line no-console
console.error(capitalize(message));
}
}
/**
* Creates a `NullArguments` instance.
*/
function makeNullParseResult(context: ExecutionContext): NullArguments {
debug.warn('generated a NullArguments parse result');
return {
$0: '<NullArguments: no parse result available due to exception>',
_: [],
[$executionContext]: context
};
}
/**
* Takes an object and rewrites its property descriptors so that its properties
* are no longer enumerable. This leads to less needlessly-verbose object logs
* in debug output.
*/
function asUnenumerable<T extends object>(context: T) {
if (!context) {
return context;
}
const unenumerableContext = {} as T;
const allOwnKeys = (Object.getOwnPropertyNames(context) as (string | symbol)[]).concat(
...Object.getOwnPropertySymbols(context)
);
for (const key of allOwnKeys) {
Object.defineProperty(unenumerableContext, key, {
enumerable: false,
configurable: true,
// @ts-expect-error: TypeScript isn't smart enough to figure this out yet
value: context[key],
writable: true
});
}
return unenumerableContext;
}
/**
* Takes an object and rewrites its property descriptors so that its properties
* are guaranteed enumerable. This is used when we actually do want to show
* verbose object logs in debug output.
*/
function asEnumerable<T extends object>(context: T) {
if (!context) {
return context;
}
const enumerable = {} as T;
const allOwnKeys = (Object.getOwnPropertyNames(context) as (string | symbol)[]).concat(
...Object.getOwnPropertySymbols(context)
);
for (const key of allOwnKeys) {
Object.defineProperty(enumerable, key, {
enumerable: true,
configurable: true,
// @ts-expect-error: TypeScript isn't smart enough to figure this out yet
value: context[key],
writable: true
});
}
return enumerable;
}
function noopConfigurationHook() {}