@rindo/core 2.18.0 → 2.18.1

package/cli/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI (CommonJS) v2.18.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI (CommonJS) v2.18.1 | MIT Licensed | https://rindojs.web.app
  */
 'use strict';
 
@@ -829,7 +829,7 @@ LOG_LEVELS.includes(maybeLogLevel);
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "2.18.0",
+		version: "2.18.1",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",
@@ -1177,7 +1177,7 @@ const isInteractive = (sys, flags, object) => {
     return terminalInfo.tty && !terminalInfo.ci;
 };
 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);
-// Plucked from https://github.com/navify/jigra/blob/HEAD/cli/src/util/uuid.ts
+// Plucked from https://github.com/familyjs/jigra/blob/HEAD/cli/src/util/uuid.ts
 function uuidv4() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
         const r = (Math.random() * 16) | 0;
@@ -1224,10 +1224,10 @@ async function shouldTrack(config, sys, ci) {
 }
 
 const isTest$1 = () => process.env.JEST_WORKER_ID !== undefined;
-const defaultConfig = (sys) => sys.resolvePath(`${sys.homeDir()}/.navify/${isTest$1() ? 'tmp-config.json' : 'config.json'}`);
-const defaultConfigDirectory = (sys) => sys.resolvePath(`${sys.homeDir()}/.navify`);
+const defaultConfig = (sys) => sys.resolvePath(`${sys.homeDir()}/.family/${isTest$1() ? 'tmp-config.json' : 'config.json'}`);
+const defaultConfigDirectory = (sys) => sys.resolvePath(`${sys.homeDir()}/.family`);
 /**
- * Reads an Navify configuration file from disk, parses it, and performs any necessary corrections to it if certain
+ * Reads an Family configuration file from disk, parses it, and performs any necessary corrections to it if certain
  * values are deemed to be malformed
  * @param sys The system where the command is invoked
  * @returns the config read from disk that has been potentially been updated
@@ -1249,7 +1249,7 @@ async function readConfig(sys) {
     return config;
 }
 /**
- * Writes an Navify configuration file to disk.
+ * Writes an Family configuration file to disk.
  * @param sys The system where the command is invoked
  * @param config The config passed into the Rindo command
  * @returns boolean If the command was successful
@@ -1267,7 +1267,7 @@ async function writeConfig(sys, config) {
     return result;
 }
 /**
- * Update a subset of the Navify config.
+ * Update a subset of the Family config.
  * @param sys The system where the command is invoked
  * @param newOptions The new options to save
  * @returns boolean If the command was successful
@@ -1483,7 +1483,7 @@ const anonymizeConfigForTelemetry = (config) => {
 /**
  * Reads package-lock.json, yarn.lock, and package.json files in order to cross-reference
  * the dependencies and devDependencies properties. Pulls up the current installed version
- * of each package under the @rindo, @navify, and @jigra scopes.
+ * of each package under the @rindo, @familyjs, and @jigra scopes.
  *
  * @param sys the system instance where telemetry is invoked
  * @param config the Rindo configuration associated with the current task that triggered telemetry
@@ -1505,16 +1505,16 @@ async function getInstalledPackages(sys, config) {
             ...packageJson.devDependencies,
             ...packageJson.dependencies,
         });
-        // Collect packages only in the rindo, navify, or jigra org's:
+        // Collect packages only in the rindo, familyjs, or jigra org's:
         // https://www.npmjs.com/org/rindo
-        const navifyPackages = rawPackages.filter(([k]) => k.startsWith('@rindo/') || k.startsWith('@navify/') || k.startsWith('@jigra/'));
+        const familyPackages = rawPackages.filter(([k]) => k.startsWith('@rindo/') || k.startsWith('@familyjs/') || k.startsWith('@jigra/'));
         try {
-            packages = yarn ? await yarnPackages(sys, navifyPackages) : await npmPackages(sys, navifyPackages);
+            packages = yarn ? await yarnPackages(sys, familyPackages) : await npmPackages(sys, familyPackages);
         }
         catch (e) {
-            packages = navifyPackages.map(([k, v]) => `${k}@${v.replace('^', '')}`);
+            packages = familyPackages.map(([k, v]) => `${k}@${v.replace('^', '')}`);
         }
-        packagesNoVersions = navifyPackages.map(([k]) => `${k}`);
+        packagesNoVersions = familyPackages.map(([k]) => `${k}`);
         return { packages, packagesNoVersions };
     }
     catch (err) {
@@ -1525,13 +1525,13 @@ async function getInstalledPackages(sys, config) {
 /**
  * Visits the npm lock file to find the exact versions that are installed
  * @param sys The system where the command is invoked
- * @param navifyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@navify` from the package.json file.
+ * @param familyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@familyjs` from the package.json file.
  * @returns an array of strings of all the packages and their versions.
  */
