@hypernym/bundler 0.11.0 → 0.13.0

package/README.md

@@ -14,7 +14,9 @@
 
 <pre align="center">pnpm add -D @hypernym/bundler</pre>
 
-<h4 align="center">Hypernym Studio</h4>
+<p align="center">
+  <strong>Hypernym Studio</strong>
+</p>
 
 <br>
 
@@ -34,10 +36,6 @@
 
 1. Create a `bundler.config.ts` file at the root of your project:
 
-> [!NOTE]
->
-> Configuration also accepts `.js`, `.mjs`, `.ts`, `.mts` formats.
-
 ```ts
 // bundler.config.ts
 
@@ -64,9 +62,7 @@ export default defineConfig({
     {
       input: './src/utils/index.ts',
       output: './dist/utils/utils.min.mjs',
-      transformers: {
-        esbuild: { minify: true },
-      },
+      minify: true,
     },
     // ...
   ],
@@ -79,35 +75,33 @@ export default defineConfig({
 npx hyperbundler
 ```
 
-<details>
-<summary>CLI Output</summary>
+## Config
 
-<br>
-<p>Example of CLI Output:</p>
-
-```txt
-┌─────────────────┐
-│ ✦✦ HYPERBUNDLER │ v0.11.0
-└─────────────────┘
-i Config bundler.config.ts
-i Bundling started...
-* Processing [8:07:26 PM] Transforming files
-│
-├─ + esm ./dist/index.mjs (50ms) 313 B
-├─ + dts ./dist/types/index.d.ts (1.23s) 13.61 KB
-├─ + esm ./dist/bin/index.mjs (119ms) 16.53 KB
-│
-* Succeeded [8:07:28 PM] Module transformation is done
-✔ Bundling fully completed in 1.40s
-✔ 3 modules transformed. Total size is 30.45 KB
-✦✦ HYPERBUNDLER [8:07:28 PM] Bundle is generated and ready for production
+`Hyperbundler` automatically detects custom configuration from the project root that can override or extend the build behavior.
+
+Configuration file also accepts `.js`, `.mjs`, `.ts`, `.mts` formats.
+
+```ts
+// bundler.config.{js,mjs,ts,mts}
+
+import { defineConfig } from '@hypernym/bundler'
+
+export default defineConfig({
+  // ...
+})
 ```
 
-</details>
+### Custom path
+
+Set a custom config path via the CLI command:
+
+```sh
+npx hyperbundler --config hyper.config.ts
+```
 
 ## Options
 
-All options are documented with descriptions and examples, and auto-completion will be offered as you type.
+All options are documented with descriptions and examples so auto-completion will be offered as you type.
 
 Simply hover over the property and see what it does in the `quickinfo`.
 
@@ -292,6 +286,36 @@ Now imports can be used like this:
 import { module } from '#/utils' // #
 ```
 
+### minify
+
+- Type: `boolean`
+- Default: `undefined`
+
+Specifies the minification for all `chunk` entries.
+
+```ts
+// bundler.config.ts
+
+import { defineConfig } from '@hypernym/bundler'
+
+export default defineConfig({
+  minify: true,
+})
+```
+
+It can also be set per entry.
+
+```ts
+export default defineConfig({
+  entries: [
+    {
+      input: './src/index.ts',
+      minify: true,
+    },
+  ],
+})
+```
+
 ## Hooks
 
 List of lifecycle hooks that are called at various phases:
