@rindo/core 3.0.0-rc.1 → 3.0.1

package/cli/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI (CommonJS) v3.0.0-rc.1 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI (CommonJS) v3.0.1 | MIT Licensed | https://rindojs.web.app
  */
 'use strict';
 
@@ -987,7 +987,7 @@ const dereferenceAlias = (maybeAlias) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "3.0.0-rc.1",
+		version: "3.0.1",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",

package/cli/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo CLI v3.0.0-rc.1 | MIT Licensed | https://rindojs.web.app
+ Rindo CLI v3.0.1 | MIT Licensed | https://rindojs.web.app
  */
 /**
  * Convert a string from dash-case / kebab-case to PascalCase (or CamelCase,
@@ -963,7 +963,7 @@ const dereferenceAlias = (maybeAlias) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "3.0.0-rc.1",
+		version: "3.0.1",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",

package/cli/package.json

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

package/compiler/package.json

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

package/compiler/rindo.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Compiler v3.0.0-rc.1 | MIT Licensed | https://rindojs.web.app
+ Rindo Compiler v3.0.1 | MIT Licensed | https://rindojs.web.app
  */
 (function(exports) {
 'use strict';
@@ -265,10 +265,28 @@ const dashToPascalCase$1 = (str) => str
   .split('-')
   .map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
   .join('');
+/**
+ * Capitalize the first letter of a string
+ *
+ * @param str the string to capitalize
+ * @returns a capitalized string
+ */
 const toTitleCase = (str) => str.charAt(0).toUpperCase() + str.slice(1);
+/**
+ * This is just a no-op, don't expect it to do anything.
+ */
 const noop$1 = () => {
   /* noop*/
 };
+/**
+ * Sort an array without mutating it in-place (as `Array.prototype.sort`
+ * unfortunately does)
+ *
+ * @param array the array you'd like to sort
+ * @param prop a function for deriving sortable values (strings or numbers)
+ * from array members
+ * @returns a new array of all items `x` in `array` ordered by `prop(x)`
+ */
 const sortBy = (array, prop) => {
   return array.slice().sort((a, b) => {
     const nameA = prop(a);
@@ -280,6 +298,14 @@ const sortBy = (array, prop) => {
     return 0;
   });
 };
+/**
+ * A polyfill of sorts for `Array.prototype.flat` which will return the result
+ * of calling that method if present and, if not, return an equivalent based on
+ * `Array.prototype.reduce`.
+ *
+ * @param array the array to flatten (one level)
+ * @returns a flattened array
+ */
 const flatOne = (array) => {
   if (array.flat) {
     return array.flat(1);
@@ -289,6 +315,17 @@ const flatOne = (array) => {
     return result;
   }, []);
 };
+/**
+ * Deduplicate an array, retaining items at the earliest position in which
+ * they appear.
+ *
+ * So `unique([1,3,2,1,1,4])` would be `[1,3,2,4]`.
+ *
+ * @param array the array to deduplicate
+ * @param predicate an optional function used to generate the key used to
+ * determine uniqueness
+ * @returns a new, deduplicated array
+ */
 const unique = (array, predicate = (i) => i) => {
   const set = new Set();
   return array.filter((item) => {
@@ -303,6 +340,14 @@ const unique = (array, predicate = (i) => i) => {
     return true;
   });
 };
+/**
+ * A utility for building an object from an iterable very similar to
+ * `Object.fromEntries`
+ *
+ * @param entries an iterable object holding entries (key-value tuples) to
+ * plop into a new object
+ * @returns an object containing those entries
+ */
 const fromEntries = (entries) => {
   const object = {};
   for (const [key, value] of entries) {
@@ -310,6 +355,15 @@ const fromEntries = (entries) => {
   }
   return object;
 };
+/**
+ * Based on a given object, create a new object which has only the specified
+ * key-value pairs included in it.
+ *
+ * @param obj the object from which to take values
+ * @param keys a set of keys to take
+ * @returns an object mapping `key` to `obj[key]` if `obj[key]` is truthy for
+ * every `key` in `keys`
+ */
 const pluck = (obj, keys) => {
   return keys.reduce((final, key) => {
     if (obj[key]) {
@@ -2101,7 +2155,7 @@ const process$3 = /*#__PURE__*/Object.assign(/*#__PURE__*/Object.create(null), p
   'default': process_1
 });
 
-const buildId = '20230405141100';
+const buildId = '20230406093613';
 const minfyJsId = 'terser5.16.1_7';
 const optimizeCssId = 'autoprefixer10.4.13_postcss8.4.21_7';
 const parse5Version = '7.1.2';
@@ -2109,8 +2163,8 @@ const rollupVersion = '2.42.3';
 const sizzleVersion = '2.42.3';
 const terserVersion = '5.16.1';
 const typescriptVersion = '4.9.4';
-const vermoji = '🐏';
-const version$3 = '3.0.0-rc.1';
+const vermoji = '🐸';
+const version$3 = '3.0.1';
 const versions = {
   rindo: version$3,
   parse5: parse5Version,
@@ -13438,9 +13492,28 @@ function isValidConfigOutputTarget(targetType) {
 }
 const GENERATED_DTS = 'components.d.ts';
 
+/**
+ * Derive a {@link ts.CompilerOptions} object from the options currently set
+ * on the user-supplied configuration object.
+ *
+ * Some of these options (like the `module` setting) are hardcoded here, but
+ * the following are derived from the configuration object:
+ *
+ * - if one of the output targets requires type declaration output (i.e. the
+ *   {@link d.OutputTargetDistCustomElements.generateTypeDeclarations} option
+ *   is set to `true`) then we'll set `declaration: true`
+ * - the `outDir` is set to the configured cache directory
+ * - the `sourceMap` and `inlineSources` options are set based on the user's
+ *   {@link d.Config.sourceMap} configuration
+ *
+ * @param config the current user-supplied configuration
+ * @returns an object containing TypeScript compiler options
+ */
 const getTsOptionsToExtend = (config) => {
   const tsOptions = {
     experimentalDecorators: true,
+    // if the `DIST_TYPES` output target is present then we'd like to emit
+    // declaration files
     declaration: config.outputTargets.some(isOutputTargetDistTypes),
     module: t.ModuleKind.ESNext,
     moduleResolution: t.ModuleResolutionKind.NodeJs,
@@ -58105,6 +58178,7 @@ const generateHydrateFactory = async (config, compilerCtx, buildCtx) => {
           intro: HYDRATE_FACTORY_INTRO,
           outro: HYDRATE_FACTORY_OUTRO,
           preferConst: false,
+          inlineDynamicImports: true,
         });
         if (!buildCtx.hasError && rollupOutput != null && Array.isArray(rollupOutput.output)) {
           return rollupOutput.output[0].code;
@@ -58250,6 +58324,14 @@ function getUserConfigBundles(config, buildCtx, cmps) {
 
 /**
  * Generate a list of all component tags that will be used by the output
+ *
+ * If the user has set the {@link d.Config.excludeUnusedDependencies} option
+ * to `false` then this simply returns all components.
+ *
+ * Else, this takes {@link d.ComponentCompilerMeta} objects which are being
+ * used in the current output and then ensures that all used components as well
+ * as their dependencies are present.
+ *
  * @param config the Rindo configuration used for the build
  * @param defaultBundles metadata of the assumed components being used/bundled
  * @param allCmps all known components
@@ -58282,25 +58364,32 @@ function computeUsedComponents(config, defaultBundles, allCmps) {
 }
 /**
  * Generate the bundles that will be used during the bundling process
+ *
+ * This gathers information about all of the components used in the build,
+ * including the bundles which will be included by default, and then returns a
+ * deduplicated list of all the bundles which need to be present.
+ *
  * @param config the Rindo configuration used for the build
  * @param buildCtx the current build context
  * @returns the bundles to be used during the bundling process
  */
 function generateComponentBundles(config, buildCtx) {
-  const cmps = sortBy(buildCtx.components, (cmp) => cmp.dependents.length);
-  const defaultBundles = getDefaultBundles(config, buildCtx, cmps);
-  const usedComponents = computeUsedComponents(config, defaultBundles, cmps);
+  const components = sortBy(buildCtx.components, (cmp) => cmp.dependents.length);
+  const defaultBundles = getDefaultBundles(config, buildCtx, components);
+  // this is most likely all the components
+  const usedComponents = computeUsedComponents(config, defaultBundles, components);
   if (config.devMode) {
-    return cmps
+    // return only components used in the build
+    return components
       .filter((c) => usedComponents.has(c.tagName))
       .map((cmp) => [cmp]);
   }
-  // Visit components that are already in one of the default bundlers
+  // Visit components that are already in one of the default bundles
   const alreadyBundled = new Set();
   defaultBundles.forEach((entry) => {
     entry.forEach((cmp) => alreadyBundled.add(cmp));
   });
-  const bundlers = cmps
+  const bundlers = components
     .filter((cmp) => usedComponents.has(cmp.tagName) && !alreadyBundled.has(cmp))
     .map((c) => [c]);
   return [...defaultBundles, ...optimizeBundlers(bundlers, 0.6)].filter((b) => b.length > 0);
@@ -59100,7 +59189,13 @@ const getLazyCustomTransformer = (config, compilerCtx) => {
   ];
 };
 /**
- * Generate entry modules to be used by the build process by determining how modules and components are connected
+ * Generate entry modules to be used by the build process by determining how
+ * modules and components are connected
+ *
+ * **Note**: this function mutates the {@link d.BuildCtx} object that is
+ * passed in to it, assigning the generated entry modules to the `entryModules`
+ * property
+ *
  * @param config the Rindo configuration file that was provided as a part of the build step
  * @param buildCtx the current build context
  */
@@ -70008,7 +70103,7 @@ const getComponentPathContent = (componentGraph, outputTarget) => {
 const dependencies = [
 	{
 		name: "@rindo/core",
-		version: "3.0.0-rc.1",
+		version: "3.0.1",
 		main: "compiler/rindo.js",
 		resources: [
 			"package.json",