@rindo/core 3.1.0 → 3.2.1

package/cli/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI (CommonJS) v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI (CommonJS) v3.2.1 | MIT Licensed | https://rindojs.web.app
  */
 'use strict';
 
@@ -25,6 +25,34 @@ function _interopNamespace(e) {
     return Object.freeze(n);
 }
 
+/**
+ * Default style mode id
+ */
+/**
+ * Constant for the 'dist-hydrate-script' output target
+ */
+const DIST_HYDRATE_SCRIPT = 'dist-hydrate-script';
+/**
+ * Constant for the 'docs-custom' output target
+ */
+const DOCS_CUSTOM = 'docs-custom';
+/**
+ * Constant for the 'docs-json' output target
+ */
+const DOCS_JSON = 'docs-json';
+/**
+ * Constant for the 'docs-readme' output target
+ */
+const DOCS_README = 'docs-readme';
+/**
+ * Constant for the 'docs-vscode' output target
+ */
+const DOCS_VSCODE = 'docs-vscode';
+/**
+ * Constant for the 'www' output target
+ */
+const WWW = 'www';
+
 /**
  * Convert a string from dash-case / kebab-case to PascalCase (or CamelCase,
  * or whatever you call it!)
@@ -272,6 +300,9 @@ const pathComponents = (path, rootLength) => {
     return [root, ...rest];
 };
 
+const isOutputTargetHydrate = (o) => o.type === DIST_HYDRATE_SCRIPT;
+const isOutputTargetDocs = (o) => o.type === DOCS_README || o.type === DOCS_JSON || o.type === DOCS_CUSTOM || o.type === DOCS_VSCODE;
+
 /**
  * Check whether a string is a member of a ReadonlyArray<string>
  *
@@ -536,12 +567,23 @@ const CLI_FLAG_ALIASES = {
     h: 'help',
     p: 'port',
     v: 'version',
+    // JEST SPECIFIC CLI FLAGS
+    // these are defined in
+    // https://github.com/facebook/jest/blob/4156f86/packages/jest-cli/src/args.ts
+    b: 'bail',
+    e: 'expand',
+    f: 'onlyFailures',
+    i: 'runInBand',
+    o: 'onlyChanged',
+    t: 'testNamePattern',
+    u: 'updateSnapshot',
+    w: 'maxWorkers',
 };
 /**
  * A regular expression which can be used to match a CLI flag for one of our
  * short aliases.
  */