@@ -443,37 +467,29 @@ export default defineConfig({
 
 ## Utils
 
-### replacePath
+### resolvePaths
 
-- Type: `(path: RegExp | string, replace: string): (id: string) => string`
+- Type: `(options: ResolvePathsOptions[]): (id: string) => string`
 
-Replaces the external module ID with a custom value.
+Resolves external module IDs into custom paths.
 
 ```ts
-import { defineConfig, replacePath } from '@hypernym/bundler'
+import { defineConfig, resolvePaths } from '@hypernym/bundler'
 
 export default defineConfig({
   entries: [
     {
       input: './src/index.ts',
       externals: [/^@\/path/],
-      // replaces `@/path` with `./path/index.mjs`
-      paths: (id) => replacePath(/^@\/path/, './path/index.mjs')(id),
+      paths: resolvePaths([
+        // replaces `@/path` with `./path/index.mjs`
+        { find: /^@\/path/, replacement: './path/index.mjs' },
+      ]),
     },
   ],
 })
 ```
 
-## CLI
-
-### Custom Config
-
-Set a custom config path via the CLI command:
-
-```sh
-npx hyperbundler --config hyper.config.ts
-```
-
 ## Community
 
 Feel free to ask questions or share new ideas.

package/dist/bin/index.mjs

@@ -2,11 +2,11 @@
 import process, { cwd } from 'node:process';
 import { createArgs } from '@hypernym/args';
 import { resolve, dirname, parse } from 'node:path';
-import { readFile, stat, cp, readdir } from 'node:fs/promises';
-import { exists, writeFile } from '@hypernym/utils/fs';
+import { read, exists, write, copy, readdir } from '@hypernym/utils/fs';
 import { dim, cyan, bold, green } from '@hypernym/colors';
 import { build as build$1, transform } from 'esbuild';
-import { isString, isObject } from '@hypernym/utils';
+import { stat } from 'node:fs/promises';
+import { isString, isUndefined, isObject } from '@hypernym/utils';
 import { rollup } from 'rollup';
 import { getLogFilter } from 'rollup/getLogFilter';
 import replacePlugin from '@rollup/plugin-replace';
@@ -27,7 +27,7 @@ const externals = [
 const logo = `\u2726\u2726`;
 const name$1 = "hyperbundler";
 const logoname = `${logo} ${name$1}`;
-const version = `0.11.0`;
+const version = `0.13.0`;
 
 const name = logoname.toUpperCase();
 const cl = console.log;
@@ -98,7 +98,7 @@ async function loadConfig(cwd, filePath, defaults) {
   });
   const code = result.outputFiles[0].text;
   const tempConfig = resolve(cwd, "node_modules/.hypernym/bundler/config.mjs");
-  await writeFile(tempConfig, code, "utf-8");
+  await write(tempConfig, code);
   const content = await import(tempConfig);
   const config = {
     ...defaults,
@@ -108,7 +108,7 @@ async function loadConfig(cwd, filePath, defaults) {
 }
 async function createConfigLoader(cwd, args) {
   const pkgPath = resolve(cwd, "package.json");
-  const pkg = await readFile(pkgPath, "utf-8").catch(error);
+  const pkg = await read(pkgPath).catch(error);
   const { dependencies } = JSON.parse(pkg);
   const warnMessage = `Missing required configuration. To start bundling, add the ${cyan(
     `'bundler.config.{js,mjs,ts,mts}'`
@@ -241,7 +241,7 @@ async function build(cwd, options) {
         for (const copyInput of _entry.input) {
           const fileSrc = resolve(cwd, copyInput);
           const fileDist = resolve(cwd, _entry.output, copyInput);
-          await cp(fileSrc, fileDist, {
+          await copy(fileSrc, fileDist, {
             recursive: _entry.recursive,
             filter: _entry.filter
           }).catch(error);
@@ -249,7 +249,7 @@ async function build(cwd, options) {
           let totalSize = 0;
           if (!stats.isDirectory()) totalSize = stats.size;
           else {
-            const files = await readdir(fileDist, { recursive: true });
+            const files = await readdir(fileDist);
             for (const file of files) {
               const filePath = resolve(fileDist, file);
               const fileStat = await stat(filePath);
@@ -288,7 +288,12 @@ async function build(cwd, options) {
           externals: entry.externals || options.externals,
           format: entry.format || _format,
           transformers: entry.transformers,
-          defaultPlugins: [esbuild(entry.transformers?.esbuild)],
+          defaultPlugins: [
+            esbuild({
+              minify: !isUndefined(entry.minify) ? entry.minify : options.minify,
+              ...entry.transformers?.esbuild
+            })
+          ],
           plugins: entry.plugins,
           banner: entry.banner,
           footer: entry.footer,
@@ -416,7 +421,7 @@ async function build(cwd, options) {
           template: entry.template,
           output: entry.output
         };
-        await writeFile(_entry.output, `${_entry.template}`, "utf-8");
+        await write(_entry.output, _entry.template);
         const stats = await stat(resolve(cwd, _entry.output));
         const fileStats = {
           path: _entry.output,

package/dist/index.mjs

@@ -9,11 +9,14 @@ function defineConfig(options) {
   return options;
 }
 
-function replacePath(path, replace) {
+function resolvePaths(options) {
   return (id) => {
-    if (id.match(path)) return replace;
+    for (const resolver of options) {
+      const { find, replacement } = resolver;
+      if (id.match(find)) id = replacement;
+    }
     return id;
   };
 }
 
-export { defineConfig, externals, replacePath };
+export { defineConfig, externals, resolvePaths };

package/dist/types/index.d.ts

@@ -126,6 +126,12 @@ interface EntryChunk extends EntryBase {
      * Intended for `umd/iife` formats.
      */
     extend?: OutputOptions['extend'];
+    /**
+     * Minifies the generated code if enabled.
+     *
+     * @default undefined
+     */
+    minify?: boolean;
     declaration?: never;
     copy?: never;
     template?: never;
@@ -158,6 +164,7 @@ interface EntryDeclaration extends EntryBase {
     name?: never;
     globals?: never;
     extend?: never;
+    minify?: never;
 }
 interface CopyOptions {
     /**
@@ -213,6 +220,7 @@ interface EntryCopy {
     name?: never;
     globals?: never;
     extend?: never;
+    minify?: never;
 }
 interface EntryTemplate {
     /**
@@ -244,6 +252,7 @@ interface EntryTemplate {
     name?: never;
     globals?: never;
     extend?: never;
+    minify?: never;
 }
 type EntryOptions = EntryChunk | EntryDeclaration | EntryCopy | EntryTemplate;
 
@@ -350,6 +359,33 @@ interface Options {
      * @default undefined
      */
     alias?: Alias[];
+    /**
+     * Specifies the minification for all `chunk` entries.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   minify: true,
+     * })
+     * ```
+     *
+     * It can also be set per entry.
+     *
+     * ```ts
+     * export default defineConfig({
+     *   entries: [
+     *     {
+     *       input: './src/index.ts',
+     *       minify: true,
+     *     },
+     *   ],
+     * })
+     * ```
+     *
+     * @default undefined
+     */
+    minify?: boolean;
 }
 
 interface BuildLogs {
@@ -545,28 +581,50 @@ interface ConfigLoader {
  * ```
  */
 declare const externals: RegExp[];
+/**
+ * `Hyperbundler` automatically detects custom configuration from the project root that can override or extend the build behavior.
+ *
+ * Configuration file also accepts `.js`, `.mjs`, `.ts`, `.mts` formats.
+ *
+ * @example
+ *
+ * ```ts
+ * import { defineConfig } from '@hypernym/bundler'
+ *
+ * export default defineConfig({
+ *   // ...
+ * })
+ * ```
+ */
 declare function defineConfig(options: Options): Options;
 
 /**
- * Replaces the external module ID with a custom value.
+ * Resolves external module IDs into custom paths.
  *
  * @example
  *
  * ```ts
- * import { defineConfig, replacePath } from '@hypernym/bundler'
+ * import { defineConfig, resolvePaths } from '@hypernym/bundler'
  *
  * export default defineConfig({
  *   entries: [
  *     {
  *       input: './src/index.ts',
  *       externals: [/^@\/path/],
- *       // replaces `@/path` with `./path/index.mjs`
- *       paths: (id) => replacePath(/^@\/path/, './path/index.mjs')(id),
+ *       paths: resolvePaths([
+ *         // replaces `@/path` with `./path/index.mjs`
+ *         { find: /^@\/path/, replacement: './path/index.mjs', }
+ *       ]),
  *     },
  *   ]
  * })
  * ```
  */
-declare function replacePath(path: RegExp | string, replace: string): (id: string) => string;
+declare function resolvePaths(options: ResolvePathsOptions[]): (id: string) => string;
+
+interface ResolvePathsOptions {
+    find: string | RegExp;
+    replacement: string;
+}
 
-export { type BuildLogs, type BuildStats, type ConfigLoader, type CopyOptions, type EntryBase, type EntryChunk, type EntryCopy, type EntryDeclaration, type EntryOptions, type EntryTemplate, type HooksOptions, type Options, type TransformersChunk, type TransformersDeclaration, defineConfig, externals, replacePath };
+export { type BuildLogs, type BuildStats, type ConfigLoader, type CopyOptions, type EntryBase, type EntryChunk, type EntryCopy, type EntryDeclaration, type EntryOptions, type EntryTemplate, type HooksOptions, type Options, type ResolvePathsOptions, type TransformersChunk, type TransformersDeclaration, defineConfig, externals, resolvePaths };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypernym/bundler",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "author": "Hypernym Studio",
   "description": "ESM & TS module bundler.",
   "license": "MIT",
@@ -20,14 +20,13 @@
   ],
   "keywords": [
     "module",
-    "modules",
     "bundling",
     "javascript",
     "typescript",
     "hyperbundler",
+    "declarations",
     "bundler",
     "builder",
-    "package",
     "bundle",
     "types",
     "build",
@@ -45,7 +44,7 @@
     "prepublishOnly": "npm run build"
   },
   "sideEffects": false,
-  "packageManager": "pnpm@9.10.0",
+  "packageManager": "pnpm@9.11.0",
   "engines": {
     "node": ">=20.0.0",
     "pnpm": ">=9.0.0"
@@ -65,22 +64,22 @@
   "dependencies": {
     "@hypernym/args": "^0.3.0",
     "@hypernym/colors": "^1.0.1",
-    "@hypernym/utils": "^3.0.1",
+    "@hypernym/utils": "^3.4.0",
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-replace": "^5.0.7",
     "@rollup/pluginutils": "^5.1.0",
     "esbuild": "^0.23.1",
-    "rollup": "^4.21.3",
+    "rollup": "^4.22.4",
     "rollup-plugin-dts": "^6.1.1"
   },
   "devDependencies": {
     "@hypernym/eslint-config": "^3.5.0",
     "@hypernym/prettier-config": "^3.2.0",
-    "@hypernym/tsconfig": "^2.3.0",
+    "@hypernym/tsconfig": "^2.4.0",
     "@types/node": "^22.5.5",
-    "eslint": "^9.10.0",
+    "eslint": "^9.11.0",
     "prettier": "^3.3.3",
     "typescript": "^5.5.4"
   }