quickbundle 2.2.0 → 2.4.0

package/README.md

@@ -34,15 +34,44 @@ yarn add quickbundle
 
 2️⃣ Set up your package configuration (`package.json`):
 
+-   When exporting exclusively ESM format:
+
+```jsonc
+{
+	"name": "lib", // Package name
+	"exports": {
+		".": {
+			"source": "src/index.ts(x)?", // Source code entry point.
+			"types": "./dist/index.d.ts", // Typing output file (if defined, can increase build time). This condition should always come first after the custom `source` field definition.
+			"default": "./dist/index.mjs", // By default, Quickbundle will always output ESM format for the `default` field (this condition should always come last since it always matches as a generic fallback). However, take care: if both `import` and `default` fields are defined, provide the same file path, as the `import` field export instruction will be the only one considered to define the output file path.
+		},
+		"./otherModulePath": {
+			// ...
+		}
+	}
+	"scripts": {
+		"build": "quickbundle build", // Production mode (optimizes bundle)
+		"watch": "quickbundle watch", // Development mode (watches each file change)
+	},
+	// ...
+}
+```
+
+-   When exporting both CommonJS (CJS) and ECMAScript Modules (ESM) format (please be aware of [dual package hazard risk](https://nodejs.org/api/packages.html#dual-package-hazard)):
+
 ```jsonc
 {
 	"name": "lib", // Package name
 	"exports": {
 		".": {
-			"source": "src/index.ts(x)?", // Source code entrypoint
-			"types": "./dist/index.d.ts", // Typing output file (if defined, can increase build time)
-			"import": "./dist/index.mjs", // ESM output file
-			"require": "./dist/index.cjs" // CommonJS output file
+			"source": "src/index.ts(x)?", // Source code entry point.
+			"types": "./dist/index.d.ts", // // Typing output file (if defined, can increase build time). This condition should always come first after the custom `source` field definition.
+			"require": "./dist/index.cjs", // CommonJS output file (matches when the module is loaded via require() consumer side).
+			"import": "./dist/index.mjs", // ESM output file (matches when the package is loaded via import or import() consumer side).
+			"default": "./dist/index.mjs", // By default, Quickbundle will always output ESM format for the `default` field (this condition should always come last since it always matches as a generic fallback). However, take care: if both `import` and `default` fields are defined, provide the same file path, as the `import` field export instruction will be the only one considered to define the output file path.
+		},
+		"./otherModulePath": {
+			// ...
 		}
 	}
 	"scripts": {

package/dist/index.js

@@ -16,6 +16,9 @@ import { readFile as readFile$1 } from 'node:fs/promises';
 const onLog = (_, log)=>{
     if (log.message.includes("Generated an empty chunk")) return;
 };
+const isRecord = (value)=>{
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+};
 
 const build = async (configurations)=>{
     var _process_env;
@@ -60,6 +63,20 @@ const createConfigurations = (options = {
     minification: false,
     sourceMaps: false
 })=>{
+    return getBuildableExports().flatMap((buildableExport)=>{
+        return [
+            buildableExport.source && createMainConfig({
+                ...buildableExport,
+                source: buildableExport.source
+            }, options),
+            buildableExport.source && buildableExport.types && createTypesConfig({
+                source: buildableExport.source,
+                types: buildableExport.types
+            })
+        ].filter(Boolean);
+    });
+};
+const getBuildableExports = ()=>{
     /**
 	 * Entry-point resolution:
 	 * Following the [package entry-point specification](https://nodejs.org/api/packages.html#package-entry-points),
@@ -68,33 +85,49 @@ const createConfigurations = (options = {
 	 */ if (PKG.main ?? PKG.module ?? PKG.types ?? !PKG.exports) {
         throw new Error("Invalid package entry points contract. Use the recommended [`exports` field](https://nodejs.org/api/packages.html#package-entry-points) instead and, for TypeScript-based projects, update the `tsconfig.json` file to resolve it properly (`moduleResolution` must be set to `Bundler` (or `NodeNext`)).");
     }
-    const outputEntryPointFields = [
+    const buildableExportFields = [
+        "default",
         "import",
         "require",
         "types"
     ];
-    const output = Object.entries(PKG.exports).flatMap(([name, entryPoints])=>{
-        if (typeof entryPoints === "string") return [];
-        const entryPointKeys = Object.keys(entryPoints);
-        if (entryPointKeys.includes("source")) {
-            const hasAtLeastOneRequiredField = outputEntryPointFields.some((field)=>entryPointKeys.includes(field));
-            if (!hasAtLeastOneRequiredField) {
-                throw new Error(`A \`source\` field is defined without a provided output target for the \`${name}\` export. Make sure to define at least one entry point (including ${outputEntryPointFields.join(", ")})`);
+    let singleExport = undefined;
+    const output = Object.entries(PKG.exports).map(([field, value])=>{
+        if (isRecord(value)) {
+            return [
+                field,
+                value
+            ];
+        }
+        if ([
+            "source",
+            ...buildableExportFields
+        ].includes(field)) {
+            if (!singleExport) {
+                singleExport = {};
+                singleExport[field] = value;
+                return [
+                    ".",
+                    singleExport
+                ];
             }
+            singleExport[field] = value;
         }
-        return [
-            entryPoints.source && createMainConfig({
-                ...entryPoints,
-                source: entryPoints.source
-            }, options),
-            entryPoints.source && entryPoints.types && createTypesConfig({
-                source: entryPoints.source,
-                types: entryPoints.types
-            })
-        ].filter(Boolean);
-    });
+        return undefined;
+    }).reduce((buildableExports, currentExport)=>{
+        if (!currentExport) return buildableExports;
+        const [exportField, exportValue] = currentExport;
+        const conditionalExportFields = Object.keys(exportValue);
+        if (!conditionalExportFields.includes("source")) return buildableExports;
+        const hasAtLeastOneRequiredField = buildableExportFields.some((entryPointField)=>conditionalExportFields.includes(entryPointField));
+        if (hasAtLeastOneRequiredField) {
+            buildableExports.push(exportValue);
+            return buildableExports;
+        }
+        throw new Error(`A \`source\` field is defined without an output defined for the \`${exportField}\` export. Make sure to define at least one conditional entry point (including ${buildableExportFields.map((field)=>`\`${field}\``).join(", ")})`);
+    }, []);
     if (output.length === 0) {
-        throw new Error("No `source` field is set for the targeted package. If a build step is necessary, make sure to configure at least one `source` field in the package `exports` contract.");
+        throw new Error("No `source` field is set for the targeted package. If a build step is necessary, make sure to configure at least one `source` field in the package `exports` contract. If not, do not execute quickbundle on this package.");
     }
     return output;
 };
@@ -127,14 +160,18 @@ const getPlugins = (...customPlugins)=>{
 };
 const createMainConfig = (entryPoints, options)=>{
     const { minification, sourceMaps } = options;
+    const esmInput = entryPoints.import ?? entryPoints.default;
+    if (entryPoints.import && entryPoints.default && entryPoints.import !== entryPoints.default) {
+        throw new Error("Both `import` and `default` export fields have been defined but with different values. To preserve proper `default` field resolution on the consumer side (i.e. to target ESM format), make sure to provide the same file path for both fields.");
+    }
     const output = [
         entryPoints.require && {
             file: entryPoints.require,
             format: "cjs",
             sourcemap: sourceMaps
         },
-        entryPoints.import && {
-            file: entryPoints.import,
+        esmInput && {
+            file: esmInput,
             format: "es",
             sourcemap: sourceMaps
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickbundle",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "The zero-configuration transpiler and bundler for the web",
   "author": {
     "name": "Ayoub Adib",