@hypernym/bundler 0.13.1 → 0.14.1

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Ivo Dolenc, Hypernym Studio
+Copyright (c) 2025 Ivo Dolenc, Hypernym Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,22 +1,20 @@
-<h1 align="center">Hyperbundler</h1>
+<h1 align="center">Bundler</h1>
 
 <p align="center">ESM & TS module bundler.</p>
 
 <p align="center">
   <a href="https://github.com/hypernym-studio/bundler">Repository</a>
-  <span>+</span>
+  <span>✦</span>
   <a href="https://www.npmjs.com/package/@hypernym/bundler">Package</a>
-  <span>+</span>
+  <span>✦</span>
   <a href="https://github.com/hypernym-studio/bundler/releases">Releases</a>
-  <span>+</span>
+  <span>✦</span>
   <a href="https://github.com/hypernym-studio/bundler/discussions">Discussions</a>
 </p>
 
-<pre align="center">pnpm add -D @hypernym/bundler</pre>
+<br>
 
-<p align="center">
-  <strong>Hypernym Studio</strong>
-</p>
+<pre align="center">pnpm add -D @hypernym/bundler</pre>
 
 <br>
 
@@ -24,13 +22,13 @@
 
 - Powered by Rollup
 - Written in TypeScript
-- Allows advanced customization
-- Provides a powerful hooking system
-- Supports all TS module resolutions
-- Exports fully optimized code
-- Follows modern practice
-- Super easy to use
-- API friendly
+- Allows Advanced Customization
+- Provides a Powerful Hooking System
+- Supports All TS Module Resolutions
+- Exports Fully Optimized Code
+- Follows Modern Practice
+- Super Easy to Use
+- API-Friendly
 
 ## Quick Start
 
