@stencil/core 2.12.0 → 2.12.1

package/cli/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Stencil CLI (CommonJS) v2.12.0 | MIT Licensed | https://stenciljs.com
+ Stencil CLI (CommonJS) v2.12.1 | MIT Licensed | https://stenciljs.com
  */
 'use strict';
 
@@ -33,6 +33,16 @@ const dashToPascalCase = (str) => toLowerCase(str)
 const isFunction = (v) => typeof v === 'function';
 const isString = (v) => typeof v === 'string';
 
+/**
+ * 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
+ * to attach the specifics of the error message.
+ *
+ * The created `Diagnostic` is pushed to the `diagnostics` argument as a side effect of calling this method.
+ *
+ * @param diagnostics the existing diagnostics that the created template `Diagnostic` should be added to
+ * @returns the created `Diagnostic`
+ */
 const buildError = (diagnostics) => {
     const diagnostic = {
         level: 'error',
@@ -79,6 +89,12 @@ const catchError = (diagnostics, err, msg) => {
     }
     return diagnostic;
 };
+/**
+ * Determine if the provided diagnostics have any build errors
+ * @param diagnostics the diagnostics to inspect
+ * @returns true if any of the diagnostics in the list provided are errors that did not occur at runtime. false
+ * otherwise.
+ */
 const hasError = (diagnostics) => {
     if (diagnostics == null || diagnostics.length === 0) {
         return false;
@@ -490,7 +506,7 @@ const getNpmConfigEnvArgs = (sys) => {
 const dependencies = [
 	{
 		name: "@stencil/core",
-		version: "2.12.0",
+		version: "2.12.1",
 		main: "compiler/stencil.js",
 		resources: [
 			"package.json",

package/cli/index.js

@@ -1,5 +1,5 @@
 /*!
- Stencil CLI v2.12.0 | MIT Licensed | https://stenciljs.com
+ Stencil CLI v2.12.1 | MIT Licensed | https://stenciljs.com
  */
 const toLowerCase = (str) => str.toLowerCase();
 const dashToPascalCase = (str) => toLowerCase(str)
@@ -9,6 +9,16 @@ const dashToPascalCase = (str) => toLowerCase(str)
 const isFunction = (v) => typeof v === 'function';
 const isString = (v) => typeof v === 'string';
 
+/**
+ * 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
+ * to attach the specifics of the error message.
+ *
+ * The created `Diagnostic` is pushed to the `diagnostics` argument as a side effect of calling this method.
+ *
+ * @param diagnostics the existing diagnostics that the created template `Diagnostic` should be added to
+ * @returns the created `Diagnostic`
+ */
 const buildError = (diagnostics) => {
     const diagnostic = {
         level: 'error',
@@ -55,6 +65,12 @@ const catchError = (diagnostics, err, msg) => {
     }
     return diagnostic;
 };
+/**
+ * Determine if the provided diagnostics have any build errors
+ * @param diagnostics the diagnostics to inspect
+ * @returns true if any of the diagnostics in the list provided are errors that did not occur at runtime. false
+ * otherwise.
+ */
 const hasError = (diagnostics) => {
     if (diagnostics == null || diagnostics.length === 0) {
         return false;
@@ -466,7 +482,7 @@ const getNpmConfigEnvArgs = (sys) => {
 const dependencies = [
 	{
 		name: "@stencil/core",
-		version: "2.12.0",
+		version: "2.12.1",
 		main: "compiler/stencil.js",
 		resources: [
 			"package.json",

package/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stencil/core/cli",
-  "version": "2.12.0",
+  "version": "2.12.1",
   "description": "Stencil CLI.",
   "main": "./index.cjs",
   "module": "./index.js",

package/compiler/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stencil/core/compiler",
-  "version": "2.12.0",
+  "version": "2.12.1",
   "description": "Stencil Compiler.",
   "main": "./stencil.js",
   "types": "./stencil.d.ts",

package/compiler/stencil.js

@@ -1,5 +1,5 @@
 /*!
- Stencil Compiler v2.12.0 | MIT Licensed | https://stenciljs.com
+ Stencil Compiler v2.12.1 | MIT Licensed | https://stenciljs.com
  */
 (function(exports) {
 'use strict';
@@ -832,6 +832,12 @@ 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 = [];
@@ -853,6 +859,13 @@ const normalizeDiagnostics = (compilerCtx, diagnostics) => {
   }
   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') {
@@ -915,6 +928,11 @@ const normalizeDiagnostic = (compilerCtx, diagnostic) => {
   }
   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 [];
@@ -938,6 +956,16 @@ const escapeHtml = (unsafe) => {
 };
 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
+ * to attach the specifics of the error message.
+ *
+ * The created `Diagnostic` is pushed to the `diagnostics` argument as a side effect of calling this method.
+ *
+ * @param diagnostics the existing diagnostics that the created template `Diagnostic` should be added to
+ * @returns the created `Diagnostic`
+ */
 const buildError = (diagnostics) => {
   const diagnostic = {
     level: 'error',
@@ -953,6 +981,16 @@ const buildError = (diagnostics) => {
   }
   return diagnostic;
 };
+/**
+ * Builds a template `Diagnostic` entity for a build warning. The created `Diagnostic` is returned, and have little
+ * detail attached to it regarding the specifics of the warning - it is the responsibility of the caller of this method
+ * to attach the specifics of the warning message.
+ *
+ * The created `Diagnostic` is pushed to the `diagnostics` argument as a side effect of calling this method.
+ *
+ * @param diagnostics the existing diagnostics that the created template `Diagnostic` should be added to
+ * @returns the created `Diagnostic`
+ */
 const buildWarn = (diagnostics) => {
   const diagnostic = {
     level: 'warn',
@@ -1047,12 +1085,23 @@ const catchError = (diagnostics, err, msg) => {
   }
   return diagnostic;
 };
+/**
+ * Determine if the provided diagnostics have any build errors
+ * @param diagnostics the diagnostics to inspect
+ * @returns true if any of the diagnostics in the list provided are errors that did not occur at runtime. false
+ * otherwise.
+ */
 const hasError = (diagnostics) => {
   if (diagnostics == null || diagnostics.length === 0) {
     return false;
   }
   return diagnostics.some((d) => d.level === 'error' && d.type !== 'runtime');
 };
+/**
+ * Determine if the provided diagnostics have any warnings
+ * @param diagnostics the diagnostics to inspect
+ * @returns true if any of the diagnostics in the list provided are warnings. false otherwise.
+ */
 const hasWarning = (diagnostics) => {
   if (diagnostics == null || diagnostics.length === 0) {
     return false;
@@ -1355,6 +1404,12 @@ const normalizeFsPathQuery = (importPath) => {
   };
 };
 
+/**
+ * Augment a `Diagnostic` with information from a `Node` in the AST to provide richer error information
+ * @param d the diagnostic to augment
+ * @param node the node to augment with additional information
+ * @returns the augmented diagnostic
+ */
 const augmentDiagnosticWithNode = (d, node) => {
   if (!node) {
     return d;
@@ -1376,6 +1431,7 @@ const augmentDiagnosticWithNode = (d, node) => {
     errorCharStart: posStart.character,
     errorLength: Math.max(end - start, 1),
   };
+  // store metadata for line number and character index where the error occurred
   d.lineNumber = errorLine.lineNumber;
   d.columnNumber = errorLine.errorCharStart + 1;
   d.lines.push(errorLine);
@@ -1383,6 +1439,8 @@ const augmentDiagnosticWithNode = (d, node) => {
     errorLine.errorLength = 1;
     errorLine.errorCharStart--;
   }
+  // if the error did not occur on the first line of the file, add metadata for the line of code preceding the line
+  // where the error was detected to provide the user with additional context
   if (errorLine.lineIndex > 0) {
     const previousLine = {
       lineIndex: errorLine.lineIndex - 1,
@@ -1393,6 +1451,8 @@ const augmentDiagnosticWithNode = (d, node) => {
     };
     d.lines.unshift(previousLine);
   }
+  // if the error did not occur on the last line of the file, add metadata for the line of code following the line
+  // where the error was detected to provide the user with additional context
   if (errorLine.lineIndex + 1 < srcLines.length) {
     const nextLine = {
       lineIndex: errorLine.lineIndex + 1,
@@ -3917,7 +3977,7 @@ const createCustomResolverAsync = (sys, inMemoryFs, exts) => {
   };
 };
 
-const buildId = '20211213135416';
+const buildId = '20220104181231';
 const minfyJsId = 'terser5.6.1_7';
 const optimizeCssId = 'autoprefixer10.2.5_postcss8.2.8_7';
 const parse5Version = '6.0.1';
@@ -3925,8 +3985,8 @@ const rollupVersion = '2.42.3';
 const sizzleVersion = '2.42.3';
 const terserVersion = '5.6.1';
 const typescriptVersion = '4.3.5';
-const vermoji = '⛸';
-const version$3 = '2.12.0';
+const vermoji = '🍔';
+const version$3 = '2.12.1';
 const versions = {
   stencil: version$3,
   parse5: parse5Version,
@@ -13769,6 +13829,11 @@ function relativePath$1(config, file) {
   return config.sys.normalizePath(config.sys.platformPath.relative(config.rootDir, file));
 }
 
+/**
+ * Finish a build as having completed successfully
+ * @param buildCtx the build context for the build being aborted
+ * @returns the build results
+ */
 const buildFinish = async (buildCtx) => {
   const results = await buildDone(buildCtx.config, buildCtx.compilerCtx, buildCtx, false);
   const buildLog = {
@@ -13779,9 +13844,23 @@ const buildFinish = async (buildCtx) => {
   buildCtx.compilerCtx.events.emit('buildLog', buildLog);
   return results;
 };
+/**
+ * Finish a build early due to failure. During the build process, a fatal error has occurred where the compiler cannot
+ * continue further
+ * @param buildCtx the build context for the build being aborted
+ * @returns the build results
+ */
 const buildAbort = (buildCtx) => {
   return buildDone(buildCtx.config, buildCtx.compilerCtx, buildCtx, true);
 };
+/**
+ * Mark a build as done
+ * @param config the Stencil configuration used for the build
+ * @param compilerCtx the compiler context associated with the build
+ * @param buildCtx the build context associated with the build to mark as done
+ * @param aborted true if the build ended early due to failure, false otherwise
+ * @returns the build results
+ */
 const buildDone = async (config, compilerCtx, buildCtx, aborted) => {
   if (buildCtx.hasFinished && buildCtx.buildResults) {
     // we've already marked this build as finished and
@@ -13799,7 +13878,7 @@ const buildDone = async (config, compilerCtx, buildCtx, aborted) => {
   if (!buildCtx.hasFinished) {
     // haven't set this build as finished yet
     if (!buildCtx.hasPrintedResults) {
-      cleanDiagnostics(config, buildCtx.buildResults.diagnostics);
+      cleanDiagnosticsRelativePath(config, buildCtx.buildResults.diagnostics);
       config.logger.printDiagnostics(buildCtx.buildResults.diagnostics);
     }
     const hasChanges = buildCtx.hasScriptChanges || buildCtx.hasStyleChanges;
@@ -13808,7 +13887,7 @@ const buildDone = async (config, compilerCtx, buildCtx, aborted) => {
       // and this build hasn't been aborted
       logHmr(config.logger, buildCtx);
     }
-    // create a nice pretty message stating what happend
+    // create a nice pretty message stating what happened
     const buildText = buildCtx.isRebuild ? 'rebuild' : 'build';
     const watchText = config.watch ? ', watching for changes...' : '';
     let buildStatus = 'finished';
@@ -13894,7 +13973,12 @@ const cleanupUpdateMsg = (logger, msg, fileNames) => {
     logger.info(`${msg}: ${logger.cyan(fileMsg)}`);
   }
 };
-const cleanDiagnostics = (config, diagnostics) => {
+/**
+ * Update the relative file path for diagnostics. The updates are done in place.
+ * @param config the Stencil configuration associated with the current build
+ * @param diagnostics the diagnostics to update
+ */
+const cleanDiagnosticsRelativePath = (config, diagnostics) => {
   diagnostics.forEach((diagnostic) => {
     if (!diagnostic.relFilePath && !isRemoteUrl(diagnostic.absFilePath) && diagnostic.absFilePath && config.rootDir) {
       diagnostic.relFilePath = relative$1(config.rootDir, diagnostic.absFilePath);
@@ -63574,7 +63658,7 @@ const getComponentPathContent = (componentGraph, outputTarget) => {
 const dependencies = [
 	{
 		name: "@stencil/core",
-		version: "2.12.0",
+		version: "2.12.1",
 		main: "compiler/stencil.js",
 		resources: [
 			"package.json",