-const CLI_FLAG_REGEX = new RegExp(`^-[chpv]{1}$`);
+const CLI_FLAG_REGEX = new RegExp(`^-[chpvbewofitu]{1}$`);
 /**
  * Helper function for initializing a `ConfigFlags` object. Provide any overrides
  * for default values and off you go!
@@ -586,13 +628,6 @@ const parseFlags = (args) => {
             flags.args.splice(i, 1);
         }
     }
-    // to find unknown / unrecognized arguments we filter `args`, including only
-    // arguments whose normalized form is not found in `knownArgs`. `knownArgs`
-    // is populated during the call to `parseArgs` above. For arguments like
-    // `--foobar` the string `"--foobar"` will be added, while for more
-    // complicated arguments like `--bizBoz=bop` or `--bizBoz bop` just the
-    // string `"--bizBoz"` will be added.
-    flags.unknownArgs = flags.args.filter((arg) => !flags.knownArgs.includes(parseEqualsArg(arg)[0]));
     return flags;
 };
 /**
@@ -670,12 +705,12 @@ const parseCLITerm = (flags, args) => {
     else if (arg.startsWith('-') && arg.includes('=')) {
         // we're dealing with an AliasEqualsArg, we have a special helper for that
         const [originalArg, value] = parseEqualsArg(arg);
-        setCLIArg(flags, arg.split('=')[0], normalizeFlagName(originalArg), value);
+        setCLIArg(flags, desugarRawAlias(originalArg), normalizeFlagName(originalArg), value);
     }
     // AliasArg → "-" AliasName ( " " CLIValue )? ;
     else if (CLI_FLAG_REGEX.test(arg)) {
         // this is a short alias, like `-c` for Config
-        setCLIArg(flags, arg, normalizeFlagName(arg), parseCLIValue(args));
+        setCLIArg(flags, desugarRawAlias(arg), normalizeFlagName(arg), parseCLIValue(args));
     }
     // NegativeDashArg → "--no-" ArgName ;
     else if (arg.startsWith('--no-') && arg.length > '--no-'.length) {
@@ -698,11 +733,14 @@ const parseCLITerm = (flags, args) => {
     else if (arg.startsWith('--') && arg.length > '--'.length) {
         setCLIArg(flags, arg, normalizeFlagName(arg), parseCLIValue(args));
     }
-    // if we get here it is not an argument in our list of supported arguments.
-    // This doesn't necessarily mean we want to report an error or anything
-    // though! Instead, with unknown / unrecognized arguments we stick them into
-    // the `unknownArgs` array, which is used when we pass CLI args to Jest, for
-    // instance. So we just return void here.
+    else {
+        // if we get here then `arg` is not an argument in our list of supported
+        // arguments. This doesn't necessarily mean we want to report an error or
+        // anything though! Instead, with unknown / unrecognized arguments we want
+        // to stick them into the `unknownArgs` array, which is used when we pass
+        // CLI args to Jest, for instance.
+        flags.unknownArgs.push(arg);
+    }
 };
 /**
  * Normalize a 'negative' flag name, just to do a little pre-processing before
@@ -748,7 +786,7 @@ const normalizeFlagName = (flagName) => {
  * @param value the raw value to be set onto the config flags object
  */
 const setCLIArg = (flags, rawArg, normalizedArg, value) => {
-    normalizedArg = dereferenceAlias(normalizedArg);
+    normalizedArg = desugarAlias(normalizedArg);
     // We're setting a boolean!
     if (readOnlyArrayHasStringMember(BOOLEAN_CLI_FLAGS, normalizedArg)) {
         flags[normalizedArg] =
@@ -850,6 +888,14 @@ const setCLIArg = (flags, rawArg, normalizedArg, value) => {
             throwCLIParsingError(rawArg, 'expected to receive a valid log level but received nothing');
         }
     }
+    else {
+        // we haven't found this flag in any of our lists of arguments, so we
+        // should put it in our list of unknown arguments
+        flags.unknownArgs.push(rawArg);
+        if (typeof value === 'string') {
+            flags.unknownArgs.push(value);
+        }
+    }
 };
 /**
  * We use this regular expression to detect CLI parameters which
@@ -874,9 +920,10 @@ const Empty = Symbol('Empty');
  * A little helper which tries to parse a CLI value (as opposed to a flag) off
  * of the argument array.
  *
- * We support a variety of different argument formats, but all of them start
- * with `-`, so we can check the first character to test whether the next token
- * in our array of CLI arguments is a flag name or a value.
+ * We support a variety of different argument formats for flags (as opposed to
+ * values), but all of them start with `-`, so we can check the first character
+ * to test whether the next token in our array of CLI arguments is a flag name
+ * or a value.
  *
  * @param args an array of CLI args
  * @returns either a string result or an Empty sentinel
@@ -965,24 +1012,36 @@ const throwNumberParsingError = (flag, value) => {
     throwCLIParsingError(flag, `expected a number but received "${value}"`);
 };
 /**
- * A little helper to 'dereference' a flag alias, which if you squint a little
- * you can think of like a pointer to a full flag name. Thus 'c' is like a
- * pointer to 'config', so here we're doing something like `*c`. Of course, this
- * being JS, this is just a metaphor!
+ * A little helper to 'desugar' a flag alias, meaning expand it to its full
+ * name. For instance, the alias `"c"` will desugar to `"config"`.
  *
- * If no 'dereference' is found for the possible alias we just return the
- * passed string unmodified.
+ * If no expansion is found for the possible alias we just return the passed
+ * string unmodified.
  *
  * @param maybeAlias a string which _could_ be an alias to a full flag name
  * @returns the full aliased flag name, if found, or the passed string if not
  */
