@rindo/core 2.16.0-beta.0 → 2.16.1-0

package/compiler/rindo.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Compiler v0.0.0-dev.20220810110141 | MIT Licensed | https://rindojs.web.app
+ Rindo Compiler v2.16.1-0 | MIT Licensed | https://rindojs.web.app
  */
 (function(exports) {
 'use strict';
@@ -717,7 +717,7 @@ const computeListenerFlags = (listener) => {
 };
 const trimFalsy = (data) => {
   const arr = data;
-  for (var i = arr.length - 1; i >= 0; i--) {
+  for (let i = arr.length - 1; i >= 0; i--) {
     if (arr[i]) {
       break;
     }
@@ -826,136 +826,15 @@ const isGlob = (str) => {
 };
 
 /**
- * Checks if the path is the OS root path, such as "/" or "C:\"
+ * Checks if the path is the Operating System (OS) root path, such as "/" or "C:\". This function does not take the OS
+ * the code is running on into account when performing this evaluation.
+ * @param p the path to check
+ * @returns `true` if the path is an OS root path, `false` otherwise
  */
 const isRootPath = (p) => p === '/' || windowsPathRegex.test(p);
 // https://github.com/nodejs/node/blob/5883a59b21a97e8b7339f435c977155a2c29ba8d/lib/path.js#L43
 const windowsPathRegex = /^(?:[a-zA-Z]:|[\\/]{2}[^\\/]+[\\/]+[^\\/]+)?[\\/]$/;
 
-/**
- * Iterate through a series of diagnostics to provide minor fix-ups for various edge cases, deduplicate messages, etc.
- * @param compilerCtx the current compiler context
- * @param diagnostics the diagnostics to normalize
- * @returns the normalize documents
- */
-const normalizeDiagnostics = (compilerCtx, diagnostics) => {
-  const normalizedErrors = [];
-  const normalizedOthers = [];
-  const dups = new Set();
-  for (let i = 0; i < diagnostics.length; i++) {
-    const d = normalizeDiagnostic(compilerCtx, diagnostics[i]);
-    const key = d.absFilePath + d.code + d.messageText + d.type;
-    if (dups.has(key)) {
-      continue;
-    }
-    dups.add(key);
-    const total = normalizedErrors.length + normalizedOthers.length;
-    if (d.level === 'error') {
-      normalizedErrors.push(d);
-    }
-    else if (total < MAX_ERRORS) {
-      normalizedOthers.push(d);
-    }
-  }
-  return [...normalizedErrors, ...normalizedOthers];
-};
-/**
- * Perform post-processing on a `Diagnostic` to handle a few message edge cases, massaging error message text and
- * updating build failure contexts
- * @param compilerCtx the current compiler
- * @param diagnostic the diagnostic to normalize
- * @returns the altered diagnostic
- */
-const normalizeDiagnostic = (compilerCtx, diagnostic) => {
-  if (diagnostic.messageText) {
-    if (typeof diagnostic.messageText.message === 'string') {
-      diagnostic.messageText = diagnostic.messageText.message;
-    }
-    else if (typeof diagnostic.messageText === 'string' && diagnostic.messageText.indexOf('Error: ') === 0) {
-      diagnostic.messageText = diagnostic.messageText.slice(7);
-    }
-  }
-  if (diagnostic.messageText) {
-    if (diagnostic.messageText.includes(`Cannot find name 'h'`)) {
-      diagnostic.header = `Missing "h" import for JSX types`;
-      diagnostic.messageText = `In order to load accurate JSX types for components, the "h" function must be imported from "@rindo/core" by each component using JSX. For example: import { Component, h } from '@rindo/core';`;
-      try {
-        const sourceText = compilerCtx.fs.readFileSync(diagnostic.absFilePath);
-        const srcLines = splitLineBreaks(sourceText);
-        for (let i = 0; i < srcLines.length; i++) {
-          const srcLine = srcLines[i];
-          if (srcLine.includes('@rindo/core')) {
-            const msgLines = [];
-            const beforeLineIndex = i - 1;
-            if (beforeLineIndex > -1) {
-              const beforeLine = {
-                lineIndex: beforeLineIndex,
-                lineNumber: beforeLineIndex + 1,
-                text: srcLines[beforeLineIndex],
-                errorCharStart: -1,
-                errorLength: -1,
-              };
-              msgLines.push(beforeLine);
-            }
-            const errorLine = {
-              lineIndex: i,
-              lineNumber: i + 1,
-              text: srcLine,
-              errorCharStart: 0,
-              errorLength: -1,
-            };
-            msgLines.push(errorLine);
-            diagnostic.lineNumber = errorLine.lineNumber;
-            diagnostic.columnNumber = srcLine.indexOf('}');
-            const afterLineIndex = i + 1;
-            if (afterLineIndex < srcLines.length) {
-              const afterLine = {
-                lineIndex: afterLineIndex,
-                lineNumber: afterLineIndex + 1,
-                text: srcLines[afterLineIndex],
-                errorCharStart: -1,
-                errorLength: -1,
-              };
-              msgLines.push(afterLine);
-            }
-            diagnostic.lines = msgLines;
-            break;
-          }
-        }
-      }
-      catch (e) { }
-    }
-  }
-  return diagnostic;
-};
-/**
- * Split a corpus by newlines. Carriage returns are treated a newlines.
- * @param sourceText the corpus to split
- * @returns the split text
- */
-const splitLineBreaks = (sourceText) => {
-  if (typeof sourceText !== 'string')
-    return [];
-  sourceText = sourceText.replace(/\\r/g, '\n');
-  return sourceText.split('\n');
-};
-const escapeHtml = (unsafe) => {
-  if (unsafe === undefined)
-    return 'undefined';
-  if (unsafe === null)
-    return 'null';
-  if (typeof unsafe !== 'string') {
-    unsafe = unsafe.toString();
-  }
-  return unsafe
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&#039;');
-};
-const MAX_ERRORS = 25;
-
 /**
  * Builds a template `Diagnostic` entity for a build error. The created `Diagnostic` is returned, and have little
  * detail attached to it regarding the specifics of the error - it is the responsibility of the caller of this method
@@ -1120,6 +999,130 @@ const shouldIgnoreError = (msg) => {
 };
 const TASK_CANCELED_MSG = `task canceled`;
 
+/**
+ * Iterate through a series of diagnostics to provide minor fix-ups for various edge cases, deduplicate messages, etc.
+ * @param compilerCtx the current compiler context
+ * @param diagnostics the diagnostics to normalize
+ * @returns the normalize documents
+ */
+const normalizeDiagnostics = (compilerCtx, diagnostics) => {
+  const maxErrorsToNormalize = 25;
+  const normalizedErrors = [];
+  const normalizedOthers = [];
+  const dups = new Set();
+  for (let i = 0; i < diagnostics.length; i++) {
+    const d = normalizeDiagnostic(compilerCtx, diagnostics[i]);
+    const key = d.absFilePath + d.code + d.messageText + d.type;
+    if (dups.has(key)) {
+      continue;
+    }
+    dups.add(key);
+    const total = normalizedErrors.length + normalizedOthers.length;
+    if (d.level === 'error') {
+      normalizedErrors.push(d);
+    }
+    else if (total < maxErrorsToNormalize) {
+      normalizedOthers.push(d);
+    }
+  }
+  return [...normalizedErrors, ...normalizedOthers];
+};
+/**
+ * Perform post-processing on a `Diagnostic` to handle a few message edge cases, massaging error message text and
+ * updating build failure contexts
+ * @param compilerCtx the current compiler
+ * @param diagnostic the diagnostic to normalize
+ * @returns the altered diagnostic
+ */
+const normalizeDiagnostic = (compilerCtx, diagnostic) => {
+  if (diagnostic.messageText) {
+    if (typeof diagnostic.messageText.message === 'string') {
+      diagnostic.messageText = diagnostic.messageText.message;
+    }
+    else if (typeof diagnostic.messageText === 'string' && diagnostic.messageText.indexOf('Error: ') === 0) {
+      diagnostic.messageText = diagnostic.messageText.slice(7);
+    }
+  }
+  if (diagnostic.messageText) {
+    if (diagnostic.messageText.includes(`Cannot find name 'h'`)) {
+      diagnostic.header = `Missing "h" import for JSX types`;
+      diagnostic.messageText = `In order to load accurate JSX types for components, the "h" function must be imported from "@rindo/core" by each component using JSX. For example: import { Component, h } from '@rindo/core';`;
+      try {
+        const sourceText = compilerCtx.fs.readFileSync(diagnostic.absFilePath);
+        const srcLines = splitLineBreaks(sourceText);
+        for (let i = 0; i < srcLines.length; i++) {
+          const srcLine = srcLines[i];
+          if (srcLine.includes('@rindo/core')) {
+            const msgLines = [];
+            const beforeLineIndex = i - 1;
+            if (beforeLineIndex > -1) {
+              const beforeLine = {
+                lineIndex: beforeLineIndex,
+                lineNumber: beforeLineIndex + 1,
+                text: srcLines[beforeLineIndex],
+                errorCharStart: -1,
+                errorLength: -1,
+              };
+              msgLines.push(beforeLine);
+            }
+            const errorLine = {
+              lineIndex: i,
+              lineNumber: i + 1,
+              text: srcLine,
+              errorCharStart: 0,
+              errorLength: -1,
+            };
+            msgLines.push(errorLine);
+            diagnostic.lineNumber = errorLine.lineNumber;
+            diagnostic.columnNumber = srcLine.indexOf('}');
+            const afterLineIndex = i + 1;
+            if (afterLineIndex < srcLines.length) {
+              const afterLine = {
+                lineIndex: afterLineIndex,
+                lineNumber: afterLineIndex + 1,
+                text: srcLines[afterLineIndex],
+                errorCharStart: -1,
+                errorLength: -1,
+              };
+              msgLines.push(afterLine);
+            }
+            diagnostic.lines = msgLines;
+            break;
+          }
+        }
+      }
+      catch (e) { }
+    }
+  }
+  return diagnostic;
+};
+/**
+ * Split a corpus by newlines. Carriage returns are treated a newlines.
+ * @param sourceText the corpus to split
+ * @returns the split text
+ */
+const splitLineBreaks = (sourceText) => {
+  if (typeof sourceText !== 'string')
+    return [];
+  sourceText = sourceText.replace(/\\r/g, '\n');
+  return sourceText.split('\n');
+};
+const escapeHtml = (unsafe) => {
+  if (unsafe === undefined)
+    return 'undefined';
+  if (unsafe === null)
+    return 'null';
+  if (typeof unsafe !== 'string') {
+    unsafe = unsafe.toString();
+  }
+  return unsafe
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;')
+    .replace(/'/g, '&#039;');
+};
+
 const loadRollupDiagnostics = (config, compilerCtx, buildCtx, rollupError) => {
   const formattedCode = formatErrorCode(rollupError.code);
   const diagnostic = {
@@ -1258,6 +1261,8 @@ const formatErrorCode = (errorCode) => {
  * 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$1 = (path) => {
   if (typeof path !== 'string') {
@@ -1393,8 +1398,10 @@ const pathComponents = (path, rootLength) => {
   return [root, ...rest];
 };
 /**
- * Same as normalizePath(), expect it'll also strip any querystrings
+ * Same as normalizePath(), expect it'll also strip any query strings
  * from the path name. So /dir/file.css?tag=cmp-a becomes /dir/file.css
+ * @param p the path to normalize
+ * @returns the normalized path, sans any query strings
  */
 const normalizeFsPath = (p) => normalizePath$1(p.split('?')[0].replace(/\0/g, ''));
 const normalizeFsPathQuery = (importPath) => {
@@ -1570,6 +1577,15 @@ const flattenDiagnosticMessageText = (tsDiagnostic, diag) => {
   return result.trim();
 };
 
+/**
+ * Determines whether a string should be considered a remote url or not.
+ *
+ * This helper only checks the provided string to evaluate is one of a few pre-defined schemes, and should not be
+ * considered all-encompassing
+ *
+ * @param p the string to evaluate
+ * @returns `true` if the provided string is a remote url, `false` otherwise
+ */
 const isRemoteUrl = (p) => {
   if (isString$1(p)) {
     p = p.toLowerCase();
@@ -1639,12 +1655,23 @@ ${docs.tags
     .map((tag) => `@${tag.name} ${(tag.text || '').replace(lineBreakRegex, ' ')}`)
     .join('\n')}`.trim();
 }
+/**
+ * Retrieve a project's dependencies from the current build context
+ * @param buildCtx the current build context to query for a specific package
+ * @returns a list of package names the project is dependent on
+ */
 const getDependencies = (buildCtx) => {
   if (buildCtx.packageJson != null && buildCtx.packageJson.dependencies != null) {
     return Object.keys(buildCtx.packageJson.dependencies).filter((pkgName) => !SKIP_DEPS.includes(pkgName));
   }
   return [];
 };
+/**
+ * Utility to determine whether a project has a dependency on a package
+ * @param buildCtx the current build context to query for a specific package
+ * @param depName the name of the dependency/package
+ * @returns `true` if the project has a dependency a packaged with the provided name, `false` otherwise
+ */
 const hasDependency = (buildCtx, depName) => {
   return getDependencies(buildCtx).includes(depName);
 };
@@ -4523,7 +4550,7 @@ const createCustomResolverAsync = (sys, inMemoryFs, exts) => {
   };
 };
 
-const buildId = '20220810110141';
+const buildId = '20220812071405';
 const minfyJsId = 'terser5.6.1_7';
 const optimizeCssId = 'autoprefixer10.2.5_postcss8.4.16_7';
 const parse5Version = '6.0.1';
@@ -4531,8 +4558,8 @@ const rollupVersion = '2.42.3';
 const sizzleVersion = '2.42.3';
 const terserVersion = '5.6.1';
 const typescriptVersion = '4.5.4';
-const vermoji = '🐩';
-const version$3 = '0.0.0-dev.20220810110141';
+const vermoji = '🛠';
+const version$3 = '2.16.1-0';
 const versions = {
   rindo: version$3,
   parse5: parse5Version,
@@ -12188,7 +12215,7 @@ const createWorkerMessageHandler = (sys) => {
     const fnArgs = msgToWorker.args.slice(1);
     const fn = workerCtx[fnName];
     if (typeof fn === 'function') {
-      return fn.apply(null, fnArgs);
+      return fn(...fnArgs);
     }
   };
 };
@@ -14306,8 +14333,8 @@ function generateBuildStats(config, buildCtx) {
 /**
  * Writes the files from the stats config to the file system
  * @param config the project build configuration
- * @param buildCtx An instance of the build which holds the details about the build
- * @returns
+ * @param data the information to write out to disk (as specified by each stats output target specified in the provided
+ * config)
  */
 async function writeBuildStats(config, data) {
   const statsTargets = config.outputTargets.filter(isOutputTargetStats);
@@ -55956,6 +55983,7 @@ const addDefineCustomElementFunction = (tagNames, newStatements, caseStatements)
  * ```typescript
  * defineCustomElement(MyPrincipalComponent);
  * ```
+ * @param componentName the component's class name to use as the first argument to `defineCustomElement`
  * @returns the expression statement described above
  */
 function createAutoDefinitionExpression(componentName) {
@@ -57331,9 +57359,15 @@ const addLazyElementGetter = (classMembers, moduleFile, cmp) => {
 
 /**
  * Adds static "style" getter within the class
+ * ```typescript
  * const MyComponent = class {
  *   static get style() { return "styles"; }
  * }
+ * ```
+ * @param classMembers a class to existing members of a class. **this parameter will be mutated** rather than returning
+ * a cloned version
+ * @param cmp the metadata associated with the component being evaluated
+ * @param commentOriginalSelector if `true`, add a comment with the original CSS selector to the style.
  */
 const addStaticStyleGetterWithinClass = (classMembers, cmp, commentOriginalSelector) => {
   const styleLiteral = getStyleLiteral(cmp, commentOriginalSelector);
@@ -57343,11 +57377,15 @@ const addStaticStyleGetterWithinClass = (classMembers, cmp, commentOriginalSelec
 };
 /**
  * Adds static "style" property to the class variable.
+ * ```typescript
  * const MyComponent = class {}
  * MyComponent.style = "styles";
+ * ```
+ * @param styleStatements a list of statements containing style assignments to a class
+ * @param cmp the metadata associated with the component being evaluated
  */
-const addStaticStylePropertyToClass = (styleStatements, cmp, commentOriginalSelector) => {
-  const styleLiteral = getStyleLiteral(cmp, commentOriginalSelector);
+const addStaticStylePropertyToClass = (styleStatements, cmp) => {
+  const styleLiteral = getStyleLiteral(cmp, false);
   if (styleLiteral) {
     const statement = t.createStatement(t.createAssignment(t.createPropertyAccess(t.createIdentifier(cmp.componentClassName), 'style'), styleLiteral));
     styleStatements.push(statement);
@@ -57949,7 +57987,7 @@ const updateLazyComponentMembers = (transformOpts, styleStatements, classNode, m
   addWatchers(classMembers, cmp);
   transformHostData(classMembers, moduleFile);
   if (transformOpts.style === 'static') {
-    addStaticStylePropertyToClass(styleStatements, cmp, false);
+    addStaticStylePropertyToClass(styleStatements, cmp);
   }
   return classMembers;
 };
@@ -62800,7 +62838,7 @@ const getRelativeDts = (config, srcPath, emitDtsPath) => {
     emitDtsPath = join(emitDtsPath, '..');
     srcPath = normalizePath$1(join(srcPath, '..'));
   }
-  return join.apply(null, parts.reverse());
+  return join(...parts.reverse());
 };
 
 const outputServiceWorkers = async (config, buildCtx) => {
@@ -63278,9 +63316,16 @@ const createInMemoryFs = (sys) => {
     return data.exists;
   };
   /**
-   * Synchronous!!! Do not use!!!
+   * **Synchronous!!! Do not use!!!**
    * (Only typescript transpiling is allowed to use)
-   * @param filePath
+   *
+   * Synchronously get information about a file from a provided path. This function will attempt to use an in-memory
+   * cache before performing a blocking read.
+   *
+   * In the event of a cache hit, the content from the cache will be returned and skip the read.
+   *
+   * @param filePath the path to the file to read
+   * @returns `true` if the file exists, `false` otherwise
    */
   const accessSync = (filePath) => {
     const item = getItem(filePath);
@@ -63452,9 +63497,19 @@ const createInMemoryFs = (sys) => {
     return fileText;
   };
   /**
-   * Synchronous!!! Do not use!!!
+   * **Synchronous!!! Do not use!!!**
    * (Only typescript transpiling is allowed to use)
-   * @param filePath
+   *
+   * Synchronously read a file from a provided path. This function will attempt to use an in-memory cache before
+   * performing a blocking read in the following circumstances:
+   * - no `opts` are provided
+   * - the `useCache` member on `opts` is set to `true`, or is not set
+   *
+   * In the event of a cache hit, the content from the cache will be returned and skip the read.
+   *
+   * @param filePath the path to the file to read
+   * @param opts a configuration to use when reading a file
+   * @returns the contents of the file (read from either disk or the cache).
    */
   const readFileSync = (filePath, opts) => {
     if (opts == null || opts.useCache === true || opts.useCache === undefined) {
@@ -63547,10 +63602,13 @@ const createInMemoryFs = (sys) => {
     };
   };
   /**
-   * Synchronous!!! Do not use!!!
-   * Always returns an object, does not throw errors.
+   * **Synchronous!!! Do not use!!!**
    * (Only typescript transpiling is allowed to use)
-   * @param itemPath
+   *
+   * Searches an in-memory cache for an item at the provided path. Always returns an object, **does not throw errors**.
+   *
+   * @param itemPath the path to the file to read
+   * @returns an object describing the item found at the provided `itemPath`
    */
   const statSync = (itemPath) => {
     const item = getItem(itemPath);
@@ -65061,7 +65119,7 @@ const getComponentPathContent = (componentGraph, outputTarget) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "0.0.0-dev.20220810110141",
+		version: "2.16.1-0",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",
@@ -66439,7 +66497,7 @@ const validateConfig = (userConfig = {}) => {
   setBooleanConfig(config, 'sourceMap', null, typeof config.sourceMap === 'undefined' ? false : config.sourceMap);
   setBooleanConfig(config, 'watch', 'watch', false);
   setBooleanConfig(config, 'buildDocs', 'docs', !config.devMode);
-  setBooleanConfig(config, 'buildDist', null, !config.devMode || config.buildEs5);
+  setBooleanConfig(config, 'buildDist', 'esm', !config.devMode || config.buildEs5);
   setBooleanConfig(config, 'profile', 'profile', config.devMode);
   setBooleanConfig(config, 'writeLog', 'log', false);
   setBooleanConfig(config, 'buildAppCore', null, true);
@@ -66974,6 +67032,10 @@ const convertStaticToMeta = (config, compilerCtx, buildCtx, typeChecker, collect
 
 /**
  * Stand-alone compiling of a single string
+ * @param config the Rindo configuration to use in the compilation process
+ * @param input the string to compile
+ * @param transformOpts a configuration object for how the string is compiled
+ * @returns the results of compiling the provided input string
  */
 const transpileModule = (config, input, transformOpts) => {
   if (!config.logger) {