@rindo/core 2.16.0 → 2.16.1-0

package/cli/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI (CommonJS) v2.16.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI (CommonJS) v2.16.1-0 | MIT Licensed | https://rindojs.web.app
  */
 'use strict';
 
@@ -118,6 +118,8 @@ const TASK_CANCELED_MSG = `task canceled`;
  * Forward-slash paths can be used in Windows as long as they're not
  * extended-length paths and don't contain any non-ascii characters.
  * This was created since the path methods in Node.js outputs \\ paths on Windows.
+ * @param path the Windows-based path to convert
+ * @returns the converted path
  */
 const normalizePath = (path) => {
     if (typeof path !== 'string') {
@@ -530,7 +532,7 @@ const getNpmConfigEnvArgs = (sys) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "2.16.0",
+		version: "2.16.1-0",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",
@@ -1071,10 +1073,12 @@ const prepareData = async (coreCompiler, config, sys, duration_ms, component_cou
     };
 };
 /**
- * Reads package-lock.json, yarn.lock, and package.json files in order to cross reference
+ * 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.
- * @returns string[]
+ * @param sys the system instance where telemetry is invoked
+ * @param config the Rindo configuration associated with the current task that triggered telemetry
+ * @returns an object listing all dev and production dependencies under the aforementioned scopes
  */
 async function getInstalledPackages(sys, config) {
     let packages = [];
@@ -1153,7 +1157,12 @@ function sanitizeDeclaredVersion(version) {
     return version.replace(/[*^~]/g, '');
 }
 /**
- * If telemetry is enabled, send a metric via IPC to a forked process for uploading.
+ * If telemetry is enabled, send a metric to an external data store
+ * @param sys the system instance where telemetry is invoked
+ * @param config the Rindo configuration associated with the current task that triggered telemetry
+ * @param name the name of a trackable metric. Note this name is not necessarily a scalar value to track, like
+ * "Rindo Version". For example, "rindo_cli_command" is a name that is used to track all CLI command information.
+ * @param value the data to send to the external data store under the provided name argument
  */
 async function sendMetric(sys, config, name, value) {
     const session_id = await getTelemetryToken(sys);
@@ -1466,7 +1475,10 @@ const getBoilerplateByExtension = (tagName, extension, withCss) => {
     }
 };
 /**
- * Get the boilerplate for a component.
+ * Get the boilerplate for a file containing the definition of a component
+ * @param tagName the name of the tag to give the component
+ * @param hasStyle designates if the component has an external stylesheet or not
+ * @returns the contents of a file that defines a component
  */
 const getComponentBoilerplate = (tagName, hasStyle) => {
     const decorator = [`{`];
@@ -1500,7 +1512,9 @@ const getStyleUrlBoilerplate = () => `:host {
 }
 `;
 /**
- * Get the boilerplate for a spec test.
+ * Get the boilerplate for a file containing a spec (unit) test for a component
+ * @param tagName the name of the tag associated with the component under test
+ * @returns the contents of a file that unit tests a component
  */
 const getSpecTestBoilerplate = (tagName) => `import { newSpecPage } from '@rindo/core/testing';
 import { ${toPascalCase(tagName)} } from '../${tagName}';
@@ -1522,22 +1536,26 @@ describe('${tagName}', () => {
 });
 `;
 /**
- * Get the boilerplate for an E2E test.
+ * Get the boilerplate for a file containing an end-to-end (E2E) test for a component
+ * @param tagName the name of the tag associated with the component under test
+ * @returns the contents of a file that E2E tests a component
  */
-const getE2eTestBoilerplate = (name) => `import { newE2EPage } from '@rindo/core/testing';
+const getE2eTestBoilerplate = (tagName) => `import { newE2EPage } from '@rindo/core/testing';
 
-describe('${name}', () => {
+describe('${tagName}', () => {
   it('renders', async () => {
     const page = await newE2EPage();
-    await page.setContent('<${name}></${name}>');
+    await page.setContent('<${tagName}></${tagName}>');
 
-    const element = await page.find('${name}');
+    const element = await page.find('${tagName}');
     expect(element).toHaveClass('hydrated');
   });
 });
 `;
 /**
  * Convert a dash case string to pascal case.
+ * @param str the string to convert
+ * @returns the converted input as pascal case
  */
 const toPascalCase = (str) => str.split('-').reduce((res, part) => res + part[0].toUpperCase() + part.slice(1), '');
 

package/cli/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI v2.16.0 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI v2.16.1-0 | MIT Licensed | https://rindojs.web.app
  */
 const toLowerCase = (str) => str.toLowerCase();
 const dashToPascalCase = (str) => toLowerCase(str)
@@ -94,6 +94,8 @@ const TASK_CANCELED_MSG = `task canceled`;
  * Forward-slash paths can be used in Windows as long as they're not
  * extended-length paths and don't contain any non-ascii characters.
  * This was created since the path methods in Node.js outputs \\ paths on Windows.
+ * @param path the Windows-based path to convert
+ * @returns the converted path
  */
 const normalizePath = (path) => {
     if (typeof path !== 'string') {
@@ -506,7 +508,7 @@ const getNpmConfigEnvArgs = (sys) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "2.16.0",
+		version: "2.16.1-0",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",
@@ -1047,10 +1049,12 @@ const prepareData = async (coreCompiler, config, sys, duration_ms, component_cou
     };
 };
 /**
- * Reads package-lock.json, yarn.lock, and package.json files in order to cross reference
+ * 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.
- * @returns string[]
+ * @param sys the system instance where telemetry is invoked
+ * @param config the Rindo configuration associated with the current task that triggered telemetry
+ * @returns an object listing all dev and production dependencies under the aforementioned scopes
  */
 async function getInstalledPackages(sys, config) {
     let packages = [];
@@ -1129,7 +1133,12 @@ function sanitizeDeclaredVersion(version) {
     return version.replace(/[*^~]/g, '');
 }
 /**
- * If telemetry is enabled, send a metric via IPC to a forked process for uploading.
+ * If telemetry is enabled, send a metric to an external data store
+ * @param sys the system instance where telemetry is invoked
+ * @param config the Rindo configuration associated with the current task that triggered telemetry
+ * @param name the name of a trackable metric. Note this name is not necessarily a scalar value to track, like
+ * "Rindo Version". For example, "rindo_cli_command" is a name that is used to track all CLI command information.
+ * @param value the data to send to the external data store under the provided name argument
  */
 async function sendMetric(sys, config, name, value) {
     const session_id = await getTelemetryToken(sys);
@@ -1442,7 +1451,10 @@ const getBoilerplateByExtension = (tagName, extension, withCss) => {
     }
 };
 /**
- * Get the boilerplate for a component.
+ * Get the boilerplate for a file containing the definition of a component
+ * @param tagName the name of the tag to give the component
+ * @param hasStyle designates if the component has an external stylesheet or not
+ * @returns the contents of a file that defines a component
  */
 const getComponentBoilerplate = (tagName, hasStyle) => {
     const decorator = [`{`];
@@ -1476,7 +1488,9 @@ const getStyleUrlBoilerplate = () => `:host {
 }
 `;
 /**
- * Get the boilerplate for a spec test.
+ * Get the boilerplate for a file containing a spec (unit) test for a component
+ * @param tagName the name of the tag associated with the component under test
+ * @returns the contents of a file that unit tests a component
  */
 const getSpecTestBoilerplate = (tagName) => `import { newSpecPage } from '@rindo/core/testing';
 import { ${toPascalCase(tagName)} } from '../${tagName}';
@@ -1498,22 +1512,26 @@ describe('${tagName}', () => {
 });
 `;
 /**
- * Get the boilerplate for an E2E test.
+ * Get the boilerplate for a file containing an end-to-end (E2E) test for a component
+ * @param tagName the name of the tag associated with the component under test
+ * @returns the contents of a file that E2E tests a component
  */
-const getE2eTestBoilerplate = (name) => `import { newE2EPage } from '@rindo/core/testing';
+const getE2eTestBoilerplate = (tagName) => `import { newE2EPage } from '@rindo/core/testing';
 
-describe('${name}', () => {
+describe('${tagName}', () => {
   it('renders', async () => {
     const page = await newE2EPage();
-    await page.setContent('<${name}></${name}>');
+    await page.setContent('<${tagName}></${tagName}>');
 
-    const element = await page.find('${name}');
+    const element = await page.find('${tagName}');
     expect(element).toHaveClass('hydrated');
   });
 });
 `;
 /**
  * Convert a dash case string to pascal case.
+ * @param str the string to convert
+ * @returns the converted input as pascal case
  */
 const toPascalCase = (str) => str.split('-').reduce((res, part) => res + part[0].toUpperCase() + part.slice(1), '');
 

package/cli/package.json

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

package/compiler/package.json

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