-async function npmPackages(sys, navifyPackages) {
+async function npmPackages(sys, familyPackages) {
     const appRootDir = sys.getCurrentDirectory();
     const packageLockJson = await tryFn(readJson, sys, sys.resolvePath(appRootDir + '/package-lock.json'));
-    return navifyPackages.map(([k, v]) => {
+    return familyPackages.map(([k, v]) => {
         var _a, _b, _c, _d;
         let version = (_d = (_b = (_a = packageLockJson === null || packageLockJson === void 0 ? void 0 : packageLockJson.dependencies[k]) === null || _a === void 0 ? void 0 : _a.version) !== null && _b !== void 0 ? _b : (_c = packageLockJson === null || packageLockJson === void 0 ? void 0 : packageLockJson.devDependencies[k]) === null || _c === void 0 ? void 0 : _c.version) !== null && _d !== void 0 ? _d : v;
         version = version.includes('file:') ? sanitizeDeclaredVersion(v) : version;
@@ -1541,14 +1541,14 @@ async function npmPackages(sys, navifyPackages) {
 /**
  * Visits the yarn lock file to find the exact versions that are installed
  * @param sys The system where the command is invoked
- * @param navifyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@navify` from the package.json file.
+ * @param familyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@familyjs` from the package.json file.
  * @returns an array of strings of all the packages and their versions.
  */
-async function yarnPackages(sys, navifyPackages) {
+async function yarnPackages(sys, familyPackages) {
     const appRootDir = sys.getCurrentDirectory();
     const yarnLock = sys.readFileSync(sys.resolvePath(appRootDir + '/yarn.lock'));
     const yarnLockYml = sys.parseYarnLockFile(yarnLock);
-    return navifyPackages.map(([k, v]) => {
+    return familyPackages.map(([k, v]) => {
         var _a;
         const identifiedVersion = `${k}@${v}`;
         let version = (_a = yarnLockYml.object[identifiedVersion]) === null || _a === void 0 ? void 0 : _a.version;
@@ -1613,7 +1613,7 @@ async function sendTelemetry(sys, config, data) {
             sent_at: now,
         };
         // This request is only made if telemetry is on.
-        const response = await sys.fetch('https://api-navifyjs.web.app/events/metrics', {
+        const response = await sys.fetch('https://familyjs-api.web.app/events/metrics', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
@@ -2103,6 +2103,56 @@ const taskServe = async (config) => {
     });
 };
 
+/**
+ * Entrypoint for any Rindo tests
+ * @param config a validated Rindo configuration entity
+ */
+const taskTest = async (config) => {
+    if (!IS_NODE_ENV) {
+        config.logger.error(`"test" command is currently only implemented for a NodeJS environment`);
+        return config.sys.exit(1);
+    }
+    try {
+        config.buildDocs = false;
+        const testingRunOpts = {
+            e2e: !!config.flags.e2e,
+            screenshot: !!config.flags.screenshot,
+            spec: !!config.flags.spec,
+            updateScreenshot: !!config.flags.updateScreenshot,
+        };
+        // always ensure we have jest modules installed
+        const ensureModuleIds = ['@types/jest', 'jest', 'jest-cli'];
+        if (testingRunOpts.e2e) {
+            // if it's an e2e test, also make sure we're got
+            // puppeteer modules installed and if browserExecutablePath is provided don't download Chromium use only puppeteer-core instead
+            const puppeteer = config.testing.browserExecutablePath ? 'puppeteer-core' : 'puppeteer';
+            ensureModuleIds.push(puppeteer);
+            if (testingRunOpts.screenshot) {
+                // ensure we've got pixelmatch for screenshots
+                config.logger.warn(config.logger.yellow(`EXPERIMENTAL: screenshot visual diff testing is currently under heavy development and has not reached a stable status. However, any assistance testing would be appreciated.`));
+            }
+        }
+        // ensure we've got the required modules installed
+        const diagnostics = await config.sys.lazyRequire.ensure(config.rootDir, ensureModuleIds);
+        if (diagnostics.length > 0) {
+            config.logger.printDiagnostics(diagnostics);
+            return config.sys.exit(1);
+        }
+        // let's test!
+        const { createTesting } = await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('../testing/index.js')); });
+        const testing = await createTesting(config);
+        const passed = await testing.run(testingRunOpts);
+        await testing.destroy();
+        if (!passed) {
+            return config.sys.exit(1);
+        }
+    }
+    catch (e) {
+        config.logger.error(e);
+        return config.sys.exit(1);
+    }
+};
+
 /**
  * Creates an instance of a logger
  * @returns the new logger instance
@@ -2309,6 +2359,9 @@ const runTask = async (coreCompiler, config, task, sys) => {
         case 'telemetry':
             await taskTelemetry(strictConfig.flags, sys, strictConfig.logger);
             break;
+        case 'test':
+            await taskTest(strictConfig);
+            break;
         case 'version':
             console.log(coreCompiler.version);
             break;

package/cli/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI v2.18.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI v2.18.1 | MIT Licensed | https://rindojs.web.app
  */
 /**
  * This sets the log level hierarchy for our terminal logger, ranging from
@@ -805,7 +805,7 @@ LOG_LEVELS.includes(maybeLogLevel);
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "2.18.0",
+		version: "2.18.1",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",
@@ -1153,7 +1153,7 @@ const isInteractive = (sys, flags, object) => {
     return terminalInfo.tty && !terminalInfo.ci;
 };
 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);
-// Plucked from https://github.com/navify/jigra/blob/HEAD/cli/src/util/uuid.ts
+// Plucked from https://github.com/familyjs/jigra/blob/HEAD/cli/src/util/uuid.ts
 function uuidv4() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
         const r = (Math.random() * 16) | 0;
@@ -1200,10 +1200,10 @@ async function shouldTrack(config, sys, ci) {
 }
 
 const isTest$1 = () => process.env.JEST_WORKER_ID !== undefined;
-const defaultConfig = (sys) => sys.resolvePath(`${sys.homeDir()}/.navify/${isTest$1() ? 'tmp-config.json' : 'config.json'}`);
-const defaultConfigDirectory = (sys) => sys.resolvePath(`${sys.homeDir()}/.navify`);
+const defaultConfig = (sys) => sys.resolvePath(`${sys.homeDir()}/.family/${isTest$1() ? 'tmp-config.json' : 'config.json'}`);
+const defaultConfigDirectory = (sys) => sys.resolvePath(`${sys.homeDir()}/.family`);
 /**
- * Reads an Navify configuration file from disk, parses it, and performs any necessary corrections to it if certain
+ * Reads an Family configuration file from disk, parses it, and performs any necessary corrections to it if certain
  * values are deemed to be malformed
  * @param sys The system where the command is invoked
  * @returns the config read from disk that has been potentially been updated
@@ -1225,7 +1225,7 @@ async function readConfig(sys) {
     return config;
 }
 /**
- * Writes an Navify configuration file to disk.
+ * Writes an Family configuration file to disk.
  * @param sys The system where the command is invoked
  * @param config The config passed into the Rindo command
  * @returns boolean If the command was successful
@@ -1243,7 +1243,7 @@ async function writeConfig(sys, config) {
     return result;
 }
 /**
- * Update a subset of the Navify config.
+ * Update a subset of the Family config.
  * @param sys The system where the command is invoked
  * @param newOptions The new options to save
  * @returns boolean If the command was successful
@@ -1459,7 +1459,7 @@ const anonymizeConfigForTelemetry = (config) => {
 /**
  * Reads package-lock.json, yarn.lock, and package.json files in order to cross-reference
  * the dependencies and devDependencies properties. Pulls up the current installed version
- * of each package under the @rindo, @navify, and @jigra scopes.
+ * of each package under the @rindo, @familyjs, and @jigra scopes.
  *
  * @param sys the system instance where telemetry is invoked
  * @param config the Rindo configuration associated with the current task that triggered telemetry
@@ -1481,16 +1481,16 @@ async function getInstalledPackages(sys, config) {
             ...packageJson.devDependencies,
             ...packageJson.dependencies,
         });
-        // Collect packages only in the rindo, navify, or jigra org's:
+        // Collect packages only in the rindo, familyjs, or jigra org's:
         // https://www.npmjs.com/org/rindo
-        const navifyPackages = rawPackages.filter(([k]) => k.startsWith('@rindo/') || k.startsWith('@navify/') || k.startsWith('@jigra/'));
+        const familyPackages = rawPackages.filter(([k]) => k.startsWith('@rindo/') || k.startsWith('@familyjs/') || k.startsWith('@jigra/'));
         try {
-            packages = yarn ? await yarnPackages(sys, navifyPackages) : await npmPackages(sys, navifyPackages);
+            packages = yarn ? await yarnPackages(sys, familyPackages) : await npmPackages(sys, familyPackages);
         }
         catch (e) {
-            packages = navifyPackages.map(([k, v]) => `${k}@${v.replace('^', '')}`);
+            packages = familyPackages.map(([k, v]) => `${k}@${v.replace('^', '')}`);
         }
-        packagesNoVersions = navifyPackages.map(([k]) => `${k}`);
+        packagesNoVersions = familyPackages.map(([k]) => `${k}`);
         return { packages, packagesNoVersions };
     }
     catch (err) {
@@ -1501,13 +1501,13 @@ async function getInstalledPackages(sys, config) {
 /**
  * Visits the npm lock file to find the exact versions that are installed
  * @param sys The system where the command is invoked
- * @param navifyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@navify` from the package.json file.
+ * @param familyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@familyjs` from the package.json file.
  * @returns an array of strings of all the packages and their versions.
  */
-async function npmPackages(sys, navifyPackages) {
+async function npmPackages(sys, familyPackages) {
     const appRootDir = sys.getCurrentDirectory();
     const packageLockJson = await tryFn(readJson, sys, sys.resolvePath(appRootDir + '/package-lock.json'));
-    return navifyPackages.map(([k, v]) => {
+    return familyPackages.map(([k, v]) => {
         var _a, _b, _c, _d;
         let version = (_d = (_b = (_a = packageLockJson === null || packageLockJson === void 0 ? void 0 : packageLockJson.dependencies[k]) === null || _a === void 0 ? void 0 : _a.version) !== null && _b !== void 0 ? _b : (_c = packageLockJson === null || packageLockJson === void 0 ? void 0 : packageLockJson.devDependencies[k]) === null || _c === void 0 ? void 0 : _c.version) !== null && _d !== void 0 ? _d : v;
         version = version.includes('file:') ? sanitizeDeclaredVersion(v) : version;
@@ -1517,14 +1517,14 @@ async function npmPackages(sys, navifyPackages) {
 /**
  * Visits the yarn lock file to find the exact versions that are installed
  * @param sys The system where the command is invoked
- * @param navifyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@navify` from the package.json file.
+ * @param familyPackages a list of the found packages matching `@rindo`, `@jigra`, or `@familyjs` from the package.json file.
  * @returns an array of strings of all the packages and their versions.
  */
-async function yarnPackages(sys, navifyPackages) {
+async function yarnPackages(sys, familyPackages) {
     const appRootDir = sys.getCurrentDirectory();
     const yarnLock = sys.readFileSync(sys.resolvePath(appRootDir + '/yarn.lock'));
     const yarnLockYml = sys.parseYarnLockFile(yarnLock);
-    return navifyPackages.map(([k, v]) => {
+    return familyPackages.map(([k, v]) => {
         var _a;
         const identifiedVersion = `${k}@${v}`;
         let version = (_a = yarnLockYml.object[identifiedVersion]) === null || _a === void 0 ? void 0 : _a.version;
@@ -1589,7 +1589,7 @@ async function sendTelemetry(sys, config, data) {
             sent_at: now,
         };
         // This request is only made if telemetry is on.
-        const response = await sys.fetch('https://api-navifyjs.web.app/events/metrics', {
+        const response = await sys.fetch('https://familyjs-api.web.app/events/metrics', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
@@ -2079,6 +2079,56 @@ const taskServe = async (config) => {
     });
 };
 
+/**
+ * Entrypoint for any Rindo tests
+ * @param config a validated Rindo configuration entity
+ */
+const taskTest = async (config) => {
+    if (!IS_NODE_ENV) {
+        config.logger.error(`"test" command is currently only implemented for a NodeJS environment`);
+        return config.sys.exit(1);
+    }
+    try {
+        config.buildDocs = false;
+        const testingRunOpts = {
+            e2e: !!config.flags.e2e,
+            screenshot: !!config.flags.screenshot,
+            spec: !!config.flags.spec,
+            updateScreenshot: !!config.flags.updateScreenshot,
+        };
+        // always ensure we have jest modules installed
+        const ensureModuleIds = ['@types/jest', 'jest', 'jest-cli'];
+        if (testingRunOpts.e2e) {
+            // if it's an e2e test, also make sure we're got
+            // puppeteer modules installed and if browserExecutablePath is provided don't download Chromium use only puppeteer-core instead
+            const puppeteer = config.testing.browserExecutablePath ? 'puppeteer-core' : 'puppeteer';
+            ensureModuleIds.push(puppeteer);
+            if (testingRunOpts.screenshot) {
+                // ensure we've got pixelmatch for screenshots
+                config.logger.warn(config.logger.yellow(`EXPERIMENTAL: screenshot visual diff testing is currently under heavy development and has not reached a stable status. However, any assistance testing would be appreciated.`));
+            }
+        }
+        // ensure we've got the required modules installed
+        const diagnostics = await config.sys.lazyRequire.ensure(config.rootDir, ensureModuleIds);
+        if (diagnostics.length > 0) {
+            config.logger.printDiagnostics(diagnostics);
+            return config.sys.exit(1);
+        }
+        // let's test!
+        const { createTesting } = await import('../testing/index.js');
+        const testing = await createTesting(config);
+        const passed = await testing.run(testingRunOpts);
+        await testing.destroy();
+        if (!passed) {
+            return config.sys.exit(1);
+        }
+    }
+    catch (e) {
+        config.logger.error(e);
+        return config.sys.exit(1);
+    }
+};
+
 /**
  * Creates an instance of a logger
  * @returns the new logger instance
@@ -2285,6 +2335,9 @@ const runTask = async (coreCompiler, config, task, sys) => {
         case 'telemetry':
             await taskTelemetry(strictConfig.flags, sys, strictConfig.logger);
             break;
+        case 'test':
+            await taskTest(strictConfig);
+            break;
         case 'version':
             console.log(coreCompiler.version);
             break;

package/cli/package.json

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

package/compiler/package.json

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