-const dereferenceAlias = (maybeAlias) => {
-    const possibleDereference = CLI_FLAG_ALIASES[maybeAlias];
-    if (typeof possibleDereference === 'string') {
-        return possibleDereference;
+const desugarAlias = (maybeAlias) => {
+    const possiblyDesugared = CLI_FLAG_ALIASES[maybeAlias];
+    if (typeof possiblyDesugared === 'string') {
+        return possiblyDesugared;
     }
     return maybeAlias;
 };
+/**
+ * Desugar a 'raw' alias (with a leading dash) and return an equivalent,
+ * desugared argument.
+ *
+ * For instance, passing `"-c` will return `"--config"`.
+ *
+ * The reason we'd like to do this is not so much for our own code, but so that
+ * we can transform an alias like `"-u"` to `"--updateSnapshot"` in order to
+ * pass it along to Jest.
+ *
+ * @param rawAlias a CLI flag alias as found on the command line (like `"-c"`)
+ * @returns an equivalent full command (like `"--config"`)
+ */
+const desugarRawAlias = (rawAlias) => '--' + desugarAlias(normalizeFlagName(rawAlias));
 
 const IS_NODE_ENV = typeof global !== 'undefined' &&
     typeof require === 'function' &&
@@ -1176,7 +1235,7 @@ const startupLogVersion = (logger, task, coreCompiler) => {
     const isDevBuild = coreCompiler.version.includes('-dev.');
     let startupMsg;
     if (isDevBuild) {
-        startupMsg = logger.yellow('[LOCAL DEV]');
+        startupMsg = logger.yellow(`[LOCAL DEV] v${coreCompiler.version}`);
     }
     else {
         startupMsg = logger.cyan(`v${coreCompiler.version}`);
@@ -1337,15 +1396,6 @@ const taskWatch = async (coreCompiler, config) => {
     }
 };
 
-const isOutputTargetHydrate = (o) => o.type === DIST_HYDRATE_SCRIPT;
-const isOutputTargetDocs = (o) => o.type === DOCS_README || o.type === DOCS_JSON || o.type === DOCS_CUSTOM || o.type === DOCS_VSCODE;
-const DIST_HYDRATE_SCRIPT = 'dist-hydrate-script';
-const DOCS_CUSTOM = 'docs-custom';
-const DOCS_JSON = 'docs-json';
-const DOCS_README = 'docs-readme';
-const DOCS_VSCODE = 'docs-vscode';
-const WWW = 'www';
-
 const tryFn = async (fn, ...args) => {
     try {
         return await fn(...args);
@@ -2254,12 +2304,18 @@ const taskHelp = async (flags, logger, sys) => {
 `);
 };
 
+/**
+ * Generate the output for Rindos 'info' task, and log that output - `npx rindo info`
+ * @param coreCompiler the compiler instance to derive certain version information from
+ * @param sys the compiler system instance that provides details about the system Rindo is running on
+ * @param logger the logger instance to use to log information out to
+ */
 const taskInfo = (coreCompiler, sys, logger) => {
     const details = sys.details;
     const versions = coreCompiler.versions;
     console.log(``);
     console.log(`${logger.cyan('      System:')} ${sys.name} ${sys.version}`);
-    console.log(`${logger.cyan('     Plaform:')} ${details.platform} (${details.release})`);
+    console.log(`${logger.cyan('    Platform:')} ${details.platform} (${details.release})`);
     console.log(`${logger.cyan('   CPU Model:')} ${details.cpuModel} (${sys.hardwareConcurrency} cpu${sys.hardwareConcurrency !== 1 ? 's' : ''})`);
     console.log(`${logger.cyan('    Compiler:')} ${sys.getCompilerExecutingPath()}`);
     console.log(`${logger.cyan('       Build:')} ${coreCompiler.buildId}`);

package/cli/index.js

@@ -1,6 +1,34 @@
 /*!
- Rindo CLI v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI v3.2.1 | MIT Licensed | https://rindojs.web.app
  */
+/**
+ * Default style mode id
+ */
+/**
+ * Constant for the 'dist-hydrate-script' output target
+ */
+const DIST_HYDRATE_SCRIPT = 'dist-hydrate-script';
+/**
+ * Constant for the 'docs-custom' output target
+ */
+const DOCS_CUSTOM = 'docs-custom';
+/**
+ * Constant for the 'docs-json' output target
+ */
+const DOCS_JSON = 'docs-json';
+/**
+ * Constant for the 'docs-readme' output target
+ */
+const DOCS_README = 'docs-readme';
+/**
+ * Constant for the 'docs-vscode' output target
+ */
+const DOCS_VSCODE = 'docs-vscode';
+/**
+ * Constant for the 'www' output target
+ */
+const WWW = 'www';
+
 /**
  * Convert a string from dash-case / kebab-case to PascalCase (or CamelCase,
  * or whatever you call it!)
@@ -248,6 +276,9 @@ const pathComponents = (path, rootLength) => {
     return [root, ...rest];
 };
 
+const isOutputTargetHydrate = (o) => o.type === DIST_HYDRATE_SCRIPT;
+const isOutputTargetDocs = (o) => o.type === DOCS_README || o.type === DOCS_JSON || o.type === DOCS_CUSTOM || o.type === DOCS_VSCODE;
+
 /**
  * Check whether a string is a member of a ReadonlyArray<string>
  *
@@ -512,12 +543,23 @@ const CLI_FLAG_ALIASES = {
     h: 'help',
     p: 'port',
     v: 'version',
+    // JEST SPECIFIC CLI FLAGS
+    // these are defined in
+    // https://github.com/facebook/jest/blob/4156f86/packages/jest-cli/src/args.ts
+    b: 'bail',
+    e: 'expand',
+    f: 'onlyFailures',
+    i: 'runInBand',
+    o: 'onlyChanged',
+    t: 'testNamePattern',
+    u: 'updateSnapshot',
+    w: 'maxWorkers',
 };
 /**
  * A regular expression which can be used to match a CLI flag for one of our
  * short aliases.
  */
-const CLI_FLAG_REGEX = new RegExp(`^-[chpv]{1}$`);
+const CLI_FLAG_REGEX = new RegExp(`^-[chpvbewofitu]{1}$`);
 /**
  * Helper function for initializing a `ConfigFlags` object. Provide any overrides
  * for default values and off you go!
@@ -562,13 +604,6 @@ const parseFlags = (args) => {
             flags.args.splice(i, 1);
         }
     }
-    // to find unknown / unrecognized arguments we filter `args`, including only
-    // arguments whose normalized form is not found in `knownArgs`. `knownArgs`
-    // is populated during the call to `parseArgs` above. For arguments like
-    // `--foobar` the string `"--foobar"` will be added, while for more
-    // complicated arguments like `--bizBoz=bop` or `--bizBoz bop` just the
-    // string `"--bizBoz"` will be added.
-    flags.unknownArgs = flags.args.filter((arg) => !flags.knownArgs.includes(parseEqualsArg(arg)[0]));
     return flags;
 };
 /**
@@ -646,12 +681,12 @@ const parseCLITerm = (flags, args) => {
     else if (arg.startsWith('-') && arg.includes('=')) {
         // we're dealing with an AliasEqualsArg, we have a special helper for that
         const [originalArg, value] = parseEqualsArg(arg);
-        setCLIArg(flags, arg.split('=')[0], normalizeFlagName(originalArg), value);
+        setCLIArg(flags, desugarRawAlias(originalArg), normalizeFlagName(originalArg), value);
     }
     // AliasArg → "-" AliasName ( " " CLIValue )? ;
     else if (CLI_FLAG_REGEX.test(arg)) {
         // this is a short alias, like `-c` for Config
-        setCLIArg(flags, arg, normalizeFlagName(arg), parseCLIValue(args));
+        setCLIArg(flags, desugarRawAlias(arg), normalizeFlagName(arg), parseCLIValue(args));
     }
     // NegativeDashArg → "--no-" ArgName ;
     else if (arg.startsWith('--no-') && arg.length > '--no-'.length) {
@@ -674,11 +709,14 @@ const parseCLITerm = (flags, args) => {
     else if (arg.startsWith('--') && arg.length > '--'.length) {
         setCLIArg(flags, arg, normalizeFlagName(arg), parseCLIValue(args));
     }
-    // if we get here it is not an argument in our list of supported arguments.
-    // This doesn't necessarily mean we want to report an error or anything
-    // though! Instead, with unknown / unrecognized arguments we stick them into
-    // the `unknownArgs` array, which is used when we pass CLI args to Jest, for
-    // instance. So we just return void here.
+    else {
+        // if we get here then `arg` is not an argument in our list of supported
+        // arguments. This doesn't necessarily mean we want to report an error or
+        // anything though! Instead, with unknown / unrecognized arguments we want
+        // to stick them into the `unknownArgs` array, which is used when we pass
+        // CLI args to Jest, for instance.
+        flags.unknownArgs.push(arg);
+    }
 };
 /**
  * Normalize a 'negative' flag name, just to do a little pre-processing before
@@ -724,7 +762,7 @@ const normalizeFlagName = (flagName) => {
  * @param value the raw value to be set onto the config flags object
  */
 const setCLIArg = (flags, rawArg, normalizedArg, value) => {
-    normalizedArg = dereferenceAlias(normalizedArg);
+    normalizedArg = desugarAlias(normalizedArg);
     // We're setting a boolean!
     if (readOnlyArrayHasStringMember(BOOLEAN_CLI_FLAGS, normalizedArg)) {
         flags[normalizedArg] =
@@ -826,6 +864,14 @@ const setCLIArg = (flags, rawArg, normalizedArg, value) => {
             throwCLIParsingError(rawArg, 'expected to receive a valid log level but received nothing');
         }
     }
+    else {
+        // we haven't found this flag in any of our lists of arguments, so we
+        // should put it in our list of unknown arguments
+        flags.unknownArgs.push(rawArg);
+        if (typeof value === 'string') {
+            flags.unknownArgs.push(value);
+        }
+    }
 };
 /**
  * We use this regular expression to detect CLI parameters which
@@ -850,9 +896,10 @@ const Empty = Symbol('Empty');
  * A little helper which tries to parse a CLI value (as opposed to a flag) off
  * of the argument array.
  *
- * We support a variety of different argument formats, but all of them start
- * with `-`, so we can check the first character to test whether the next token
- * in our array of CLI arguments is a flag name or a value.
+ * We support a variety of different argument formats for flags (as opposed to
+ * values), but all of them start with `-`, so we can check the first character
+ * to test whether the next token in our array of CLI arguments is a flag name
+ * or a value.
  *
  * @param args an array of CLI args
  * @returns either a string result or an Empty sentinel
@@ -941,24 +988,36 @@ const throwNumberParsingError = (flag, value) => {
     throwCLIParsingError(flag, `expected a number but received "${value}"`);
 };
 /**
- * A little helper to 'dereference' a flag alias, which if you squint a little
- * you can think of like a pointer to a full flag name. Thus 'c' is like a
- * pointer to 'config', so here we're doing something like `*c`. Of course, this
- * being JS, this is just a metaphor!
+ * A little helper to 'desugar' a flag alias, meaning expand it to its full
+ * name. For instance, the alias `"c"` will desugar to `"config"`.
  *
- * If no 'dereference' is found for the possible alias we just return the
- * passed string unmodified.
+ * If no expansion is found for the possible alias we just return the passed
+ * string unmodified.
  *
  * @param maybeAlias a string which _could_ be an alias to a full flag name
  * @returns the full aliased flag name, if found, or the passed string if not
  */
-const dereferenceAlias = (maybeAlias) => {
-    const possibleDereference = CLI_FLAG_ALIASES[maybeAlias];
-    if (typeof possibleDereference === 'string') {
-        return possibleDereference;
+const desugarAlias = (maybeAlias) => {
+    const possiblyDesugared = CLI_FLAG_ALIASES[maybeAlias];
+    if (typeof possiblyDesugared === 'string') {
+        return possiblyDesugared;
     }
     return maybeAlias;
 };
+/**
+ * Desugar a 'raw' alias (with a leading dash) and return an equivalent,
+ * desugared argument.
+ *
+ * For instance, passing `"-c` will return `"--config"`.
+ *
+ * The reason we'd like to do this is not so much for our own code, but so that
+ * we can transform an alias like `"-u"` to `"--updateSnapshot"` in order to
+ * pass it along to Jest.
+ *
+ * @param rawAlias a CLI flag alias as found on the command line (like `"-c"`)
+ * @returns an equivalent full command (like `"--config"`)
+ */
+const desugarRawAlias = (rawAlias) => '--' + desugarAlias(normalizeFlagName(rawAlias));
 
 const IS_NODE_ENV = typeof global !== 'undefined' &&
     typeof require === 'function' &&
@@ -1152,7 +1211,7 @@ const startupLogVersion = (logger, task, coreCompiler) => {
     const isDevBuild = coreCompiler.version.includes('-dev.');
     let startupMsg;
     if (isDevBuild) {
-        startupMsg = logger.yellow('[LOCAL DEV]');
+        startupMsg = logger.yellow(`[LOCAL DEV] v${coreCompiler.version}`);
     }
     else {
         startupMsg = logger.cyan(`v${coreCompiler.version}`);
@@ -1313,15 +1372,6 @@ const taskWatch = async (coreCompiler, config) => {
     }
 };
 
-const isOutputTargetHydrate = (o) => o.type === DIST_HYDRATE_SCRIPT;
-const isOutputTargetDocs = (o) => o.type === DOCS_README || o.type === DOCS_JSON || o.type === DOCS_CUSTOM || o.type === DOCS_VSCODE;
-const DIST_HYDRATE_SCRIPT = 'dist-hydrate-script';
-const DOCS_CUSTOM = 'docs-custom';
-const DOCS_JSON = 'docs-json';
-const DOCS_README = 'docs-readme';
-const DOCS_VSCODE = 'docs-vscode';
-const WWW = 'www';
-
 const tryFn = async (fn, ...args) => {
     try {
         return await fn(...args);
@@ -2230,12 +2280,18 @@ const taskHelp = async (flags, logger, sys) => {
 `);
 };
 
+/**
+ * Generate the output for Rindos 'info' task, and log that output - `npx rindo info`
+ * @param coreCompiler the compiler instance to derive certain version information from
+ * @param sys the compiler system instance that provides details about the system Rindo is running on
+ * @param logger the logger instance to use to log information out to
+ */
 const taskInfo = (coreCompiler, sys, logger) => {
     const details = sys.details;
     const versions = coreCompiler.versions;
     console.log(``);
     console.log(`${logger.cyan('      System:')} ${sys.name} ${sys.version}`);
-    console.log(`${logger.cyan('     Plaform:')} ${details.platform} (${details.release})`);
+    console.log(`${logger.cyan('    Platform:')} ${details.platform} (${details.release})`);
     console.log(`${logger.cyan('   CPU Model:')} ${details.cpuModel} (${sys.hardwareConcurrency} cpu${sys.hardwareConcurrency !== 1 ? 's' : ''})`);
     console.log(`${logger.cyan('    Compiler:')} ${sys.getCompilerExecutingPath()}`);
     console.log(`${logger.cyan('       Build:')} ${coreCompiler.buildId}`);

package/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/cli",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "description": "Rindo CLI.",
   "main": "./index.cjs",
   "module": "./index.js",

package/compiler/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/compiler",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "description": "Rindo Compiler.",
   "main": "./rindo.js",
   "types": "./rindo.d.ts",