@@ -58,7 +56,7 @@ import { defineConfig } from '@hypernym/bundler'
 export default defineConfig({
   entries: [
     { input: './src/index.ts' },
-    { declaration: './src/types/index.ts' },
+    { dts: './src/types/index.ts' },
     {
       input: './src/utils/index.ts',
       output: './dist/utils/utils.min.mjs',
@@ -99,11 +97,34 @@ Set a custom config path via the CLI command:
 npx hyperbundler --config hyper.config.ts
 ```
 
-## Options
+## Formats
+
+During transformation, file formats are automatically resolved and in most cases there is no need for additional configuration.
+
+`Hyperbundler` module environment for generated files defaults to `esm`, which means the outputs will have a `.mjs` extension unless otherwise specified. For TypeScript declarations, the appropriate extension will be `.d.mts`.
 
-All options are documented with descriptions and examples so auto-completion will be offered as you type.
+Formats can also be explicitly specified for each entry, if necessary.
+
+### Inputs
+
+Default transformation behaviour for all `chunk` entries:
+
+- `./srcDir/file.js` resolves to `./outDir/file.mjs`
+- `./srcDir/file.mjs` resolves to `./outDir/file.mjs`
+- `./srcDir/file.cjs` resolves to `./outDir/file.cjs`
+- `./srcDir/file.ts` resolves to `./outDir/file.mjs`
+- `./srcDir/file.mts` resolves to `./outDir/file.mjs`
+- `./srcDir/file.cts` resolves to `./outDir/file.cjs`
+
+### Declarations
+
+Default transformation behaviour for all `dts` entries:
+
+- `./srcDir/file.ts` resolves to `./outDir/file.d.mts`
+
+## Options
 
-Simply hover over the property and see what it does in the `quickinfo`.
+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`.
 
 ### entries
 
@@ -121,7 +142,7 @@ import { defineConfig } from '@hypernym/bundler'
 export default defineConfig({
   entries: [
     { input: './src/index.ts' }, // => './dist/index.mjs'
-    { declaration: './src/types.ts' }, // => './dist/types.d.ts'
+    { dts: './src/types.ts' }, // => './dist/types.d.mts'
     // ...
   ],
 })
@@ -140,9 +161,7 @@ import { defineConfig } from '@hypernym/bundler'
 
 export default defineConfig({
   entries: [
-    {
-      input: './src/index.ts', // => './dist/index.mjs'
-    },
+    { input: './src/index.ts' }, // => './dist/index.mjs'
   ],
 })
 ```
@@ -160,9 +179,19 @@ import { defineConfig } from '@hypernym/bundler'
 
 export default defineConfig({
   entries: [
-    {
-      { declaration: './src/types.ts' }, // => './dist/types.d.ts'
-    },
+    { declaration: './src/types.ts' }, // => './dist/types.d.mts'
+  ],
+})
+```
+
+Also, it is possible to use `dts` alias.
+
+```ts
+import { defineConfig } from '@hypernym/bundler'
+
+export default defineConfig({
+  entries: [
+    { dts: './src/types.ts' }, // => './dist/types.d.mts'
   ],
 })
 ```
@@ -373,7 +402,7 @@ export default defineConfig({
 
 ### build:entry:start
 
-- Type: `(options: BuildEntryOptions, stats: BuildStats) => void | Promise<void>`
+- Type: `(entry: BuildEntryOptions, stats: BuildEntryStats) => void | Promise<void>`
 - Default: `undefined`
 
 Called on each entry just before the build process.
@@ -388,12 +417,12 @@ import { plugin1, plugin2 } from './src/utils/plugins.js'
 
 export default defineConfig({
   hooks: {
-    'build:entry:start': async (options, stats) => {
+    'build:entry:start': async (entry, stats) => {
       // adds custom plugins for a specific entry only
-      if (options.input?.includes('./src/index.ts')) {
-        options.defaultPlugins = [
+      if (entry.input?.includes('./src/index.ts')) {
+        entry.defaultPlugins = [
           plugin1(), // adds a custom plugin before the default bundler plugins
-          ...options.defaultPlugins, // list of default bundler plugins
+          ...entry.defaultPlugins, // list of default bundler plugins
           plugin2(), // adds a custom plugin after the default bundler plugins
         ]
       }
@@ -404,7 +433,7 @@ export default defineConfig({
 
 ### build:entry:end
 
-- Type: `(options: BuildEntryOptions, stats: BuildStats) => void | Promise<void>`
+- Type: `(entry: BuildEntryOptions, stats: BuildEntryStats) => void | Promise<void>`
 - Default: `undefined`
 
 Called on each entry right after the build process is completed.
@@ -416,7 +445,7 @@ import { defineConfig } from '@hypernym/bundler'
 
 export default defineConfig({
   hooks: {
-    'build:entry:end': async (options, stats) => {
+    'build:entry:end': async (entry, stats) => {
       // ...
     },
   },

package/dist/bin/index.mjs

@@ -24,23 +24,23 @@ const externals = [
   /^rollup/
 ];
 
-const logo = `\u2726\u2726`;
-const version = `0.13.1`;
+const name = `Hyperbundler`;
+const version = `0.14.1`;
 
 const cl = console.log;
 const separator = `/`;
 const logger = {
   info: (...args) => {
-    cl(logo, dim(separator), ...args);
+    cl(name, dim(separator), ...args);
   },
   error: (...args) => {
     cl();
-    cl(logo, dim(separator), ...args);
+    cl(name, dim(separator), ...args);
     cl();
   },
   exit: (message) => {
     cl();
-    cl(logo, dim(separator), message);
+    cl(name, dim(separator), message);
     cl();
     return process.exit();
   }
@@ -73,37 +73,33 @@ function formatBytes(bytes) {
   return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${units[i]}`;
 }
 
-function getOutputPath(outDir, input, types = false) {
+function getOutputPath(outDir, input, dts) {
   const _input = input.startsWith("./") ? input.slice(2) : input;
   let output = _input.replace(_input.split("/")[0], outDir);
-  const ts = types ? "d.ts" : "mjs";
-  const mts = types ? "d.mts" : "mjs";
-  const cts = types ? "d.cts" : "cjs";
-  if (output.endsWith(".ts")) output = `${output.slice(0, -2)}${ts}`;
-  if (output.endsWith(".mts")) output = `${output.slice(0, -3)}${mts}`;
-  if (output.endsWith(".cts")) output = `${output.slice(0, -3)}${cts}`;
+  const ext = dts ? "d.mts" : "mjs";
+  const cts = dts ? "d.cts" : "cjs";
+  if (output.endsWith(".js")) output = `${output.slice(0, -2)}${ext}`;
+  else if (output.endsWith(".ts")) output = `${output.slice(0, -2)}${ext}`;
+  else if (output.endsWith(".mts")) output = `${output.slice(0, -3)}${ext}`;
+  else if (output.endsWith(".cts")) output = `${output.slice(0, -3)}${cts}`;
   if (outDir.startsWith("./") || outDir.startsWith("../")) return output;
-  return `./${output}`;
+  else return `./${output}`;
 }
 
 function getLongestOutput(outDir, entries) {
   const outputs = [];
   for (const entry of entries) {
-    if ("copy" in entry && entry.copy) {
-      const out = entry.copy.output;
-      outputs.push(out);
-    }
-    if ("input" in entry && entry.input) {
+    if (entry.copy) outputs.push(entry.copy.output);
+    if (entry.input) {
       const out = entry.output || getOutputPath(outDir, entry.input);
       outputs.push(out);
     }
-    if ("declaration" in entry && entry.declaration) {
-      const out = entry.output || getOutputPath(outDir, entry.declaration, true);
+    if (entry.declaration || entry.dts) {
+      const dts = entry.declaration || entry.dts;
+      const out = entry.output || getOutputPath(outDir, dts, true);
       outputs.push(out);
     }
-    if ("template" in entry && entry.template) {
-      outputs.push(entry.output);
-    }
+    if (entry.template) outputs.push(entry.output);
   }
   return Math.max(...outputs.map((v) => v.length));
 }
@@ -301,6 +297,7 @@ async function build(cwd, options) {
             else return `./${path}`;
           };
           const fileStats = {
+            cwd,
             path: `${parseOutput(_entry.output)}/${parseInput(copyInput)}`,
             size: totalSize,
             buildTime: Date.now() - entryStart,
@@ -314,31 +311,22 @@ async function build(cwd, options) {
       }
       if (entry.input) {
         const logFilter = getLogFilter(entry.logFilter || []);
-        const _output = getOutputPath(outDir, entry.input);
+        const _output = entry.output || getOutputPath(outDir, entry.input);
         let _format = "esm";
         if (_output.endsWith(".cjs")) _format = "cjs";
         const buildLogs = [];
         const _entry = {
           input: entry.input,
-          output: entry.output || _output,
+          output: _output,
           externals: entry.externals || options.externals,
           format: entry.format || _format,
-          transformers: entry.transformers,
+          ...entry,
           defaultPlugins: [
             esbuild({
               minify: !isUndefined(entry.minify) ? entry.minify : options.minify,
               ...entry.transformers?.esbuild
             })
-          ],
-          plugins: entry.plugins,
-          banner: entry.banner,
-          footer: entry.footer,
-          intro: entry.intro,
-          outro: entry.outro,
-          paths: entry.paths,
-          name: entry.name,
-          globals: entry.globals,
-          extend: entry.extend
+          ]
         };
         if (!entry.plugins) {
           if (_entry.transformers?.json) {
@@ -348,7 +336,7 @@ async function build(cwd, options) {
           if (_entry.transformers?.replace) {
             _entry.defaultPlugins.unshift(
               replacePlugin({
-                true: true,
+                preventAssignment: true,
                 ..._entry.transformers.replace
               })
             );
@@ -361,7 +349,15 @@ async function build(cwd, options) {
             aliasPlugin(_entry.transformers?.alias || aliasOptions)
           );
         }
-        await hooks?.["build:entry:start"]?.(_entry, buildStats);
+        const fileStats = {
+          cwd,
+          path: _entry.output,
+          size: 0,
+          buildTime: entryStart,
+          format: _entry.format,
+          logs: buildLogs
+        };
+        await hooks?.["build:entry:start"]?.(_entry, fileStats);
         const _build = await rollup({
           input: resolve(cwd, _entry.input),
           external: _entry.externals,
@@ -383,46 +379,42 @@ async function build(cwd, options) {
           extend: _entry.extend
         });
         const stats = await stat(resolve(cwd, _entry.output));
-        const file = {
-          path: _entry.output,
-          size: stats.size,
-          buildTime: Date.now() - entryStart,
-          format: _entry.format,
-          logs: buildLogs
-        };
-        buildStats.files.push(file);
+        fileStats.size = stats.size;
+        fileStats.buildTime = Date.now() - entryStart;
+        fileStats.logs = buildLogs;
+        buildStats.files.push(fileStats);
         buildStats.size = buildStats.size + stats.size;
-        logModuleStats(file, longestOutput);
-        await hooks?.["build:entry:end"]?.(_entry, buildStats);
+        logModuleStats(fileStats, longestOutput);
+        await hooks?.["build:entry:end"]?.(_entry, fileStats);
       }
-      if (entry.declaration) {
+      if (entry.dts || entry.declaration) {
         const logFilter = getLogFilter(entry.logFilter || []);
-        const _output = getOutputPath(outDir, entry.declaration, true);
-        let _format = "esm";
-        if (_output.endsWith(".d.cts")) _format = "cjs";
         const buildLogs = [];
+        const dts$1 = entry.dts || entry.declaration;
         const _entry = {
-          input: entry.declaration,
-          output: entry.output || _output,
+          dts: dts$1,
+          output: entry.output || getOutputPath(outDir, dts$1, true),
           externals: entry.externals || options.externals,
-          format: entry.format || _format,
-          transformers: entry.transformers,
-          defaultPlugins: [dts(entry.transformers?.dts)],
-          plugins: entry.plugins,
-          banner: entry.banner,
-          footer: entry.footer,
-          intro: entry.intro,
-          outro: entry.outro,
-          paths: entry.paths
+          format: entry.format || "esm",
+          ...entry,
+          defaultPlugins: [dts(entry.transformers?.dts)]
         };
         if (!entry.plugins) {
           _entry.defaultPlugins.unshift(
             aliasPlugin(_entry.transformers?.alias || aliasOptions)
           );
         }
-        await hooks?.["build:entry:start"]?.(_entry, buildStats);
+        const fileStats = {
+          cwd,
+          path: _entry.output,
+          size: 0,
+          buildTime: entryStart,
+          format: "dts",
+          logs: buildLogs
+        };
+        await hooks?.["build:entry:start"]?.(_entry, fileStats);
         const _build = await rollup({
-          input: resolve(cwd, _entry.input),
+          input: resolve(cwd, _entry.dts),
           external: _entry.externals,
           plugins: _entry.plugins || _entry.defaultPlugins,
           onLog: (level, log) => {
@@ -439,28 +431,21 @@ async function build(cwd, options) {
           paths: _entry.paths
         });
         const stats = await stat(resolve(cwd, _entry.output));
-        const fileStats = {
-          path: _entry.output,
-          size: stats.size,
-          buildTime: Date.now() - entryStart,
-          format: "dts",
-          logs: buildLogs
-        };
+        fileStats.size = stats.size;
+        fileStats.buildTime = Date.now() - entryStart;
+        fileStats.logs = buildLogs;
         buildStats.files.push(fileStats);
         buildStats.size = buildStats.size + stats.size;
         logModuleStats(fileStats, longestOutput);
-        await hooks?.["build:entry:end"]?.(_entry, buildStats);
+        await hooks?.["build:entry:end"]?.(_entry, fileStats);
       }
       if (entry.template && entry.output) {
         const buildLogs = [];
-        const _entry = {
-          template: entry.template,
-          output: entry.output
-        };
-        await write(_entry.output, _entry.template);
-        const stats = await stat(resolve(cwd, _entry.output));
+        await write(entry.output, entry.template);
+        const stats = await stat(resolve(cwd, entry.output));
         const fileStats = {
-          path: _entry.output,
+          cwd,
+          path: entry.output,
           size: stats.size,
           buildTime: Date.now() - entryStart,
           format: "tmp",
@@ -484,6 +469,7 @@ async function createBuilder(cwd, config) {
   await hooks?.["bundle:start"]?.(options);
   logger.info(dim(`v${version}`));
   cl("Config", dim(configPath));
+  cl();
   cl("Bundling started...");
   cl(
     "Processing",
@@ -503,8 +489,9 @@ async function createBuilder(cwd, config) {
       "Module transformation is done"
     );
     cl(`Bundling fully completed in ${buildTime}`);
+    cl();
     cl(`${modules} transformed. Total size is ${buildSize}`);
-    logger.info(`Bundle is generated and ready for production`);
+    cl(`Bundle is generated and ready for production`);
     cl();
   }).catch(error);
   await hooks?.["bundle:end"]?.(options);

package/dist/index.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+const externals = [
+  /^node:/,
+  /^@types/,
+  /^@rollup/,
+  /^@hypernym/,
+  /^rollup/
+];
+function defineConfig(options) {
+  return options;
+}
+
+function resolvePaths(options) {
+  return (id) => {
+    for (const resolver of options) {
+      const { find, replacement } = resolver;
+      if (id.match(find)) id = replacement;
+    }
+    return id;
+  };
+}
+
+exports.defineConfig = defineConfig;
+exports.externals = externals;
+exports.resolvePaths = resolvePaths;