@hypernym/bundler 0.1.2 → 0.3.0

package/dist/bin/index.mjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
-import process, { stdout, cwd } from 'node:process';
+import process, { cwd } from 'node:process';
 import { createArgs } from '@hypernym/args';
-import { readFile, mkdir, writeFile, stat } from 'node:fs/promises';
+import { readFile, stat } from 'node:fs/promises';
 import { resolve, parse } from 'node:path';
-import { exists } from '@hypernym/utils/node';
-import { dim, magenta, red, cyan, green } from '@hypernym/colors';
+import { exists, writeFile } from '@hypernym/utils/fs';
+import { cyan, dim, red, magenta, green } from '@hypernym/colors';
 import { build as build$1, transform } from 'esbuild';
 import { createSpinner } from '@hypernym/spinner';
 import { isObject } from '@hypernym/utils';
@@ -25,31 +25,28 @@ const externals = [
 ];
 
 const name = "bundler";
-const version = `0.1.2`;
+const version = `0.3.0`;
 
 const cl = console.log;
-const log = (...args) => {
-  let length = args.length + 2;
-  const cols = stdout.columns || 80;
-  const time = (/* @__PURE__ */ new Date()).toLocaleTimeString();
-  for (const arg of args) {
-    length = length + arg.replace(/\u001b\[.*?m/g, "").length;
-  }
-  const repeatLength = cols <= length + time.length ? 0 : cols - (length + time.length);
-  return cl(...args, " ".repeat(repeatLength), dim(time));
-};
 const logger = {
+  info: (...args) => {
+    const time = `[${(/* @__PURE__ */ new Date()).toLocaleTimeString()}]`;
+    return cl(cyan(name), dim(time), ...args);
+  },
+  error: (...args) => {
+    const time = `[${(/* @__PURE__ */ new Date()).toLocaleTimeString()}]`;
+    return cl(red(name), dim(time), ...args);
+  },
   exit: (message) => {
-    cl();
-    log(dim(name), dim(version));
-    log(magenta(name), message);
-    cl();
+    const time = `[${(/* @__PURE__ */ new Date()).toLocaleTimeString()}]`;
+    cl(magenta(name), dim(time), version);
+    cl(magenta(name), dim(time), message);
     return process.exit(1);
   }
 };
 
 function error(err) {
-  log(red(name), "Something went wrong...");
+  logger.error("Something went wrong...");
   console.error(err);
   return process.exit(1);
 }
@@ -106,9 +103,7 @@ async function loadConfig(cwd, filePath, defaults) {
     packages: "external"
   });
   const code = result.outputFiles[0].text;
