@rindo/core 2.17.0 → 2.17.2-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli/config-flags.d.ts +110 -0
- package/cli/index.cjs +612 -220
- package/cli/index.d.ts +2 -1
- package/cli/index.js +612 -220
- package/cli/package.json +1 -1
- package/compiler/package.json +1 -1
- package/compiler/rindo.js +391 -178
- package/compiler/rindo.min.js +2 -2
- package/dependencies.json +1 -1
- package/dev-server/client/index.js +1 -1
- package/dev-server/client/package.json +1 -1
- package/dev-server/connector.html +2 -2
- package/dev-server/index.js +1 -1
- package/dev-server/package.json +1 -1
- package/dev-server/server-process.js +2 -2
- package/internal/app-data/package.json +1 -1
- package/internal/client/css-shim.js +1 -1
- package/internal/client/dom.js +1 -1
- package/internal/client/index.js +11 -6
- package/internal/client/package.json +1 -1
- package/internal/client/patch-browser.js +1 -1
- package/internal/client/patch-esm.js +1 -1
- package/internal/client/shadow-css.js +1 -1
- package/internal/hydrate/index.js +2 -2
- package/internal/hydrate/package.json +1 -1
- package/internal/package.json +1 -1
- package/internal/rindo-private.d.ts +2 -2
- package/internal/rindo-public-compiler.d.ts +67 -48
- package/internal/testing/index.js +1 -1
- package/internal/testing/package.json +1 -1
- package/mock-doc/index.cjs +26 -3
- package/mock-doc/index.d.ts +10 -0
- package/mock-doc/index.js +26 -3
- package/mock-doc/package.json +1 -1
- package/package.json +5 -3
- package/screenshot/package.json +1 -1
- package/sys/node/index.js +4 -4
- package/sys/node/package.json +1 -1
- package/sys/node/worker.js +1 -1
- package/testing/index.d.ts +1 -1
- package/testing/index.js +49 -25
- package/testing/jest/jest-config.d.ts +1 -1
- package/testing/jest/jest-runner.d.ts +3 -2
- package/testing/jest/jest-screenshot.d.ts +1 -1
- package/testing/mocks.d.ts +27 -2
- package/testing/package.json +1 -1
- package/testing/puppeteer/puppeteer-browser.d.ts +2 -2
- package/testing/testing-utils.d.ts +74 -2
- package/testing/testing.d.ts +2 -2
package/cli/index.cjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
Rindo CLI (CommonJS) v2.17.0 | MIT Licensed | https://rindojs.web.app
|
|
2
|
+
Rindo CLI (CommonJS) v2.17.2-0 | MIT Licensed | https://rindojs.web.app
|
|
3
3
|
*/
|
|
4
4
|
'use strict';
|
|
5
5
|
|
|
@@ -25,8 +25,50 @@ function _interopNamespace(e) {
|
|
|
25
25
|
return Object.freeze(n);
|
|
26
26
|
}
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
/**
|
|
29
|
+
* This sets the log level hierarchy for our terminal logger, ranging from
|
|
30
|
+
* most to least verbose.
|
|
31
|
+
*
|
|
32
|
+
* Ordering the levels like this lets us easily check whether we should log a
|
|
33
|
+
* message at a given time. For instance, if the log level is set to `'warn'`,
|
|
34
|
+
* then anything passed to the logger with level `'warn'` or `'error'` should
|
|
35
|
+
* be logged, but we should _not_ log anything with level `'info'` or `'debug'`.
|
|
36
|
+
*
|
|
37
|
+
* If we have a current log level `currentLevel` and a message with level
|
|
38
|
+
* `msgLevel` is passed to the logger, we can determine whether or not we should
|
|
39
|
+
* log it by checking if the log level on the message is further up or at the
|
|
40
|
+
* same level in the hierarchy than `currentLevel`, like so:
|
|
41
|
+
*
|
|
42
|
+
* ```ts
|
|
43
|
+
* LOG_LEVELS.indexOf(msgLevel) >= LOG_LEVELS.indexOf(currentLevel)
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* NOTE: for the reasons described above, do not change the order of the entries
|
|
47
|
+
* in this array without good reason!
|
|
48
|
+
*/
|
|
49
|
+
const LOG_LEVELS = ['debug', 'info', 'warn', 'error'];
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Convert a string from PascalCase to dash-case
|
|
53
|
+
*
|
|
54
|
+
* @param str the string to convert
|
|
55
|
+
* @returns a converted string
|
|
56
|
+
*/
|
|
57
|
+
const toDashCase = (str) => str
|
|
58
|
+
.replace(/([A-Z0-9])/g, (match) => ` ${match[0]}`)
|
|
59
|
+
.trim()
|
|
60
|
+
.split(' ')
|
|
61
|
+
.join('-')
|
|
62
|
+
.toLowerCase();
|
|
63
|
+
/**
|
|
64
|
+
* Convert a string from dash-case / kebab-case to PascalCase (or CamelCase,
|
|
65
|
+
* or whatever you call it!)
|
|
66
|
+
*
|
|
67
|
+
* @param str a string to convert
|
|
68
|
+
* @returns a converted string
|
|
69
|
+
*/
|
|
70
|
+
const dashToPascalCase = (str) => str
|
|
71
|
+
.toLowerCase()
|
|
30
72
|
.split('-')
|
|
31
73
|
.map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
|
|
32
74
|
.join('');
|
|
@@ -299,22 +341,223 @@ const validateComponentTag = (tag) => {
|
|
|
299
341
|
return undefined;
|
|
300
342
|
};
|
|
301
343
|
|
|
302
|
-
|
|
344
|
+
/**
|
|
345
|
+
* All the Boolean options supported by the Rindo CLI
|
|
346
|
+
*/
|
|
347
|
+
const BOOLEAN_CLI_ARGS = [
|
|
348
|
+
'build',
|
|
349
|
+
'cache',
|
|
350
|
+
'checkVersion',
|
|
351
|
+
'ci',
|
|
352
|
+
'compare',
|
|
353
|
+
'debug',
|
|
354
|
+
'dev',
|
|
355
|
+
'devtools',
|
|
356
|
+
'docs',
|
|
357
|
+
'e2e',
|
|
358
|
+
'es5',
|
|
359
|
+
'esm',
|
|
360
|
+
'headless',
|
|
361
|
+
'help',
|
|
362
|
+
'log',
|
|
363
|
+
'open',
|
|
364
|
+
'prerender',
|
|
365
|
+
'prerenderExternal',
|
|
366
|
+
'prod',
|
|
367
|
+
'profile',
|
|
368
|
+
'serviceWorker',
|
|
369
|
+
'screenshot',
|
|
370
|
+
'serve',
|
|
371
|
+
'skipNodeCheck',
|
|
372
|
+
'spec',
|
|
373
|
+
'ssr',
|
|
374
|
+
'stats',
|
|
375
|
+
'updateScreenshot',
|
|
376
|
+
'verbose',
|
|
377
|
+
'version',
|
|
378
|
+
'watch',
|
|
379
|
+
// JEST CLI OPTIONS
|
|
380
|
+
'all',
|
|
381
|
+
'automock',
|
|
382
|
+
'bail',
|
|
383
|
+
// 'cache', Rindo already supports this argument
|
|
384
|
+
'changedFilesWithAncestor',
|
|
385
|
+
// 'ci', Rindo already supports this argument
|
|
386
|
+
'clearCache',
|
|
387
|
+
'clearMocks',
|
|
388
|
+
'collectCoverage',
|
|
389
|
+
'color',
|
|
390
|
+
'colors',
|
|
391
|
+
'coverage',
|
|
392
|
+
// 'debug', Rindo already supports this argument
|
|
393
|
+
'detectLeaks',
|
|
394
|
+
'detectOpenHandles',
|
|
395
|
+
'errorOnDeprecated',
|
|
396
|
+
'expand',
|
|
397
|
+
'findRelatedTests',
|
|
398
|
+
'forceExit',
|
|
399
|
+
'init',
|
|
400
|
+
'injectGlobals',
|
|
401
|
+
'json',
|
|
402
|
+
'lastCommit',
|
|
403
|
+
'listTests',
|
|
404
|
+
'logHeapUsage',
|
|
405
|
+
'noStackTrace',
|
|
406
|
+
'notify',
|
|
407
|
+
'onlyChanged',
|
|
408
|
+
'onlyFailures',
|
|
409
|
+
'passWithNoTests',
|
|
410
|
+
'resetMocks',
|
|
411
|
+
'resetModules',
|
|
412
|
+
'restoreMocks',
|
|
413
|
+
'runInBand',
|
|
414
|
+
'runTestsByPath',
|
|
415
|
+
'showConfig',
|
|
416
|
+
'silent',
|
|
417
|
+
'skipFilter',
|
|
418
|
+
'testLocationInResults',
|
|
419
|
+
'updateSnapshot',
|
|
420
|
+
'useStderr',
|
|
421
|
+
// 'verbose', Rindo already supports this argument
|
|
422
|
+
// 'version', Rindo already supports this argument
|
|
423
|
+
// 'watch', Rindo already supports this argument
|
|
424
|
+
'watchAll',
|
|
425
|
+
'watchman',
|
|
426
|
+
];
|
|
427
|
+
/**
|
|
428
|
+
* All the Number options supported by the Rindo CLI
|
|
429
|
+
*/
|
|
430
|
+
const NUMBER_CLI_ARGS = [
|
|
431
|
+
'port',
|
|
432
|
+
// JEST CLI ARGS
|
|
433
|
+
'maxConcurrency',
|
|
434
|
+
'testTimeout',
|
|
435
|
+
];
|
|
436
|
+
/**
|
|
437
|
+
* All the String options supported by the Rindo CLI
|
|
438
|
+
*/
|
|
439
|
+
const STRING_CLI_ARGS = [
|
|
440
|
+
'address',
|
|
441
|
+
'config',
|
|
442
|
+
'docsApi',
|
|
443
|
+
'docsJson',
|
|
444
|
+
'emulate',
|
|
445
|
+
'root',
|
|
446
|
+
'screenshotConnector',
|
|
447
|
+
// JEST CLI ARGS
|
|
448
|
+
'cacheDirectory',
|
|
449
|
+
'changedSince',
|
|
450
|
+
'collectCoverageFrom',
|
|
451
|
+
// 'config', Rindo already supports this argument
|
|
452
|
+
'coverageDirectory',
|
|
453
|
+
'coverageThreshold',
|
|
454
|
+
'env',
|
|
455
|
+
'filter',
|
|
456
|
+
'globalSetup',
|
|
457
|
+
'globalTeardown',
|
|
458
|
+
'globals',
|
|
459
|
+
'haste',
|
|
460
|
+
'moduleNameMapper',
|
|
461
|
+
'notifyMode',
|
|
462
|
+
'outputFile',
|
|
463
|
+
'preset',
|
|
464
|
+
'prettierPath',
|
|
465
|
+
'resolver',
|
|
466
|
+
'rootDir',
|
|
467
|
+
'runner',
|
|
468
|
+
'testEnvironment',
|
|
469
|
+
'testEnvironmentOptions',
|
|
470
|
+
'testFailureExitCode',
|
|
471
|
+
'testNamePattern',
|
|
472
|
+
'testResultsProcessor',
|
|
473
|
+
'testRunner',
|
|
474
|
+
'testSequencer',
|
|
475
|
+
'testURL',
|
|
476
|
+
'timers',
|
|
477
|
+
'transform',
|
|
478
|
+
// ARRAY ARGS
|
|
479
|
+
'collectCoverageOnlyFrom',
|
|
480
|
+
'coveragePathIgnorePatterns',
|
|
481
|
+
'coverageReporters',
|
|
482
|
+
'moduleDirectories',
|
|
483
|
+
'moduleFileExtensions',
|
|
484
|
+
'modulePathIgnorePatterns',
|
|
485
|
+
'modulePaths',
|
|
486
|
+
'projects',
|
|
487
|
+
'reporters',
|
|
488
|
+
'roots',
|
|
489
|
+
'selectProjects',
|
|
490
|
+
'setupFiles',
|
|
491
|
+
'setupFilesAfterEnv',
|
|
492
|
+
'snapshotSerializers',
|
|
493
|
+
'testMatch',
|
|
494
|
+
'testPathIgnorePatterns',
|
|
495
|
+
'testPathPattern',
|
|
496
|
+
'testRegex',
|
|
497
|
+
'transformIgnorePatterns',
|
|
498
|
+
'unmockedModulePathPatterns',
|
|
499
|
+
'watchPathIgnorePatterns',
|
|
500
|
+
];
|
|
501
|
+
/**
|
|
502
|
+
* All the CLI arguments which may have string or number values
|
|
503
|
+
*
|
|
504
|
+
* `maxWorkers` is an argument which is used both by Rindo _and_ by Jest,
|
|
505
|
+
* which means that we need to support parsing both string and number values.
|
|
506
|
+
*/
|
|
507
|
+
const STRING_NUMBER_CLI_ARGS = ['maxWorkers'];
|
|
508
|
+
/**
|
|
509
|
+
* All the LogLevel-type options supported by the Rindo CLI
|
|
510
|
+
*
|
|
511
|
+
* This is a bit silly since there's only one such argument atm,
|
|
512
|
+
* but this approach lets us make sure that we're handling all
|
|
513
|
+
* our arguments in a type-safe way.
|
|
514
|
+
*/
|
|
515
|
+
const LOG_LEVEL_CLI_ARGS = ['logLevel'];
|
|
516
|
+
/**
|
|
517
|
+
* For a small subset of CLI options we support a short alias e.g. `'h'` for `'help'`
|
|
518
|
+
*/
|
|
519
|
+
const CLI_ARG_ALIASES = {
|
|
520
|
+
config: 'c',
|
|
521
|
+
help: 'h',
|
|
522
|
+
port: 'p',
|
|
523
|
+
version: 'v',
|
|
524
|
+
};
|
|
525
|
+
/**
|
|
526
|
+
* Helper function for initializing a `ConfigFlags` object. Provide any overrides
|
|
527
|
+
* for default values and off you go!
|
|
528
|
+
*
|
|
529
|
+
* @param init an object with any overrides for default values
|
|
530
|
+
* @returns a complete CLI flag object
|
|
531
|
+
*/
|
|
532
|
+
const createConfigFlags = (init = {}) => {
|
|
303
533
|
const flags = {
|
|
304
534
|
task: null,
|
|
305
535
|
args: [],
|
|
306
536
|
knownArgs: [],
|
|
307
|
-
unknownArgs:
|
|
537
|
+
unknownArgs: [],
|
|
538
|
+
...init,
|
|
308
539
|
};
|
|
540
|
+
return flags;
|
|
541
|
+
};
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* Parse command line arguments into a structured `ConfigFlags` object
|
|
545
|
+
*
|
|
546
|
+
* @param args an array of config flags
|
|
547
|
+
* @param sys an optional compiler system
|
|
548
|
+
* @returns a structured ConfigFlags object
|
|
549
|
+
*/
|
|
550
|
+
const parseFlags = (args, sys) => {
|
|
551
|
+
const flags = createConfigFlags();
|
|
309
552
|
// cmd line has more priority over npm scripts cmd
|
|
310
|
-
flags.args = args.slice();
|
|
553
|
+
flags.args = Array.isArray(args) ? args.slice() : [];
|
|
311
554
|
if (flags.args.length > 0 && flags.args[0] && !flags.args[0].startsWith('-')) {
|
|
312
555
|
flags.task = flags.args[0];
|
|
313
556
|
}
|
|
314
|
-
parseArgs(flags, flags.args
|
|
557
|
+
parseArgs(flags, flags.args);
|
|
315
558
|
if (sys && sys.name === 'node') {
|
|
316
559
|
const envArgs = getNpmConfigEnvArgs(sys);
|
|
317
|
-
parseArgs(flags, envArgs
|
|
560
|
+
parseArgs(flags, envArgs);
|
|
318
561
|
envArgs.forEach((envArg) => {
|
|
319
562
|
if (!flags.args.includes(envArg)) {
|
|
320
563
|
flags.args.push(envArg);
|
|
@@ -333,185 +576,230 @@ const parseFlags = (args, sys) => {
|
|
|
333
576
|
return flags;
|
|
334
577
|
};
|
|
335
578
|
/**
|
|
336
|
-
* Parse command line arguments that are
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
579
|
+
* Parse command line arguments that are enumerated in the `config-flags`
|
|
580
|
+
* module. Handles leading dashes on arguments, aliases that are defined for a
|
|
581
|
+
* small number of arguments, and parsing values for non-boolean arguments
|
|
582
|
+
* (e.g. port number for the dev server).
|
|
340
583
|
*
|
|
341
|
-
* @param flags
|
|
342
|
-
* @param args
|
|
343
|
-
* @param knownArgs an array to which all recognized, legal arguments are added
|
|
584
|
+
* @param flags a ConfigFlags object to which parsed arguments will be added
|
|
585
|
+
* @param args an array of command-line arguments to parse
|
|
344
586
|
*/
|
|
345
|
-
const parseArgs = (flags, args
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
587
|
+
const parseArgs = (flags, args) => {
|
|
588
|
+
BOOLEAN_CLI_ARGS.forEach((argName) => parseBooleanArg(flags, args, argName));
|
|
589
|
+
STRING_CLI_ARGS.forEach((argName) => parseStringArg(flags, args, argName));
|
|
590
|
+
NUMBER_CLI_ARGS.forEach((argName) => parseNumberArg(flags, args, argName));
|
|
591
|
+
STRING_NUMBER_CLI_ARGS.forEach((argName) => parseStringNumberArg(flags, args, argName));
|
|
592
|
+
LOG_LEVEL_CLI_ARGS.forEach((argName) => parseLogLevelArg(flags, args, argName));
|
|
593
|
+
};
|
|
594
|
+
/**
|
|
595
|
+
* Parse a boolean CLI argument. For these, we support the following formats:
|
|
596
|
+
*
|
|
597
|
+
* - `--booleanArg`
|
|
598
|
+
* - `--boolean-arg`
|
|
599
|
+
* - `--noBooleanArg`
|
|
600
|
+
* - `--no-boolean-arg`
|
|
601
|
+
*
|
|
602
|
+
* The final two variants should be parsed to a value of `false` on the config
|
|
603
|
+
* object.
|
|
604
|
+
*
|
|
605
|
+
* @param flags the config flags object, while we'll modify
|
|
606
|
+
* @param args our CLI arguments
|
|
607
|
+
* @param configCaseName the argument we want to look at right now
|
|
608
|
+
*/
|
|
609
|
+
const parseBooleanArg = (flags, args, configCaseName) => {
|
|
610
|
+
// we support both dash-case and PascalCase versions of the parameter
|
|
611
|
+
// argName is 'configCase' version which can be found in BOOLEAN_ARG_OPTS
|
|
612
|
+
const alias = CLI_ARG_ALIASES[configCaseName];
|
|
613
|
+
const dashCaseName = toDashCase(configCaseName);
|
|
614
|
+
if (typeof flags[configCaseName] !== 'boolean') {
|
|
615
|
+
flags[configCaseName] = null;
|
|
616
|
+
}
|
|
617
|
+
args.forEach((cmdArg) => {
|
|
618
|
+
let value;
|
|
619
|
+
if (cmdArg === `--${configCaseName}` || cmdArg === `--${dashCaseName}`) {
|
|
620
|
+
value = true;
|
|
351
621
|
}
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
flags[flagKey] = true;
|
|
355
|
-
knownArgs.push(cmdArg);
|
|
356
|
-
}
|
|
357
|
-
else if (cmdArg === `--${flagKey}`) {
|
|
358
|
-
flags[flagKey] = true;
|
|
359
|
-
knownArgs.push(cmdArg);
|
|
360
|
-
}
|
|
361
|
-
else if (cmdArg === `--no-${booleanName}`) {
|
|
362
|
-
flags[flagKey] = false;
|
|
363
|
-
knownArgs.push(cmdArg);
|
|
364
|
-
}
|
|
365
|
-
else if (cmdArg === `--no${dashToPascalCase(booleanName)}`) {
|
|
366
|
-
flags[flagKey] = false;
|
|
367
|
-
knownArgs.push(cmdArg);
|
|
368
|
-
}
|
|
369
|
-
else if (alias && cmdArg === `-${alias}`) {
|
|
370
|
-
flags[flagKey] = true;
|
|
371
|
-
knownArgs.push(cmdArg);
|
|
372
|
-
}
|
|
373
|
-
});
|
|
374
|
-
});
|
|
375
|
-
STRING_ARG_OPTS.forEach((stringName) => {
|
|
376
|
-
const alias = ARG_OPTS_ALIASES[stringName];
|
|
377
|
-
const flagKey = configCase(stringName);
|
|
378
|
-
if (typeof flags[flagKey] !== 'string') {
|
|
379
|
-
flags[flagKey] = null;
|
|
622
|
+
else if (cmdArg === `--no-${dashCaseName}` || cmdArg === `--no${dashToPascalCase(dashCaseName)}`) {
|
|
623
|
+
value = false;
|
|
380
624
|
}
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
knownArgs.push(cmdArg);
|
|
388
|
-
}
|
|
389
|
-
else if (cmdArg === `--${stringName}`) {
|
|
390
|
-
flags[flagKey] = args[i + 1];
|
|
391
|
-
knownArgs.push(cmdArg);
|
|
392
|
-
knownArgs.push(args[i + 1]);
|
|
393
|
-
}
|
|
394
|
-
else if (cmdArg === `--${flagKey}`) {
|
|
395
|
-
flags[flagKey] = args[i + 1];
|
|
396
|
-
knownArgs.push(cmdArg);
|
|
397
|
-
knownArgs.push(args[i + 1]);
|
|
398
|
-
}
|
|
399
|
-
else if (cmdArg.startsWith(`--${flagKey}=`)) {
|
|
400
|
-
const values = cmdArg.split('=');
|
|
401
|
-
values.shift();
|
|
402
|
-
flags[flagKey] = values.join('=');
|
|
403
|
-
knownArgs.push(cmdArg);
|
|
404
|
-
}
|
|
405
|
-
else if (alias) {
|
|
406
|
-
if (cmdArg.startsWith(`-${alias}=`)) {
|
|
407
|
-
const values = cmdArg.split('=');
|
|
408
|
-
values.shift();
|
|
409
|
-
flags[flagKey] = values.join('=');
|
|
410
|
-
knownArgs.push(cmdArg);
|
|
411
|
-
}
|
|
412
|
-
else if (cmdArg === `-${alias}`) {
|
|
413
|
-
flags[flagKey] = args[i + 1];
|
|
414
|
-
knownArgs.push(args[i + 1]);
|
|
415
|
-
}
|
|
416
|
-
}
|
|
625
|
+
else if (alias && cmdArg === `-${alias}`) {
|
|
626
|
+
value = true;
|
|
627
|
+
}
|
|
628
|
+
if (value !== undefined && cmdArg !== undefined) {
|
|
629
|
+
flags[configCaseName] = value;
|
|
630
|
+
flags.knownArgs.push(cmdArg);
|
|
417
631
|
}
|
|
418
632
|
});
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
633
|
+
};
|
|
634
|
+
/**
|
|
635
|
+
* Parse a string CLI argument
|
|
636
|
+
*
|
|
637
|
+
* @param flags the config flags object, while we'll modify
|
|
638
|
+
* @param args our CLI arguments
|
|
639
|
+
* @param configCaseName the argument we want to look at right now
|
|
640
|
+
*/
|
|
641
|
+
const parseStringArg = (flags, args, configCaseName) => {
|
|
642
|
+
if (typeof flags[configCaseName] !== 'string') {
|
|
643
|
+
flags[configCaseName] = null;
|
|
644
|
+
}
|
|
645
|
+
const { value, matchingArg } = getValue(args, configCaseName);
|
|
646
|
+
if (value !== undefined && matchingArg !== undefined) {
|
|
647
|
+
flags[configCaseName] = value;
|
|
648
|
+
flags.knownArgs.push(matchingArg);
|
|
649
|
+
flags.knownArgs.push(value);
|
|
650
|
+
}
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* Parse a number CLI argument
|
|
654
|
+
*
|
|
655
|
+
* @param flags the config flags object, while we'll modify
|
|
656
|
+
* @param args our CLI arguments
|
|
657
|
+
* @param configCaseName the argument we want to look at right now
|
|
658
|
+
*/
|
|
659
|
+
const parseNumberArg = (flags, args, configCaseName) => {
|
|
660
|
+
if (typeof flags[configCaseName] !== 'number') {
|
|
661
|
+
flags[configCaseName] = null;
|
|
662
|
+
}
|
|
663
|
+
const { value, matchingArg } = getValue(args, configCaseName);
|
|
664
|
+
if (value !== undefined && matchingArg !== undefined) {
|
|
665
|
+
flags[configCaseName] = parseInt(value, 10);
|
|
666
|
+
flags.knownArgs.push(matchingArg);
|
|
667
|
+
flags.knownArgs.push(value);
|
|
668
|
+
}
|
|
669
|
+
};
|
|
670
|
+
/**
|
|
671
|
+
* Parse a CLI argument which may be either a string or a number
|
|
672
|
+
*
|
|
673
|
+
* @param flags the config flags object, while we'll modify
|
|
674
|
+
* @param args our CLI arguments
|
|
675
|
+
* @param configCaseName the argument we want to look at right now
|
|
676
|
+
*/
|
|
677
|
+
const parseStringNumberArg = (flags, args, configCaseName) => {
|
|
678
|
+
if (!['number', 'string'].includes(typeof flags[configCaseName])) {
|
|
679
|
+
flags[configCaseName] = null;
|
|
680
|
+
}
|
|
681
|
+
const { value, matchingArg } = getValue(args, configCaseName);
|
|
682
|
+
if (value !== undefined && matchingArg !== undefined) {
|
|
683
|
+
if (CLI_ARG_STRING_REGEX.test(value)) {
|
|
684
|
+
// if it matches the regex we treat it like a string
|
|
685
|
+
flags[configCaseName] = value;
|
|
424
686
|
}
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
687
|
+
else {
|
|
688
|
+
// it was a number, great!
|
|
689
|
+
flags[configCaseName] = Number(value);
|
|
690
|
+
}
|
|
691
|
+
flags.knownArgs.push(matchingArg);
|
|
692
|
+
flags.knownArgs.push(value);
|
|
693
|
+
}
|
|
694
|
+
};
|
|
695
|
+
/**
|
|
696
|
+
* We use this regular expression to detect CLI parameters which
|
|
697
|
+
* should be parsed as string values (as opposed to numbers) for
|
|
698
|
+
* the argument types for which we support both a string and a
|
|
699
|
+
* number value.
|
|
700
|
+
*
|
|
701
|
+
* The regex tests for the presence of at least one character which is
|
|
702
|
+
* _not_ a digit (`\d`), a period (`\.`), or one of the characters `"e"`,
|
|
703
|
+
* `"E"`, `"+"`, or `"-"` (the latter four characters are necessary to
|
|
704
|
+
* support the admittedly unlikely use of scientific notation, like `"4e+0"`
|
|
705
|
+
* for `4`).
|
|
706
|
+
*
|
|
707
|
+
* Thus we'll match a string like `"50%"`, but not a string like `"50"` or
|
|
708
|
+
* `"5.0"`. If it matches a given string we conclude that the string should
|
|
709
|
+
* be parsed as a string literal, rather than using `Number` to convert it
|
|
710
|
+
* to a number.
|
|
711
|
+
*/
|
|
712
|
+
const CLI_ARG_STRING_REGEX = /[^\d\.Ee\+\-]+/g;
|
|
713
|
+
/**
|
|
714
|
+
* Parse a LogLevel CLI argument. These can be only a specific
|
|
715
|
+
* set of strings, so this function takes care of validating that
|
|
716
|
+
* the value is correct.
|
|
717
|
+
*
|
|
718
|
+
* @param flags the config flags object, while we'll modify
|
|
719
|
+
* @param args our CLI arguments
|
|
720
|
+
* @param configCaseName the argument we want to look at right now
|
|
721
|
+
*/
|
|
722
|
+
const parseLogLevelArg = (flags, args, configCaseName) => {
|
|
723
|
+
if (typeof flags[configCaseName] !== 'string') {
|
|
724
|
+
flags[configCaseName] = null;
|
|
725
|
+
}
|
|
726
|
+
const { value, matchingArg } = getValue(args, configCaseName);
|
|
727
|
+
if (value !== undefined && matchingArg !== undefined && isLogLevel(value)) {
|
|
728
|
+
flags[configCaseName] = value;
|
|
729
|
+
flags.knownArgs.push(matchingArg);
|
|
730
|
+
flags.knownArgs.push(value);
|
|
731
|
+
}
|
|
732
|
+
};
|
|
733
|
+
/**
|
|
734
|
+
* Helper for pulling values out from the raw array of CLI arguments. This logic
|
|
735
|
+
* is shared between a few different types of CLI args.
|
|
736
|
+
*
|
|
737
|
+
* We look for arguments in the following formats:
|
|
738
|
+
*
|
|
739
|
+
* - `--my-cli-argument value`
|
|
740
|
+
* - `--my-cli-argument=value`
|
|
741
|
+
* - `--myCliArgument value`
|
|
742
|
+
* - `--myCliArgument=value`
|
|
743
|
+
*
|
|
744
|
+
* We also check for shortened aliases, which we define for a few arguments.
|
|
745
|
+
*
|
|
746
|
+
* @param args the CLI args we're dealing with
|
|
747
|
+
* @param configCaseName the ConfigFlag key which we're looking to pull out a value for
|
|
748
|
+
* @returns the value for the flag as well as the exact string which it matched from
|
|
749
|
+
* the user input.
|
|
750
|
+
*/
|
|
751
|
+
const getValue = (args, configCaseName) => {
|
|
752
|
+
// for some CLI args we have a short alias, like 'c' for 'config'
|
|
753
|
+
const alias = CLI_ARG_ALIASES[configCaseName];
|
|
754
|
+
// we support supplying arguments in both dash-case and configCase
|
|
755
|
+
// for ease of use
|
|
756
|
+
const dashCaseName = toDashCase(configCaseName);
|
|
757
|
+
let value;
|
|
758
|
+
let matchingArg;
|
|
759
|
+
args.forEach((arg, i) => {
|
|
760
|
+
if (arg.startsWith(`--${dashCaseName}=`) || arg.startsWith(`--${configCaseName}=`)) {
|
|
761
|
+
value = getEqualsValue(arg);
|
|
762
|
+
matchingArg = arg;
|
|
763
|
+
}
|
|
764
|
+
else if (arg === `--${dashCaseName}` || arg === `--${configCaseName}`) {
|
|
765
|
+
value = args[i + 1];
|
|
766
|
+
matchingArg = arg;
|
|
767
|
+
}
|
|
768
|
+
else if (alias) {
|
|
769
|
+
if (arg.startsWith(`-${alias}=`)) {
|
|
770
|
+
value = getEqualsValue(arg);
|
|
771
|
+
matchingArg = arg;
|
|
446
772
|
}
|
|
447
|
-
else if (alias) {
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
values.shift();
|
|
451
|
-
flags[flagKey] = parseInt(values.join(''), 10);
|
|
452
|
-
knownArgs.push(cmdArg);
|
|
453
|
-
}
|
|
454
|
-
else if (cmdArg === `-${alias}`) {
|
|
455
|
-
flags[flagKey] = parseInt(args[i + 1], 10);
|
|
456
|
-
knownArgs.push(args[i + 1]);
|
|
457
|
-
}
|
|
773
|
+
else if (arg === `-${alias}`) {
|
|
774
|
+
value = args[i + 1];
|
|
775
|
+
matchingArg = arg;
|
|
458
776
|
}
|
|
459
777
|
}
|
|
460
778
|
});
|
|
779
|
+
return { value, matchingArg };
|
|
461
780
|
};
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
'prerender-external',
|
|
485
|
-
'prod',
|
|
486
|
-
'profile',
|
|
487
|
-
'service-worker',
|
|
488
|
-
'screenshot',
|
|
489
|
-
'serve',
|
|
490
|
-
'skip-node-check',
|
|
491
|
-
'spec',
|
|
492
|
-
'ssr',
|
|
493
|
-
'stats',
|
|
494
|
-
'update-screenshot',
|
|
495
|
-
'verbose',
|
|
496
|
-
'version',
|
|
497
|
-
'watch',
|
|
498
|
-
];
|
|
499
|
-
const NUMBER_ARG_OPTS = ['max-workers', 'port'];
|
|
500
|
-
const STRING_ARG_OPTS = [
|
|
501
|
-
'address',
|
|
502
|
-
'config',
|
|
503
|
-
'docs-json',
|
|
504
|
-
'emulate',
|
|
505
|
-
'log-level',
|
|
506
|
-
'root',
|
|
507
|
-
'screenshot-connector',
|
|
508
|
-
];
|
|
509
|
-
const ARG_OPTS_ALIASES = {
|
|
510
|
-
config: 'c',
|
|
511
|
-
help: 'h',
|
|
512
|
-
port: 'p',
|
|
513
|
-
version: 'v',
|
|
514
|
-
};
|
|
781
|
+
/**
|
|
782
|
+
* When a parameter is set in the format `--foobar=12` at the CLI (as opposed to
|
|
783
|
+
* `--foobar 12`) we want to get the value after the `=` sign
|
|
784
|
+
*
|
|
785
|
+
* @param commandArgument the arg in question
|
|
786
|
+
* @returns the value after the `=`
|
|
787
|
+
*/
|
|
788
|
+
const getEqualsValue = (commandArgument) => commandArgument.split('=').slice(1).join('=');
|
|
789
|
+
/**
|
|
790
|
+
* Small helper for getting type-system-level assurance that a `string` can be
|
|
791
|
+
* narrowed to a `LogLevel`
|
|
792
|
+
*
|
|
793
|
+
* @param maybeLogLevel the string to check
|
|
794
|
+
* @returns whether this is a `LogLevel`
|
|
795
|
+
*/
|
|
796
|
+
const isLogLevel = (maybeLogLevel) =>
|
|
797
|
+
// unfortunately `includes` is typed on `ReadonlyArray<T>` as `(el: T):
|
|
798
|
+
// boolean` so a `string` cannot be passed to `includes` on a
|
|
799
|
+
// `ReadonlyArray` 😢 thus we `as any`
|
|
800
|
+
//
|
|
801
|
+
// see microsoft/TypeScript#31018 for some discussion of this
|
|
802
|
+
LOG_LEVELS.includes(maybeLogLevel);
|
|
515
803
|
const getNpmConfigEnvArgs = (sys) => {
|
|
516
804
|
// process.env.npm_config_argv
|
|
517
805
|
// {"remain":["4444"],"cooked":["run","serve","--port","4444"],"original":["run","serve","--port","4444"]}
|
|
@@ -532,7 +820,7 @@ const getNpmConfigEnvArgs = (sys) => {
|
|
|
532
820
|
const dependencies = [
|
|
533
821
|
{
|
|
534
822
|
name: "@rindo/core",
|
|
535
|
-
version: "2.17.0",
|
|
823
|
+
version: "2.17.2-0",
|
|
536
824
|
main: "compiler/rindo.js",
|
|
537
825
|
resources: [
|
|
538
826
|
"package.json",
|
|
@@ -857,16 +1145,16 @@ const tryFn = async (fn, ...args) => {
|
|
|
857
1145
|
}
|
|
858
1146
|
return null;
|
|
859
1147
|
};
|
|
860
|
-
const isInteractive = (sys,
|
|
861
|
-
var _a;
|
|
1148
|
+
const isInteractive = (sys, flags, object) => {
|
|
862
1149
|
const terminalInfo = object ||
|
|
863
1150
|
Object.freeze({
|
|
864
1151
|
tty: sys.isTTY() ? true : false,
|
|
865
|
-
ci: ['CI', 'BUILD_ID', 'BUILD_NUMBER', 'BITBUCKET_COMMIT', 'CODEBUILD_BUILD_ARN'].filter((v) => !!sys.getEnvironmentVar(v)).length > 0 || !!
|
|
1152
|
+
ci: ['CI', 'BUILD_ID', 'BUILD_NUMBER', 'BITBUCKET_COMMIT', 'CODEBUILD_BUILD_ARN'].filter((v) => !!sys.getEnvironmentVar(v)).length > 0 || !!flags.ci,
|
|
866
1153
|
});
|
|
867
1154
|
return terminalInfo.tty && !terminalInfo.ci;
|
|
868
1155
|
};
|
|
869
1156
|
const UUID_REGEX = new RegExp(/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i);
|
|
1157
|
+
// Plucked from https://github.com/navify/jigra/blob/HEAD/cli/src/util/uuid.ts
|
|
870
1158
|
function uuidv4() {
|
|
871
1159
|
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
|
|
872
1160
|
const r = (Math.random() * 16) | 0;
|
|
@@ -886,19 +1174,19 @@ async function readJson(sys, path) {
|
|
|
886
1174
|
}
|
|
887
1175
|
/**
|
|
888
1176
|
* Does the command have the debug flag?
|
|
889
|
-
* @param
|
|
1177
|
+
* @param flags The configuration flags passed into the Rindo command
|
|
890
1178
|
* @returns true if --debug has been passed, otherwise false
|
|
891
1179
|
*/
|
|
892
|
-
function hasDebug(
|
|
893
|
-
return
|
|
1180
|
+
function hasDebug(flags) {
|
|
1181
|
+
return flags.debug;
|
|
894
1182
|
}
|
|
895
1183
|
/**
|
|
896
1184
|
* Does the command have the verbose and debug flags?
|
|
897
|
-
* @param
|
|
1185
|
+
* @param flags The configuration flags passed into the Rindo command
|
|
898
1186
|
* @returns true if both --debug and --verbose have been passed, otherwise false
|
|
899
1187
|
*/
|
|
900
|
-
function hasVerbose(
|
|
901
|
-
return
|
|
1188
|
+
function hasVerbose(flags) {
|
|
1189
|
+
return flags.verbose && hasDebug(flags);
|
|
902
1190
|
}
|
|
903
1191
|
|
|
904
1192
|
/**
|
|
@@ -909,7 +1197,7 @@ function hasVerbose(config) {
|
|
|
909
1197
|
* @returns true if telemetry should be sent, false otherwise
|
|
910
1198
|
*/
|
|
911
1199
|
async function shouldTrack(config, sys, ci) {
|
|
912
|
-
return !ci && isInteractive(sys, config) && (await checkTelemetry(sys));
|
|
1200
|
+
return !ci && isInteractive(sys, config.flags) && (await checkTelemetry(sys));
|
|
913
1201
|
}
|
|
914
1202
|
|
|
915
1203
|
const isTest$1 = () => process.env.JEST_WORKER_ID !== undefined;
|
|
@@ -980,11 +1268,10 @@ const WWW = 'www';
|
|
|
980
1268
|
*
|
|
981
1269
|
* @param sys The system where the command is invoked
|
|
982
1270
|
* @param config The config passed into the Rindo command
|
|
983
|
-
* @param logger The tool used to do logging
|
|
984
1271
|
* @param coreCompiler The compiler used to do builds
|
|
985
1272
|
* @param result The results of a compiler build.
|
|
986
1273
|
*/
|
|
987
|
-
async function telemetryBuildFinishedAction(sys, config,
|
|
1274
|
+
async function telemetryBuildFinishedAction(sys, config, coreCompiler, result) {
|
|
988
1275
|
const tracking = await shouldTrack(config, sys, config.flags.ci);
|
|
989
1276
|
if (!tracking) {
|
|
990
1277
|
return;
|
|
@@ -992,21 +1279,19 @@ async function telemetryBuildFinishedAction(sys, config, logger, coreCompiler, r
|
|
|
992
1279
|
const component_count = Object.keys(result.componentGraph).length;
|
|
993
1280
|
const data = await prepareData(coreCompiler, config, sys, result.duration, component_count);
|
|
994
1281
|
await sendMetric(sys, config, 'rindo_cli_command', data);
|
|
995
|
-
logger.debug(`${logger.blue('Telemetry')}: ${logger.gray(JSON.stringify(data))}`);
|
|
1282
|
+
config.logger.debug(`${config.logger.blue('Telemetry')}: ${config.logger.gray(JSON.stringify(data))}`);
|
|
996
1283
|
}
|
|
997
1284
|
/**
|
|
998
1285
|
* A function to wrap a compiler task function around. Will send telemetry if, and only if, the machine allows.
|
|
999
1286
|
*
|
|
1000
1287
|
* @param sys The system where the command is invoked
|
|
1001
1288
|
* @param config The config passed into the Rindo command
|
|
1002
|
-
* @param logger The tool used to do logging
|
|
1003
1289
|
* @param coreCompiler The compiler used to do builds
|
|
1004
1290
|
* @param action A Promise-based function to call in order to get the duration of any given command.
|
|
1005
1291
|
* @returns void
|
|
1006
1292
|
*/
|
|
1007
|
-
async function telemetryAction(sys, config,
|
|
1008
|
-
|
|
1009
|
-
const tracking = await shouldTrack(config, sys, !!((_a = config === null || config === void 0 ? void 0 : config.flags) === null || _a === void 0 ? void 0 : _a.ci));
|
|
1293
|
+
async function telemetryAction(sys, config, coreCompiler, action) {
|
|
1294
|
+
const tracking = await shouldTrack(config, sys, !!config.flags.ci);
|
|
1010
1295
|
let duration = undefined;
|
|
1011
1296
|
let error;
|
|
1012
1297
|
if (action) {
|
|
@@ -1026,7 +1311,7 @@ async function telemetryAction(sys, config, logger, coreCompiler, action) {
|
|
|
1026
1311
|
}
|
|
1027
1312
|
const data = await prepareData(coreCompiler, config, sys, duration);
|
|
1028
1313
|
await sendMetric(sys, config, 'rindo_cli_command', data);
|
|
1029
|
-
logger.debug(`${logger.blue('Telemetry')}: ${logger.gray(JSON.stringify(data))}`);
|
|
1314
|
+
config.logger.debug(`${config.logger.blue('Telemetry')}: ${config.logger.gray(JSON.stringify(data))}`);
|
|
1030
1315
|
if (error) {
|
|
1031
1316
|
throw error;
|
|
1032
1317
|
}
|
|
@@ -1194,7 +1479,7 @@ async function getInstalledPackages(sys, config) {
|
|
|
1194
1479
|
return { packages, packagesNoVersions };
|
|
1195
1480
|
}
|
|
1196
1481
|
catch (err) {
|
|
1197
|
-
hasDebug(config) && console.error(err);
|
|
1482
|
+
hasDebug(config.flags) && console.error(err);
|
|
1198
1483
|
return { packages, packagesNoVersions };
|
|
1199
1484
|
}
|
|
1200
1485
|
}
|
|
@@ -1296,15 +1581,15 @@ async function sendTelemetry(sys, config, data) {
|
|
|
1296
1581
|
},
|
|
1297
1582
|
body: JSON.stringify(body),
|
|
1298
1583
|
});
|
|
1299
|
-
hasVerbose(config) &&
|
|
1584
|
+
hasVerbose(config.flags) &&
|
|
1300
1585
|
console.debug('\nSent %O metric to events service (status: %O)', data.name, response.status, '\n');
|
|
1301
1586
|
if (response.status !== 204) {
|
|
1302
|
-
hasVerbose(config) &&
|
|
1587
|
+
hasVerbose(config.flags) &&
|
|
1303
1588
|
console.debug('\nBad response from events service. Request body: %O', response.body.toString(), '\n');
|
|
1304
1589
|
}
|
|
1305
1590
|
}
|
|
1306
1591
|
catch (e) {
|
|
1307
|
-
hasVerbose(config) && console.debug('Telemetry request failed:', e);
|
|
1592
|
+
hasVerbose(config.flags) && console.debug('Telemetry request failed:', e);
|
|
1308
1593
|
}
|
|
1309
1594
|
}
|
|
1310
1595
|
/**
|
|
@@ -1361,7 +1646,7 @@ const taskBuild = async (coreCompiler, config, sys) => {
|
|
|
1361
1646
|
const results = await compiler.build();
|
|
1362
1647
|
// TODO: make this parameter no longer optional, remove the surrounding if statement
|
|
1363
1648
|
if (sys) {
|
|
1364
|
-
await telemetryBuildFinishedAction(sys, config,
|
|
1649
|
+
await telemetryBuildFinishedAction(sys, config, coreCompiler, results);
|
|
1365
1650
|
}
|
|
1366
1651
|
await compiler.destroy();
|
|
1367
1652
|
if (results.hasError) {
|
|
@@ -1399,7 +1684,8 @@ const IS_NODE_ENV = typeof global !== 'undefined' &&
|
|
|
1399
1684
|
typeof require === 'function' &&
|
|
1400
1685
|
!!global.process &&
|
|
1401
1686
|
typeof __filename === 'string' &&
|
|
1402
|
-
(!global.origin || typeof global.origin !== 'string');
|
|
1687
|
+
(!global.origin || typeof global.origin !== 'string');
|
|
1688
|
+
const IS_BROWSER_ENV = typeof location !== 'undefined' && typeof navigator !== 'undefined' && typeof XMLHttpRequest !== 'undefined';
|
|
1403
1689
|
|
|
1404
1690
|
/**
|
|
1405
1691
|
* Task to generate component boilerplate and write it to disk. This task can
|
|
@@ -1593,7 +1879,8 @@ export class ${toPascalCase(tagName)} {
|
|
|
1593
1879
|
`;
|
|
1594
1880
|
};
|
|
1595
1881
|
/**
|
|
1596
|
-
* Get the boilerplate for style
|
|
1882
|
+
* Get the boilerplate for style for a generated component
|
|
1883
|
+
* @returns a boilerplate CSS block
|
|
1597
1884
|
*/
|
|
1598
1885
|
const getStyleUrlBoilerplate = () => `:host {
|
|
1599
1886
|
display: block;
|
|
@@ -1647,10 +1934,17 @@ describe('${tagName}', () => {
|
|
|
1647
1934
|
*/
|
|
1648
1935
|
const toPascalCase = (str) => str.split('-').reduce((res, part) => res + part[0].toUpperCase() + part.slice(1), '');
|
|
1649
1936
|
|
|
1650
|
-
|
|
1937
|
+
/**
|
|
1938
|
+
* Entrypoint for the Telemetry task
|
|
1939
|
+
* @param flags configuration flags provided to Rindo when a task was called (either this task or a task that invokes
|
|
1940
|
+
* telemetry)
|
|
1941
|
+
* @param sys the abstraction for interfacing with the operating system
|
|
1942
|
+
* @param logger a logging implementation to log the results out to the user
|
|
1943
|
+
*/
|
|
1944
|
+
const taskTelemetry = async (flags, sys, logger) => {
|
|
1651
1945
|
const prompt = logger.dim(sys.details.platform === 'windows' ? '>' : '$');
|
|
1652
|
-
const isEnabling =
|
|
1653
|
-
const isDisabling =
|
|
1946
|
+
const isEnabling = flags.args.includes('on');
|
|
1947
|
+
const isDisabling = flags.args.includes('off');
|
|
1654
1948
|
const INFORMATION = `Opt in or our of telemetry. Information about the data we collect is available on our website: ${logger.bold('https://rindojs.web.app/telemetry')}`;
|
|
1655
1949
|
const THANK_YOU = `Thank you for helping to make Rindo better! 💖`;
|
|
1656
1950
|
const ENABLED_MESSAGE = `${logger.green('Enabled')}. ${THANK_YOU}\n\n`;
|
|
@@ -1679,7 +1973,14 @@ const taskTelemetry = async (config, sys, logger) => {
|
|
|
1679
1973
|
`);
|
|
1680
1974
|
};
|
|
1681
1975
|
|
|
1682
|
-
|
|
1976
|
+
/**
|
|
1977
|
+
* Entrypoint for the Help task, providing Rindo usage context to the user
|
|
1978
|
+
* @param flags configuration flags provided to Rindo when a task was call (either this task or a task that invokes
|
|
1979
|
+
* telemetry)
|
|
1980
|
+
* @param logger a logging implementation to log the results out to the user
|
|
1981
|
+
* @param sys the abstraction for interfacing with the operating system
|
|
1982
|
+
*/
|
|
1983
|
+
const taskHelp = async (flags, logger, sys) => {
|
|
1683
1984
|
const prompt = logger.dim(sys.details.platform === 'windows' ? '>' : '$');
|
|
1684
1985
|
console.log(`
|
|
1685
1986
|
${logger.bold('Build:')} ${logger.dim('Build components for development or production.')}
|
|
@@ -1712,7 +2013,7 @@ const taskHelp = async (config, logger, sys) => {
|
|
|
1712
2013
|
`);
|
|
1713
2014
|
// TODO: make this parameter no longer optional, remove the surrounding if statement
|
|
1714
2015
|
if (sys) {
|
|
1715
|
-
await taskTelemetry(
|
|
2016
|
+
await taskTelemetry(flags, sys, logger);
|
|
1716
2017
|
}
|
|
1717
2018
|
console.log(`
|
|
1718
2019
|
${logger.bold('Examples:')}
|
|
@@ -1769,6 +2070,95 @@ const taskServe = async (config) => {
|
|
|
1769
2070
|
});
|
|
1770
2071
|
};
|
|
1771
2072
|
|
|
2073
|
+
/**
|
|
2074
|
+
* Creates an instance of a logger
|
|
2075
|
+
* @returns the new logger instance
|
|
2076
|
+
*/
|
|
2077
|
+
const createLogger = () => {
|
|
2078
|
+
let useColors = IS_BROWSER_ENV;
|
|
2079
|
+
let level = 'info';
|
|
2080
|
+
return {
|
|
2081
|
+
enableColors: (uc) => (useColors = uc),
|
|
2082
|
+
getLevel: () => level,
|
|
2083
|
+
setLevel: (l) => (level = l),
|
|
2084
|
+
emoji: (e) => e,
|
|
2085
|
+
info: console.log.bind(console),
|
|
2086
|
+
warn: console.warn.bind(console),
|
|
2087
|
+
error: console.error.bind(console),
|
|
2088
|
+
debug: console.debug.bind(console),
|
|
2089
|
+
red: (msg) => msg,
|
|
2090
|
+
green: (msg) => msg,
|
|
2091
|
+
yellow: (msg) => msg,
|
|
2092
|
+
blue: (msg) => msg,
|
|
2093
|
+
magenta: (msg) => msg,
|
|
2094
|
+
cyan: (msg) => msg,
|
|
2095
|
+
gray: (msg) => msg,
|
|
2096
|
+
bold: (msg) => msg,
|
|
2097
|
+
dim: (msg) => msg,
|
|
2098
|
+
bgRed: (msg) => msg,
|
|
2099
|
+
createTimeSpan: (_startMsg, _debug = false) => ({
|
|
2100
|
+
duration: () => 0,
|
|
2101
|
+
finish: () => 0,
|
|
2102
|
+
}),
|
|
2103
|
+
printDiagnostics(diagnostics) {
|
|
2104
|
+
diagnostics.forEach((diagnostic) => logDiagnostic(diagnostic, useColors));
|
|
2105
|
+
},
|
|
2106
|
+
};
|
|
2107
|
+
};
|
|
2108
|
+
const logDiagnostic = (diagnostic, useColors) => {
|
|
2109
|
+
let color = BLUE;
|
|
2110
|
+
let prefix = 'Build';
|
|
2111
|
+
let msg = '';
|
|
2112
|
+
if (diagnostic.level === 'error') {
|
|
2113
|
+
color = RED;
|
|
2114
|
+
prefix = 'Error';
|
|
2115
|
+
}
|
|
2116
|
+
else if (diagnostic.level === 'warn') {
|
|
2117
|
+
color = YELLOW;
|
|
2118
|
+
prefix = 'Warning';
|
|
2119
|
+
}
|
|
2120
|
+
if (diagnostic.header) {
|
|
2121
|
+
prefix = diagnostic.header;
|
|
2122
|
+
}
|
|
2123
|
+
const filePath = diagnostic.relFilePath || diagnostic.absFilePath;
|
|
2124
|
+
if (filePath) {
|
|
2125
|
+
msg += filePath;
|
|
2126
|
+
if (typeof diagnostic.lineNumber === 'number' && diagnostic.lineNumber > 0) {
|
|
2127
|
+
msg += ', line ' + diagnostic.lineNumber;
|
|
2128
|
+
if (typeof diagnostic.columnNumber === 'number' && diagnostic.columnNumber > 0) {
|
|
2129
|
+
msg += ', column ' + diagnostic.columnNumber;
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
msg += '\n';
|
|
2133
|
+
}
|
|
2134
|
+
msg += diagnostic.messageText;
|
|
2135
|
+
if (diagnostic.lines && diagnostic.lines.length > 0) {
|
|
2136
|
+
diagnostic.lines.forEach((l) => {
|
|
2137
|
+
msg += '\n' + l.lineNumber + ': ' + l.text;
|
|
2138
|
+
});
|
|
2139
|
+
msg += '\n';
|
|
2140
|
+
}
|
|
2141
|
+
if (useColors) {
|
|
2142
|
+
const styledPrefix = [
|
|
2143
|
+
'%c' + prefix,
|
|
2144
|
+
`background: ${color}; color: white; padding: 2px 3px; border-radius: 2px; font-size: 0.8em;`,
|
|
2145
|
+
];
|
|
2146
|
+
console.log(...styledPrefix, msg);
|
|
2147
|
+
}
|
|
2148
|
+
else if (diagnostic.level === 'error') {
|
|
2149
|
+
console.error(msg);
|
|
2150
|
+
}
|
|
2151
|
+
else if (diagnostic.level === 'warn') {
|
|
2152
|
+
console.warn(msg);
|
|
2153
|
+
}
|
|
2154
|
+
else {
|
|
2155
|
+
console.log(msg);
|
|
2156
|
+
}
|
|
2157
|
+
};
|
|
2158
|
+
const YELLOW = `#f39c12`;
|
|
2159
|
+
const RED = `#c0392b`;
|
|
2160
|
+
const BLUE = `#3498db`;
|
|
2161
|
+
|
|
1772
2162
|
const run = async (init) => {
|
|
1773
2163
|
const { args, logger, sys } = init;
|
|
1774
2164
|
try {
|
|
@@ -1784,7 +2174,7 @@ const run = async (init) => {
|
|
|
1784
2174
|
sys.applyGlobalPatch(sys.getCurrentDirectory());
|
|
1785
2175
|
}
|
|
1786
2176
|
if (task === 'help' || flags.help) {
|
|
1787
|
-
await taskHelp({
|
|
2177
|
+
await taskHelp(createConfigFlags({ task: 'help', args }), logger, sys);
|
|
1788
2178
|
return;
|
|
1789
2179
|
}
|
|
1790
2180
|
startupLog(logger, task);
|
|
@@ -1810,7 +2200,7 @@ const run = async (init) => {
|
|
|
1810
2200
|
startupLogVersion(logger, task, coreCompiler);
|
|
1811
2201
|
loadedCompilerLog(sys, logger, flags, coreCompiler);
|
|
1812
2202
|
if (task === 'info') {
|
|
1813
|
-
await telemetryAction(sys, { flags: { task: 'info' },
|
|
2203
|
+
await telemetryAction(sys, { flags: createConfigFlags({ task: 'info' }), logger }, coreCompiler, async () => {
|
|
1814
2204
|
await taskInfo(coreCompiler, sys, logger);
|
|
1815
2205
|
});
|
|
1816
2206
|
return;
|
|
@@ -1833,7 +2223,7 @@ const run = async (init) => {
|
|
|
1833
2223
|
sys.applyGlobalPatch(validated.config.rootDir);
|
|
1834
2224
|
}
|
|
1835
2225
|
await sys.ensureResources({ rootDir: validated.config.rootDir, logger, dependencies: dependencies });
|
|
1836
|
-
await telemetryAction(sys, validated.config,
|
|
2226
|
+
await telemetryAction(sys, validated.config, coreCompiler, async () => {
|
|
1837
2227
|
await runTask(coreCompiler, validated.config, task, sys);
|
|
1838
2228
|
});
|
|
1839
2229
|
}
|
|
@@ -1846,40 +2236,42 @@ const run = async (init) => {
|
|
|
1846
2236
|
}
|
|
1847
2237
|
};
|
|
1848
2238
|
const runTask = async (coreCompiler, config, task, sys) => {
|
|
1849
|
-
|
|
1850
|
-
|
|
2239
|
+
var _a, _b;
|
|
2240
|
+
const logger = (_a = config.logger) !== null && _a !== void 0 ? _a : createLogger();
|
|
2241
|
+
const strictConfig = { ...config, flags: createConfigFlags((_b = config.flags) !== null && _b !== void 0 ? _b : { task }), logger };
|
|
2242
|
+
strictConfig.outputTargets = strictConfig.outputTargets || [];
|
|
1851
2243
|
switch (task) {
|
|
1852
2244
|
case 'build':
|
|
1853
|
-
await taskBuild(coreCompiler,
|
|
2245
|
+
await taskBuild(coreCompiler, strictConfig, sys);
|
|
1854
2246
|
break;
|
|
1855
2247
|
case 'docs':
|
|
1856
|
-
await taskDocs(coreCompiler,
|
|
2248
|
+
await taskDocs(coreCompiler, strictConfig);
|
|
1857
2249
|
break;
|
|
1858
2250
|
case 'generate':
|
|
1859
2251
|
case 'g':
|
|
1860
|
-
await taskGenerate(coreCompiler,
|
|
2252
|
+
await taskGenerate(coreCompiler, strictConfig);
|
|
1861
2253
|
break;
|
|
1862
2254
|
case 'help':
|
|
1863
|
-
await taskHelp(
|
|
2255
|
+
await taskHelp(strictConfig.flags, strictConfig.logger, sys);
|
|
1864
2256
|
break;
|
|
1865
2257
|
case 'prerender':
|
|
1866
|
-
await taskPrerender(coreCompiler,
|
|
2258
|
+
await taskPrerender(coreCompiler, strictConfig);
|
|
1867
2259
|
break;
|
|
1868
2260
|
case 'serve':
|
|
1869
|
-
await taskServe(
|
|
2261
|
+
await taskServe(strictConfig);
|
|
1870
2262
|
break;
|
|
1871
2263
|
case 'telemetry':
|
|
1872
2264
|
// TODO: make this parameter no longer optional, remove the surrounding if statement
|
|
1873
2265
|
if (sys) {
|
|
1874
|
-
await taskTelemetry(
|
|
2266
|
+
await taskTelemetry(strictConfig.flags, sys, strictConfig.logger);
|
|
1875
2267
|
}
|
|
1876
2268
|
break;
|
|
1877
2269
|
case 'version':
|
|
1878
2270
|
console.log(coreCompiler.version);
|
|
1879
2271
|
break;
|
|
1880
2272
|
default:
|
|
1881
|
-
|
|
1882
|
-
await taskHelp(
|
|
2273
|
+
strictConfig.logger.error(`${strictConfig.logger.emoji('❌ ')}Invalid rindo command, please see the options below:`);
|
|
2274
|
+
await taskHelp(strictConfig.flags, strictConfig.logger, sys);
|
|
1883
2275
|
return config.sys.exit(1);
|
|
1884
2276
|
}
|
|
1885
2277
|
};
|