quickbundle 0.0.0-next-6c096f7 → 0.0.0-next-63542e6

package/README.md

@@ -10,12 +10,12 @@
 
 Quickbundle allows you to bundle a library in a **quick**, **fast** and **easy** way:
 
--   Fast build and watch mode powered by Rollup[^1] and SWC[^2].
--   Zero configuration: define the build artifacts in your `package.json`, and you're all set!
--   Support of `cjs` & `esm` module formats output.
--   Support of several loaders including JavaScript, TypeScript, JSX, JSON, and Images.
--   TypeScript's declaration file (`.d.ts`) bundling.
--   Automatic dependency inclusion (`peerDependencies` and `dependencies` are not bundled in the final output, `devDependencies` are unless they're not imported).
+- Fast build and watch mode powered by Rollup[^1] and SWC[^2].
+- Zero configuration: define the build artifacts in your `package.json`, and you're all set!
+- Support of `cjs` & `esm` module formats output.
+- Support of several loaders including JavaScript, TypeScript, JSX, JSON, and Images.
+- TypeScript's declaration file (`.d.ts`) bundling.
+- Automatic dependency inclusion (`peerDependencies` and `dependencies` are not bundled in the final output, `devDependencies` are unless they're not imported).
 
 [^1]: A [module bundler](https://rollupjs.org/) optimized for better tree-shaking processing and seamless interoperability of CommonJS and ESM formats with minimal code footprint.
 
@@ -38,7 +38,7 @@ yarn add quickbundle
 
 2️⃣ Set up your package configuration (`package.json`):
 
--   When exporting exclusively ESM format:
+- When exporting exclusively ESM format:
 
 ```jsonc
 {
@@ -63,7 +63,7 @@ yarn add quickbundle
 }
 ```
 
--   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)):
+- 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
 {
@@ -109,14 +109,14 @@ yarn build
 
 By default, Quickbundle does the following built-in optimizations during the bundling process:
 
--   Include, in the build output, only the code that is effectively imported and used in the source code. Setting the `sideEffects` package.json field to `false` marks the package as a side-effect-free one and helps Quickbundle to safely prune unused exports.
--   [Identify and annotate](https://rollupjs.org/configuration-options/#treeshake-annotations) side-effect-free code (functions, ...) to enable a fine-grained dead-code elimination process later consumer side. For example, if a consumer uses only one library API, build output annotations added by Quickbundle allow the consumer's bundler remove all other unused APIs.
+- Include, in the build output, only the code that is effectively imported and used in the source code. Setting the `sideEffects` package.json field to `false` marks the package as a side-effect-free one and helps Quickbundle to safely prune unused exports.
+- [Identify and annotate](https://rollupjs.org/configuration-options/#treeshake-annotations) side-effect-free code (functions, ...) to enable a fine-grained dead-code elimination process later consumer side. For example, if a consumer uses only one library API, build output annotations added by Quickbundle allow the consumer's bundler remove all other unused APIs.
 
 However, Quickbundle doesn't minify the build output. Indeed, in general, **if the build targets a library (the most Quickbundle use case)**, minification is not necessary since enabling it can introduce some challenges:
 
--   Reduce the build output discoverability inside the `node_modules` folder (minified code is an obfuscated code that can be hard to read for code audit/debugging purposes).
--   Generate suboptimal source maps for the bundled library, as the consumer bundler will generate source maps based on the already minified library build (transformed code, mangled variable names, etc.).
--   Risk of side effects with double optimizations (producer side and then consumer side).
+- Reduce the build output discoverability inside the `node_modules` folder (minified code is an obfuscated code that can be hard to read for code audit/debugging purposes).
+- Generate suboptimal source maps for the bundled library, as the consumer bundler will generate source maps based on the already minified library build (transformed code, mangled variable names, etc.).
+- Risk of side effects with double optimizations (producer side and then consumer side).
 
 Popular open source libraries ([Vue](https://unpkg.com/browse/vue@3.4.24/dist/), [SolidJS](https://unpkg.com/browse/solid-js@1.8.17/dist/), [Material UI](https://unpkg.com/browse/@material-ui/core@4.12.4/), ...) do not provide minified builds as the build optimization is sensitive to the consumer context (e.g. environment targets (browser support), ...) and needs to be fully owned upstream (i.e. consumer/application-side).
 
@@ -142,7 +142,7 @@ Enabling source map generation is needed only if a build is [obfuscated (minifie
 
 ## 🤩 Used by
 
--   [@adbayb/stack](https://github.com/adbayb/stack) My opinionated toolbox for JavaScript/TypeScript projects.
+- [@adbayb/stack](https://github.com/adbayb/stack) My opinionated toolbox for JavaScript/TypeScript projects.
 
 <br>
 
@@ -154,8 +154,8 @@ We're open to new contributions, you can find more details [here](./CONTRIBUTING
 
 ## 💙 Acknowledgements
 
--   The backend is powered by [Rollup](https://github.com/rollup/rollup) and its plugin ecosystem (including [SWC](https://github.com/swc-project/swc)) to make blazing-fast builds. A special shoutout to all contributors involved.
--   The zero-configuration approach was inspired by [microbundle](https://github.com/developit/microbundle). A special shoutout to its author [Jason Miller](https://github.com/developit) and [all contributors](https://github.com/developit/microbundle/graphs/contributors).
+- The backend is powered by [Rollup](https://github.com/rollup/rollup) and its plugin ecosystem (including [SWC](https://github.com/swc-project/swc)) to make blazing-fast builds. A special shoutout to all contributors involved.
+- The zero-configuration approach was inspired by [microbundle](https://github.com/developit/microbundle). A special shoutout to its author [Jason Miller](https://github.com/developit) and [all contributors](https://github.com/developit/microbundle/graphs/contributors).
 
 <br>
 

package/bin/index.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-import { createRequire } from "node:module";
 import { join } from "node:path";
+import { createRequire } from "node:module";
 
 const pkg = createRequire(import.meta.url)("../package.json");
 

package/dist/index.mjs

@@ -1,17 +1,34 @@
-#!/usr/bin/env node
 import { helpers, termost } from 'termost';
-import { gzipSize } from 'gzip-size';
-import { rollup, watch as watch$1 } from 'rollup';
-import commonjs from '@rollup/plugin-commonjs';
-import json from '@rollup/plugin-json';
-import { nodeResolve } from '@rollup/plugin-node-resolve';
-import url from '@rollup/plugin-url';
-import { createRequire } from 'node:module';
+import { readFile as readFile$1 } from 'node:fs/promises';
+import process from 'node:process';
+import { watch as watch$1, rollup } from 'rollup';
 import { join } from 'node:path';
-import dts from 'rollup-plugin-dts';
-import externals from 'rollup-plugin-node-externals';
+import { createRequire } from 'node:module';
 import { swc } from 'rollup-plugin-swc3';
-import { readFile as readFile$1 } from 'node:fs/promises';
+import externals from 'rollup-plugin-node-externals';
+import dts from 'rollup-plugin-dts';
+import url from '@rollup/plugin-url';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import json from '@rollup/plugin-json';
+import commonjs from '@rollup/plugin-commonjs';
+import { gzipSize } from 'gzip-size';
+
+const CWD = process.cwd();
+
+const readFile = readFile$1;
+const createCommand = (program, input)=>{
+    return program.command(input).option({
+        key: "minification",
+        name: "minification",
+        description: "Enable minification",
+        defaultValue: false
+    }).option({
+        key: "sourceMaps",
+        name: "source-maps",
+        description: "Enable source maps generation",
+        defaultValue: false
+    });
+};
 
 const onLog = (_, log)=>{
     if (log.message.includes("Generated an empty chunk")) return;
@@ -20,41 +37,51 @@ const isRecord = (value)=>{
     return typeof value === "object" && value !== null && !Array.isArray(value);
 };
 
-const build = async (configurations)=>{
-    process.env.NODE_ENV ??= "production";
-    const output = [];
-    for (const config of configurations){
-        const initialTime = Date.now();
-        const bundle = await rollup({
+const watch = (configurations)=>{
+    process.env.NODE_ENV ??= "development";
+    const watcher = watch$1(configurations.map((config)=>({
             ...config,
             onLog
-        });
-        if (config.output) {
-            const outputEntries = Array.isArray(config.output) ? config.output : [
-                config.output
-            ];
-            const promises = [];
-            for (const outputEntry of outputEntries){
-                const outputFilename = outputEntry.file ?? outputEntry.dir;
-                if (!outputFilename) {
-                    throw new Error("Misconfigured file entry point. Make sure to define an `import`, `require`, or `default` field.");
+        })));
+    let startDuration;
+    console.clear();
+    watcher.on("event", async (event)=>{
+        switch(event.code){
+            case "START":
+                {
+                    startDuration = Date.now();
+                    clearLog(`Build in progress...`, {
+                        type: "information"
+                    });
+                    return;
+                }
+            case "BUNDLE_END":
+                await event.result.close();
+                break;
+            case "END":
+                {
+                    const duration = Date.now() - startDuration;
+                    clearLog(`Build done in ${duration}ms (at ${new Date().toLocaleTimeString()})`, {
+                        type: "success"
+                    });
+                    return;
+                }
+            case "ERROR":
+                {
+                    const { error } = event;
+                    clearLog(error.message, {
+                        type: "error"
+                    });
+                    console.error("\n", error);
+                    return;
                 }
-                promises.push(new Promise((resolve, reject)=>{
-                    bundle.write(outputEntry).then(()=>{
-                        resolve({
-                            elapsedTime: Date.now() - initialTime,
-                            filename: outputFilename
-                        });
-                    }).catch(reject);
-                }));
-            }
-            output.push(...await Promise.all(promises));
         }
-    }
-    return output;
+    });
+};
+const clearLog = (...input)=>{
+    console.clear();
+    helpers.message(...input);
 };
-
-const CWD = process.cwd();
 
 const require = createRequire(import.meta.url);
 const PKG = require(join(CWD, "./package.json"));
@@ -218,24 +245,59 @@ const createTypesConfig = (entryPoints)=>{
         }))
     };
 };
-// eslint-disable-next-line import/no-default-export
 createConfigurations();
 
-const readFile = readFile$1;
-const createCommand = (program, input)=>{
-    return program.command(input).option({
-        key: "minification",
-        name: "minification",
-        description: "Enable minification",
-        defaultValue: false
-    }).option({
-        key: "sourceMaps",
-        name: "source-maps",
-        description: "Enable source maps generation",
-        defaultValue: false
+const createWatchCommand = (program)=>{
+    return createCommand(program, {
+        name: "watch",
+        description: "Watch and rebuild on any code change (development mode)"
+    }).task({
+        handler (context) {
+            watch(createConfigurations({
+                minification: context.minification,
+                sourceMaps: context.sourceMaps,
+                standalone: false
+            }));
+        }
     });
 };
 
+const build = async (configurations)=>{
+    process.env.NODE_ENV ??= "production";
+    const output = [];
+    for (const config of configurations){
+        const initialTime = Date.now();
+        const bundle = await rollup({
+            ...config,
+            onLog
+        });
+        if (config.output) {
+            const outputEntries = Array.isArray(config.output) ? config.output : [
+                config.output
+            ];
+            const promises = [];
+            for (const outputEntry of outputEntries){
+                const outputFilename = outputEntry.file ?? outputEntry.dir;
+                if (!outputFilename) {
+                    throw new Error("Misconfigured file entry point. Make sure to define an `import`, `require`, or `default` field.");
+                }
+                promises.push(new Promise((resolve, reject)=>{
+                    bundle.write(outputEntry).then(()=>{
+                        resolve({
+                            elapsedTime: Date.now() - initialTime,
+                            filename: outputFilename
+                        });
+                    }).catch((reason)=>{
+                        reject(reason);
+                    });
+                }));
+            }
+            output.push(...await Promise.all(promises));
+        }
+    }
+    return output;
+};
+
 const createBuildCommand = (program)=>{
     return createCommand(program, {
         name: "build",
@@ -295,67 +357,6 @@ const formatSize = (bytes)=>{
     return kiloBytes < 1 ? `${bytes} B` : `${kiloBytes.toFixed(2)} kB`;
 };
 
-const watch = (configurations)=>{
-    process.env.NODE_ENV ??= "development";
-    const watcher = watch$1(configurations.map((config)=>({
-            ...config,
-            onLog
-        })));
-    let startDuration;
-    console.clear();
-    watcher.on("event", async (event)=>{
-        switch(event.code){
-            case "START":
-                {
-                    startDuration = Date.now();
-                    clearLog(`Build in progress...`, {
-                        type: "information"
-                    });
-                    return;
-                }
-            case "BUNDLE_END":
-                await event.result.close();
-                break;
-            case "END":
-                {
-                    const duration = Date.now() - startDuration;
-                    clearLog(`Build done in ${duration}ms (at ${new Date().toLocaleTimeString()})`, {
-                        type: "success"
-                    });
-                    return;
-                }
-            case "ERROR":
-                {
-                    const { error } = event;
-                    clearLog(`${String(error)}`, {
-                        type: "error"
-                    });
-                    console.error("\n", error);
-                    return;
-                }
-        }
-    });
-};
-const clearLog = (...input)=>{
-    console.clear();
-    helpers.message(...input);
-};
-
-const createWatchCommand = (program)=>{
-    return createCommand(program, {
-        name: "watch",
-        description: "Watch and rebuild on any code change (development mode)"
-    }).task({
-        handler (context) {
-            watch(createConfigurations({
-                minification: context.minification,
-                sourceMaps: context.sourceMaps,
-                standalone: false
-            }));
-        }
-    });
-};
-
 const createProgram = (...commandBuilders)=>{
     const program = termost("The zero-configuration transpiler and bundler for the web");
     for (const commandBuilder of commandBuilders){

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickbundle",
-  "version": "0.0.0-next-6c096f7",
+  "version": "0.0.0-next-63542e6",
   "description": "The zero-configuration transpiler and bundler for the web",
   "author": {
     "name": "Ayoub Adib",
@@ -40,7 +40,7 @@
     }
   },
   "peerDependencies": {
-    "typescript": ">=4.7.0"
+    "typescript": "^4.7.0 || ^5.0.0"
   },
   "peerDependenciesMeta": {
     "typescript": {