-  const tempDir = resolve(cwd, "node_modules", ".hypernym", "bundler");
-  const tempConfig = resolve(tempDir, "config.mjs");
-  await mkdir(tempDir, { recursive: true });
+  const tempConfig = resolve(cwd, "node_modules/.hypernym/bundler/config.mjs");
   await writeFile(tempConfig, code, "utf-8");
   const content = await import(tempConfig);
   const config = {
@@ -201,8 +196,8 @@ async function build(cwd, options) {
     buildTime: 0,
     files: []
   };
-  if (hooks?.["build:before"])
-    await hooks["build:before"](options);
+  if (hooks?.["build:start"])
+    await hooks["build:start"](options, buildStats);
   if (options.entries) {
     start = Date.now();
     for (const entry of options.entries) {
@@ -217,13 +212,13 @@ async function build(cwd, options) {
           _format = "cjs";
         const output = entry.output || _output;
         const format = entry.format || _format;
-        const defaultPlugins = [esbuild(plugins?.esbuild)];
+        const _plugins = [esbuild(plugins?.esbuild)];
         if (plugins?.json) {
           const jsonOptions = isObject(plugins.json) ? plugins.json : void 0;
-          defaultPlugins.push(jsonPlugin(jsonOptions));
+          _plugins.push(jsonPlugin(jsonOptions));
         }
         if (plugins?.replace) {
-          defaultPlugins.unshift(
+          _plugins.unshift(
             replacePlugin({
               true: true,
               ...plugins.replace
@@ -232,12 +227,20 @@ async function build(cwd, options) {
         }
         if (plugins?.resolve) {
           const resolveOptions = isObject(plugins.resolve) ? plugins.resolve : void 0;
-          defaultPlugins.unshift(resolvePlugin(resolveOptions));
+          _plugins.unshift(resolvePlugin(resolveOptions));
+        }
+        if (hooks?.["rollup:plugins"]) {
+          hooks["rollup:plugins"](_plugins, {
+            ...entry,
+            input,
+            output,
+            format
+          });
         }
         const builder = await rollup({
           input: resolve(cwd, input),
           external: externals || options.externals,
-          plugins: defaultPlugins,
+          plugins: _plugins,
           onLog: (level, log) => {
             if (logFilter(log))
               buildLogs.push({ level, log });
@@ -268,10 +271,19 @@ async function build(cwd, options) {
           _format = "cjs";
         const output = entry.output || _output;
         const format = entry.format || _format;
+        const _plugins = [dts(plugins?.dts)];
+        if (hooks?.["rollup:plugins"]) {
+          hooks["rollup:plugins"](_plugins, {
+            ...entry,
+            types,
+            output,
+            format
+          });
+        }
         const builder = await rollup({
           input: resolve(cwd, types),
           external: externals || options.externals,
-          plugins: [dts(plugins?.dts)],
+          plugins: _plugins,
           onLog: (level, log) => {
             if (logFilter(log))
               buildLogs.push({ level, log });
@@ -296,33 +308,24 @@ async function build(cwd, options) {
     }
     buildStats.buildTime = Date.now() - start;
   }
-  if (hooks?.["build:done"])
-    await hooks["build:done"](options);
+  if (hooks?.["build:end"])
+    await hooks["build:end"](options, buildStats);
   return buildStats;
 }
 
 async function createBuilder(cwd, args, options) {
+  const { hooks } = options;
+  if (hooks?.["bundle:start"])
+    await hooks["bundle:start"](options);
+  logger.info(version);
+  logger.info(`Bundling started...`);
   const spinner = createSpinner();
-  cl();
-  log(dim(name), dim(version));
-  log(cyan(name), `Bundling started...`);
   spinner.start({
     message: `Transforming modules ${green("for production...")}`
   });
-  return await build(cwd, options).then((stats) => {
+  await build(cwd, options).then((stats) => {
     spinner.stop({
-      message: `Modules transformation is ${green("done!")}`,
-      template: (mark, message) => {
-        const temp = `${mark}${message}`;
-        const cols = stdout.columns || 80;
-        const time = (/* @__PURE__ */ new Date()).toLocaleTimeString();
-        const length = (
-          // eslint-disable-next-line no-control-regex
-          temp.replace(/\u001b\[.*?m/g, "").length + time.length + 1
-        );
-        const repeatLength = cols <= length ? 0 : cols - length;
-        return temp + " ".repeat(repeatLength) + dim(time);
-      }
+      message: `Modules transformation is ${green("done!")}`
     });
     const check = green("\u2714");
     const info = cyan("i");
@@ -336,9 +339,9 @@ async function createBuilder(cwd, args, options) {
     const longestSize = Math.max(
       ...stats.files.map((v) => formatBytes(v.size).length)
     );
-    log(check, `Bundling completed in ${buildTime}`);
-    log(check, `${modules} modules transformed. Total size is ${buildSize}`);
-    log(info, "Individual stats per module");
+    cl(check, `Bundling completed in ${buildTime}`);
+    cl(check, `${modules} modules transformed. Total size is ${buildSize}`);
+    cl(info, "Individual stats per module");
     for (const file of stats.files) {
       let format = file.format;
       const base = parse(file.path).base;
@@ -352,11 +355,11 @@ async function createBuilder(cwd, args, options) {
       if (base.includes(".d."))
         format = "dts";
       if (file.logs) {
-        for (const log2 of file.logs) {
-          cl(magenta("!"), magenta(log2.log.message));
+        for (const log of file.logs) {
+          cl(magenta("!"), magenta(log.log.message));
         }
       }
-      log(
+      cl(
         info,
         dim("\u251C\u2500"),
         dim(path) + cyan(base),
@@ -368,7 +371,7 @@ async function createBuilder(cwd, args, options) {
         dim(formatBytes(file.size).padStart(longestSize))
       );
     }
-    log(
+    logger.info(
       check,
       `Bundle is now fully generated and ready ${green("for production!")}`
     );
@@ -377,10 +380,12 @@ async function createBuilder(cwd, args, options) {
       mark: red("\u2716"),
       message: `Modules transformation is ${red("interupted!")}`
     });
-    log(red(name), "Something went wrong...");
+    logger.error("Something went wrong...");
     console.error(err);
     return process.exit(1);
   });
+  if (hooks?.["bundle:end"])
+    await hooks["bundle:end"](options);
 }
 
 async function main() {

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { OutputOptions } from 'rollup';
+import { OutputOptions, LogLevel, RollupLog, Plugin } from 'rollup';
 import { RollupReplaceOptions } from '@rollup/plugin-replace';
 import { RollupJsonOptions } from '@rollup/plugin-json';
 import { RollupNodeResolveOptions } from '@rollup/plugin-node-resolve';
@@ -13,7 +13,7 @@ interface BuildPlugins {
     replace?: RollupReplaceOptions;
 }
 
-interface Entry {
+interface EntryBase {
     /**
      * Specifies the path of the transformed module.
      *
@@ -56,7 +56,7 @@ interface Entry {
      */
     logFilter?: string[];
 }
-interface EntryInput extends Entry {
+interface EntryInput extends EntryBase {
     /**
      * Specifies the path of the module's build source.
      */
@@ -68,7 +68,7 @@ interface EntryInput extends Entry {
      */
     plugins?: BuildPlugins;
 }
-interface EntryTypes extends Entry {
+interface EntryTypes extends EntryBase {
     /**
      * Specifies the path of the module's build source that contains only TS definitions.
      */
@@ -80,17 +80,156 @@ interface EntryTypes extends Entry {
      */
     plugins?: Pick<BuildPlugins, 'dts'>;
 }
-type EntriesOptions = EntryInput | EntryTypes;
+type EntryOptions = EntryInput | EntryTypes;
 
-interface BuildHooks {
+interface BuildLogs {
+    level: LogLevel;
+    log: RollupLog;
+}
+interface BuildStats {
+    /**
+     * The root path of the project.
+     */
+    cwd: string;
+    /**
+     * Final bundle size.
+     */
+    size: number;
+    /**
+     * Total bundle build time.
+     */
+    buildTime: number;
+    /**
+     * List of generated bundle modules.
+     */
+    files: {
+        /**
+         * Module output path.
+         */
+        path: string;
+        /**
+         * Module size.
+         */
+        size: number;
+        /**
+         * Build time of individual module.
+         */
+        buildTime: number;
+        /**
+         * Module format.
+         */
+        format: string;
+        /**
+         * List of warnings from build plugins.
+         */
+        logs: BuildLogs[];
+    }[];
+}
+
+interface HooksOptions {
     /**
      * Called just before bundling started.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   hooks: {
+     *     'bundle:start': async (options) => {
+     *       // ...
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * @default undefined
      */
-    'build:before'?: (options?: Options) => void | Promise<void>;
+    'bundle:start'?: (options?: Options) => void | Promise<void>;
+    /**
+     * Called just before building started.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   hooks: {
+     *     'build:start': async (options, buildStats) => {
+     *       // ...
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * @default undefined
+     */
+    'build:start'?: (options?: Options, buildStats?: BuildStats) => void | Promise<void>;
+    /**
+     * Called just before the initialization of the Rollup plugin.
+     *
+     * Provides the ability to add and manipulate custom plugins.
+     *
+     * @example
+     *
+     * ```ts
+     * import { plugin1, plugin2, plugin3 } from './plugins'
+     *
+     * export default defineConfig({
+     *   hooks: {
+     *     'rollup:plugins': (plugins, entry) => {
+     *       // adds a custom plugin before the default bundler plugins
+     *       plugins.unshift(plugin1())
+     *       // adds a custom plugin after the default bundler plugins
+     *       plugins.push(plugin2())
+     *       // adds a custom plugin for a specific entry only
+     *       if (entry?.input?.includes('./src/index.ts')) {
+     *         plugins.push(plugin3())
+     *       }
+     *       // returns the final list of plugins
+     *       return plugins
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * @default undefined
+     */
+    'rollup:plugins'?: (plugins: Plugin[], entry?: Partial<EntryInput> & Partial<Omit<EntryTypes, 'plugins'>>) => Plugin[];
+    /**
+     * Called right after building is complete.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   hooks: {
+     *     'build:end': async (options, buildStats) => {
+     *       // ...
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * @default undefined
+     */
+    'build:end'?: (options?: Options, buildStats?: BuildStats) => void | Promise<void>;
     /**
      * Called right after bundling is complete.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   hooks: {
+     *     'bundle:end': async (options) => {
+     *       // ...
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * @default undefined
      */
-    'build:done'?: (options?: Options) => void | Promise<void>;
+    'bundle:end'?: (options?: Options) => void | Promise<void>;
 }
 
 interface Options {
@@ -98,8 +237,20 @@ interface Options {
      * Specifies the bundle's entry points.
      *
      * It allows you to manually set all build entries and adjust options for each one individually.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   entries: [
+     *     { input: './src/index.ts' }, // => './dist/index.mjs'
+     *     { types: './src/types.ts' }, // => './dist/types.d.ts'
+     *     // ...
+     *   ]
+     * })
+     * ```
      */
-    entries: EntriesOptions[];
+    entries: EntryOptions[];
     /**
      * Specifies the output directory for production bundle.
      *
@@ -118,13 +269,43 @@ interface Options {
      */
     externals?: (string | RegExp)[];
     /**
-     * Provides a powerful hooking system to further expand build mode.
+     * Provides a powerful hooking system to further expand bundling mode.
+     *
+     * @example
+     *
+     * ```ts
+     * export default defineConfig({
+     *   hooks: {
+     *     'build:end': async (options, buildStats) => {
+     *       // ...
+     *     }
+     *   }
+     * })
+     * ```
      *
      * @default undefined
      */
-    hooks?: BuildHooks;
+    hooks?: HooksOptions;
 }
 
+/**
+ * List of global defaults for externals.
+ *
+ * @example
+ *
+ * ```ts
+ * import { externals } from '@hypernym/bundler'
+ *
+ * export default defineConfig({
+ *   entries: [
+ *     {
+ *       input: './src/index.ts',
+ *       externals: [...externals, 'id', /regexp/]
+ *     },
+ *   ]
+ * })
+ * ```
+ */
 declare const externals: RegExp[];
 declare function defineConfig(options: Options): Options;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypernym/bundler",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "author": "Hypernym Studio",
   "description": "ESM & TS module bundler.",
   "license": "MIT",
@@ -8,6 +8,7 @@
   "homepage": "https://github.com/hypernym-studio/bundler",
   "funding": "https://github.com/sponsors/ivodolenc",
   "type": "module",
+  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
@@ -55,22 +56,22 @@
     }
   },
   "dependencies": {
-    "@hypernym/args": "^0.2.0",
-    "@hypernym/colors": "^1.0.0",
-    "@hypernym/spinner": "^0.1.0",
-    "@hypernym/utils": "^2.0.2",
+    "@hypernym/args": "^0.2.1",
+    "@hypernym/colors": "^1.0.1",
+    "@hypernym/spinner": "^0.2.0",
+    "@hypernym/utils": "^2.1.0",
     "@rollup/plugin-json": "^6.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-replace": "^5.0.3",
+    "@rollup/plugin-replace": "^5.0.4",
     "esbuild": "^0.19.4",
-    "rollup": "^4.0.2",
+    "rollup": "^4.1.4",
     "rollup-plugin-dts": "^6.1.0"
   },
   "devDependencies": {
-    "@hypernym/eslint-config": "^2.0.1",
-    "@hypernym/prettier-config": "^2.0.1",
+    "@hypernym/eslint-config": "^2.0.2",
+    "@hypernym/prettier-config": "^2.0.2",
     "@hypernym/tsconfig": "^1.1.0",
-    "@types/node": "^20.8.4",
+    "@types/node": "^20.8.6",
     "eslint": "^8.51.0",
     "prettier": "^3.0.3",
     "tsx": "^3.13.0",