unplugin-dts-bundle-generator 3.1.1 → 3.2.0

package/README.md

@@ -5,8 +5,9 @@
 [![Licence](https://img.shields.io/npm/l/unplugin-dts-bundle-generator)](./LICENCE)
 [![GitHub Actions](https://img.shields.io/github/actions/workflow/status/f-lawe/unplugin-dts-bundle-generator/pr-checks.yml)](https://github.com/f-lawe/unplugin-dts-bundle-generator/actions/workflows/pr-checks.yml)
 
-Ever wanted to easily package your typescript library with a bundled declaration file? Integrate [DTS Bundle Generator](https://github.com/timocov/dts-bundle-generator) within [Vite](https://github.com/vitejs/vite) or any other blundler supported by [Unplugin](https://github.com/unjs/unplugin)!
-(see available bundlers below)
+Ever wanted to easily package your typescript library with a bundled declaration file? Integrate [DTS Bundle Generator](https://github.com/timocov/dts-bundle-generator) within your favourite bundler thanks to [Unplugin](https://github.com/unjs/unplugin)!
+
+_(see available bundlers below)_
 
 ## Installation
 ```sh
@@ -18,22 +19,28 @@ yarn add --dev unplugin-dts-bundle-generator
 ```
 
 ## Usage
-Currently, only Vite and Rollup are fully supported, more bundlers to come. Please open a PR or an issue if you need another export and want to speed up the process, so we can work it out!
+Only those bundlers are supported at the moment:
+- [Vite](https://github.com/vitejs/vite)
+- [Rollup](https://github.com/rollup/rollup)
+- [ESBuild](https://github.com/evanw/esbuild)
+
+Please open a PR or an issue if you need another export and want to speed up the process, so we can work it out!
+
+⚠️ Be careful! Plugin options may vary according to the bundler you are using.
 
 <details>
-<summary>Vite</summary><br>
+<summary>ESBuild</summary><br>
 
-With Vite, add this block to your `vite.config.ts`:
+With ESBuild, add this block when calling `esbuild.build()`:
 
 ```ts
-import path from 'node:path';
-import dtsBundleGenerator from 'unplugin-dts-bundle-generator/vite';
-import { defineConfig, normalizePath } from 'vite';
+import * as esbuild from 'esbuild';
+import dtsBundleGenerator from 'unplugin-dts-bundle-generator/rollup';
 
-export default defineConfig({
+await esbuild.build({
   plugins: [
     dtsBundleGenerator({
-      fileName: 'my-lib.d.ts',
+      outfile: 'my-lib.d.ts',
       output: {
         // output config
       },
@@ -43,15 +50,12 @@ export default defineConfig({
       compilation: {
         // compilation options
       }
-    })
+    }),
   ],
-  build: {
-    lib: {
-      entry: normalizePath('src/index.ts'),
-      formats: ['es'],
-      fileName: 'my-lib.js'
-    }
-  }
+  entryPoints: 'src/index.ts',
+  outfile: 'my-lib.js',
+  format: 'esm',
+  bundle: true,
 });
 ```
 <br></details>
@@ -67,7 +71,7 @@ import dtsBundleGenerator from 'unplugin-dts-bundle-generator/rollup';
 export default {
   plugins: [
     dtsBundleGenerator({
-      fileName: 'my-lib.d.ts',
+      file: 'my-lib.d.ts',
       output: {
         // output config
       },
@@ -88,6 +92,42 @@ export default {
 ```
 <br></details>
 
+<details>
+<summary>Vite</summary><br>
+
+With Vite, add this block to your `vite.config.ts`:
+
+```ts
+import path from 'node:path';
+import dtsBundleGenerator from 'unplugin-dts-bundle-generator/vite';
+import { defineConfig, normalizePath } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    dtsBundleGenerator({
+      fileName: 'my-lib.d.ts',
+      output: {
+        // output config
+      },
+      libraries: {
+        // libraries config
+      },
+      compilation: {
+        // compilation options
+      }
+    })
+  ],
+  build: {
+    lib: {
+      entry: normalizePath('src/index.ts'),
+      formats: ['es'],
+      fileName: 'my-lib.js'
+    }
+  }
+});
+```
+<br></details>
+
 ## Configuration
 
 This library handle both single and multiple entrypoints. You can use any of the output, libraries and compilation options available in the [config file](https://github.com/timocov/dts-bundle-generator/blob/master/src/config-file/README.md) of DTS Bundle Generator.

package/dist/dts-bundle-generator.d.ts

@@ -1,11 +1,20 @@
 import { CompilationOptions, EntryPointConfig } from 'dts-bundle-generator';
 
-export interface Options {
-	fileName: string | ((entryName: string) => string);
+export interface DtsBundleGeneratorOptions {
 	output?: EntryPointConfig["output"];
 	libraries?: EntryPointConfig["libraries"];
 	compilation?: CompilationOptions;
 }
+export interface ESBuildOptions extends DtsBundleGeneratorOptions {
+	outfile?: string;
+}
+export interface RollupOptions extends DtsBundleGeneratorOptions {
+	file?: string;
+}
+export interface ViteOptions extends DtsBundleGeneratorOptions {
+	fileName: string | ((entryName: string) => string);
+}
+export type Options = ESBuildOptions | RollupOptions | ViteOptions;
 declare const _default: import("unplugin").UnpluginInstance<Options, false>;
 
 export {

package/dist/esbuild.cjs.js

@@ -0,0 +1 @@
+"use strict";const u=require("unplugin"),e=require("./factory.cjs.js"),r=u.createEsbuildPlugin(e.unpluginFactory);module.exports=r;

package/dist/esbuild.d.ts

@@ -0,0 +1,17 @@
+import { CompilationOptions, EntryPointConfig } from 'dts-bundle-generator';
+
+export interface DtsBundleGeneratorOptions {
+	output?: EntryPointConfig["output"];
+	libraries?: EntryPointConfig["libraries"];
+	compilation?: CompilationOptions;
+}
+export interface ESBuildOptions extends DtsBundleGeneratorOptions {
+	outfile?: string;
+}
+declare const _default: (options: ESBuildOptions) => import("esbuild").Plugin;
+
+export {
+	_default as default,
+};
+
+export {};

package/dist/esbuild.es.js

@@ -0,0 +1,6 @@
+import { createEsbuildPlugin as o } from "unplugin";
+import { u as r } from "./factory.es.js";
+const i = o(r);
+export {
+  i as default
+};

package/dist/factory.cjs.js

@@ -1,2 +1,2 @@
-"use strict";const f=require("node:buffer"),m=require("node:fs"),u=require("node:path"),d=require("node:zlib"),b=require("dts-bundle-generator"),s=require("picocolors"),c=(i,t)=>{typeof t=="string"?Object.assign(i,{default:t}):Array.isArray(t)?t.forEach(r=>{Object.assign(i,{[u.basename(r,u.extname(r))]:r})}):Object.assign(i,t)},h=i=>{const t=[],r={},l={},g=typeof i.fileName=="string"?()=>i.fileName:i.fileName;return{name:"unplugin-dts-bundle-generator",buildEnd(){const e=Object.values(r).map(n=>({filePath:n,libraries:i.libraries,output:i.output}));b.generateDtsBundle(e,i.compilation).forEach((n,a)=>t.push({compressedSize:d.gzipSync(n).length,content:n,outFile:g(Object.keys(r)[a]),size:f.Buffer.byteLength(n)}))},writeBundle(){t.forEach(e=>m.writeFileSync(u.resolve(l.outDir??"",e.outFile),e.content))},rollup:{buildStart(e){c(r,e.input)},outputOptions(e){return l.outDir=e.dir,e}},vite:{configResolved(e){e.build.lib&&c(r,e.build.lib.entry),l.outDir=e.build.outDir},closeBundle(){const e=t.length.toString();this.environment.logger.info(`
-${s.green("✓")} ${e} declaration bundles generated.`);const n={maximumFractionDigits:2,minimumFractionDigits:2},a=Math.max(...t.map(o=>o.outFile.length));t.forEach(o=>this.environment.logger.info(s.dim(`${l.outDir}/`)+s.cyan(`${o.outFile}`)+" ".repeat(a-o.outFile.length+2)+s.gray(`${(o.size/1e3).toLocaleString("en",n)} kB  │ `)+s.dim(`gzip: ${(o.compressedSize/1e3).toLocaleString("en",n)} kB`)))}}}};exports.unpluginFactory=h;
+"use strict";const f=require("node:buffer"),g=require("node:fs"),c=require("node:path"),h=require("node:zlib"),y=require("dts-bundle-generator"),u=require("picocolors"),d=l=>{const a={},n=[],o=[];return{name:"unplugin-dts-bundle-generator",buildEnd(){o.forEach(e=>n.push({entryPointConfig:{filePath:e.in,libraries:l.libraries,output:l.output},outFile:e.out,size:-1,compressedSize:-1}))},writeBundle(){n.forEach((e,r)=>{const t=y.generateDtsBundle([e.entryPointConfig],l.compilation)[0];g.writeFileSync(e.outFile,t),n[r].size=f.Buffer.byteLength(t),n[r].compressedSize=h.gzipSync(t).length})},esbuild:{config(e){if(!e.entryPoints)return;const r=l,t=typeof e.entryPoints=="string"?[e.entryPoints]:Array.isArray(e.entryPoints)?e.entryPoints:Object.values(e.entryPoints);t.length===1&&(r.outfile||e.outfile)?o[0]={in:typeof t[0]=="string"?t[0]:t[0].in,out:r.outfile||e.outfile}:t.map(i=>typeof i!="string"?i:{in:i,out:c.basename(i).split(".")[0]}).forEach(i=>{o.push({in:i.in,out:`${e.outdir}/${i.out}.d.ts`})})}},rollup:{buildStart(e){Array.isArray(e.input)?e.input.forEach((r,t)=>o.push({in:r,out:`${t}`})):Object.entries(e.input).forEach(([r,t])=>o.push({in:t,out:r}))},outputOptions(e){const r=l;n.length===1&&(r.file||e.file)?n[0].outFile=r.file??e.file.replace(/\.js$/,".d.ts"):n.forEach((t,i)=>{const s=`${c.basename(t.entryPointConfig.filePath).split(".")[0]}.d.ts`;n[i].outFile=`${e.dir}/${s}`})}},vite:{configResolved(e){const r=l;if(e.build.lib){const t=(i="default")=>typeof r.fileName=="string"?`${e.build.outDir}/${r.fileName}`:`${e.build.outDir}/${r.fileName(i)}`;typeof e.build.lib.entry=="string"?o.push({in:e.build.lib.entry,out:t()}):Array.isArray(e.build.lib.entry)?e.build.lib.entry.forEach((i,s)=>o.push({in:i,out:t(`${s}`)})):Object.entries(e.build.lib.entry).forEach(([i,s])=>o.push({in:s,out:t(i)}))}a.outDir=e.build.outDir},closeBundle(){const e=n.length.toString();this.environment.logger.info(`
+${u.green("✓")} ${e} declaration bundles generated.`);const r=Math.max(...n.map(i=>i.outFile.length)),t={maximumFractionDigits:2,minimumFractionDigits:2};n.forEach(i=>this.environment.logger.info(u.dim(`${a.outDir}`)+u.cyan(i.outFile.replace(a.outDir??"",""))+" ".repeat(r-i.outFile.length+2)+u.gray(`${(i.size/1e3).toLocaleString("en",t)} kB`)+u.dim(` │ gzip: ${(i.compressedSize/1e3).toLocaleString("en",t)} kB`)))}}}};exports.unpluginFactory=d;

package/dist/factory.es.js

@@ -1,67 +1,103 @@
 import { Buffer as c } from "node:buffer";
-import f from "node:fs";
-import m from "node:path";
-import d from "node:zlib";
-import { generateDtsBundle as b } from "dts-bundle-generator";
-import l from "picocolors";
-const u = (i, t) => {
-  typeof t == "string" ? Object.assign(i, {
-    default: t
-  }) : Array.isArray(t) ? t.forEach((r) => {
-    Object.assign(i, {
-      [m.basename(r, m.extname(r))]: r
-    });
-  }) : Object.assign(i, t);
-}, z = (i) => {
-  const t = [], r = {}, s = {}, g = typeof i.fileName == "string" ? () => i.fileName : i.fileName;
+import m from "node:fs";
+import f from "node:path";
+import h from "node:zlib";
+import { generateDtsBundle as g } from "dts-bundle-generator";
+import u from "picocolors";
+const E = (l) => {
+  const a = {}, n = [], o = [];
   return {
     name: "unplugin-dts-bundle-generator",
     buildEnd() {
-      const e = Object.values(r).map((o) => ({
-        filePath: o,
-        libraries: i.libraries,
-        output: i.output
-      }));
-      b(e, i.compilation).forEach((o, a) => t.push({
-        compressedSize: d.gzipSync(o).length,
-        content: o,
-        outFile: g(Object.keys(r)[a]),
-        size: c.byteLength(o)
+      o.forEach((e) => n.push({
+        entryPointConfig: {
+          filePath: e.in,
+          libraries: l.libraries,
+          output: l.output
+        },
+        outFile: e.out,
+        size: -1,
+        compressedSize: -1
       }));
     },
     writeBundle() {
-      t.forEach((e) => f.writeFileSync(
-        m.resolve(s.outDir ?? "", e.outFile),
-        e.content
-      ));
+      n.forEach((e, r) => {
+        const t = g([e.entryPointConfig], l.compilation)[0];
+        m.writeFileSync(e.outFile, t), n[r].size = c.byteLength(t), n[r].compressedSize = h.gzipSync(t).length;
+      });
+    },
+    esbuild: {
+      config(e) {
+        if (!e.entryPoints)
+          return;
+        const r = l, t = typeof e.entryPoints == "string" ? [e.entryPoints] : Array.isArray(e.entryPoints) ? e.entryPoints : Object.values(e.entryPoints);
+        t.length === 1 && (r.outfile || e.outfile) ? o[0] = {
+          in: typeof t[0] == "string" ? t[0] : t[0].in,
+          out: r.outfile || e.outfile
+        } : t.map(
+          (i) => typeof i != "string" ? i : {
+            in: i,
+            out: f.basename(i).split(".")[0]
+          }
+        ).forEach((i) => {
+          o.push({
+            in: i.in,
+            out: `${e.outdir}/${i.out}.d.ts`
+          });
+        });
+      }
     },
     rollup: {
       buildStart(e) {
-        u(r, e.input);
+        Array.isArray(e.input) ? e.input.forEach((r, t) => o.push({
+          in: r,
+          out: `${t}`
+        })) : Object.entries(e.input).forEach(([r, t]) => o.push({
+          in: t,
+          out: r
+        }));
       },
       outputOptions(e) {
-        return s.outDir = e.dir, e;
+        const r = l;
+        n.length === 1 && (r.file || e.file) ? n[0].outFile = r.file ?? e.file.replace(/\.js$/, ".d.ts") : n.forEach((t, i) => {
+          const s = `${f.basename(t.entryPointConfig.filePath).split(".")[0]}.d.ts`;
+          n[i].outFile = `${e.dir}/${s}`;
+        });
       }
     },
     vite: {
       configResolved(e) {
-        e.build.lib && u(r, e.build.lib.entry), s.outDir = e.build.outDir;
+        const r = l;
+        if (e.build.lib) {
+          const t = (i = "default") => typeof r.fileName == "string" ? `${e.build.outDir}/${r.fileName}` : `${e.build.outDir}/${r.fileName(i)}`;
+          typeof e.build.lib.entry == "string" ? o.push({
+            in: e.build.lib.entry,
+            out: t()
+          }) : Array.isArray(e.build.lib.entry) ? e.build.lib.entry.forEach((i, s) => o.push({
+            in: i,
+            out: t(`${s}`)
+          })) : Object.entries(e.build.lib.entry).forEach(([i, s]) => o.push({
+            in: s,
+            out: t(i)
+          }));
+        }
+        a.outDir = e.build.outDir;
       },
       closeBundle() {
-        const e = t.length.toString();
+        const e = n.length.toString();
         this.environment.logger.info(`
-${l.green("✓")} ${e} declaration bundles generated.`);
-        const o = {
+${u.green("✓")} ${e} declaration bundles generated.`);
+        const r = Math.max(...n.map((i) => i.outFile.length)), t = {
           maximumFractionDigits: 2,
           minimumFractionDigits: 2
-        }, a = Math.max(...t.map((n) => n.outFile.length));
-        t.forEach((n) => this.environment.logger.info(
-          l.dim(`${s.outDir}/`) + l.cyan(`${n.outFile}`) + " ".repeat(a - n.outFile.length + 2) + l.gray(`${(n.size / 1e3).toLocaleString("en", o)} kB  │ `) + l.dim(`gzip: ${(n.compressedSize / 1e3).toLocaleString("en", o)} kB`)
+        };
+        n.forEach((i) => this.environment.logger.info(
+          u.dim(`${a.outDir}`) + u.cyan(i.outFile.replace(a.outDir ?? "", "")) + " ".repeat(r - i.outFile.length + 2) + u.gray(`${(i.size / 1e3).toLocaleString("en", t)} kB`) + u.dim(` │ gzip: ${(i.compressedSize / 1e3).toLocaleString("en", t)} kB`)
         ));
       }
     }
   };
 };
 export {
-  z as u
+  E as u
 };

package/dist/rollup.d.ts

@@ -1,12 +1,14 @@
 import { CompilationOptions, EntryPointConfig } from 'dts-bundle-generator';
 
-export interface Options {
-	fileName: string | ((entryName: string) => string);
+export interface DtsBundleGeneratorOptions {
 	output?: EntryPointConfig["output"];
 	libraries?: EntryPointConfig["libraries"];
 	compilation?: CompilationOptions;
 }
-declare const _default: (options: Options) => import("rollup").Plugin<any> | import("rollup").Plugin<any>[];
+export interface RollupOptions extends DtsBundleGeneratorOptions {
+	file?: string;
+}
+declare const _default: (options: RollupOptions) => import("rollup").Plugin<any> | import("rollup").Plugin<any>[];
 
 export {
 	_default as default,

package/dist/vite.d.ts

@@ -1,12 +1,14 @@
 import { CompilationOptions, EntryPointConfig } from 'dts-bundle-generator';
 
-export interface Options {
-	fileName: string | ((entryName: string) => string);
+export interface DtsBundleGeneratorOptions {
 	output?: EntryPointConfig["output"];
 	libraries?: EntryPointConfig["libraries"];
 	compilation?: CompilationOptions;
 }
-declare const _default: (options: Options) => import("vite").Plugin<any> | import("vite").Plugin<any>[];
+export interface ViteOptions extends DtsBundleGeneratorOptions {
+	fileName: string | ((entryName: string) => string);
+}
+declare const _default: (options: ViteOptions) => import("vite").Plugin<any> | import("vite").Plugin<any>[];
 
 export {
 	_default as default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-dts-bundle-generator",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "DTS bundle generator for Unplugin",
   "keywords": [
     "unplugin",
@@ -11,7 +11,10 @@
     "bundle",
     "typescript"
   ],
-  "repository": "https://github.com/f-lawe/unplugin-dts-bundle-generator",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/f-lawe/unplugin-dts-bundle-generator.git"
+  },
   "license": "MIT",
   "author": "François Lavaud-Wernert <francois@lavaud.family>",
   "type": "module",
@@ -21,6 +24,11 @@
       "import": "./dist/dts-bundle-generator.es.js",
       "require": "./dist/dts-bundle-generator.cjs.js"
     },
+    "./esbuild": {
+      "types": "./dist/esbuild.d.ts",
+      "import": "./dist/esbuild.es.js",
+      "require": "./dist/esbuild.cjs.js"
+    },
     "./rollup": {
       "types": "./dist/rollup.d.ts",
       "import": "./dist/rollup.es.js",
@@ -37,13 +45,13 @@
   "source": "src/index.ts",
   "types": "dist/dts-bundle-generator.d.ts",
   "scripts": {
-    "build": "npm run build:vite",
-    "build:rollup": "npm run build:vite & rollup --config rollup.config.ts",
-    "build:vite": "vite build",
+    "build": "vite build",
     "clean": "rimraf dist",
     "lint": "eslint . --fix && sort-package-json",
     "lint:ci": "eslint . && sort-package-json --check",
     "prepack": "npm run clean && npm run build",
+    "test:esbuild": "npm run build & rimraf dist-esbuild & node ./test/esbuild.config.ts",
+    "test:rollup": "npm run build & rimraf dist-rollup & rollup --config ./test/rollup.config.ts",
     "typecheck": "tsc --noEmit",
     "typecheck:ci": "tsc --noEmit",
     "watch": "vite build --watch"
@@ -58,11 +66,11 @@
     "@nuxt/schema": "^3.17.4",
     "@rollup/plugin-typescript": "^12.1.4",
     "@types/node": "^24.0.4",
+    "esbuild": "^0.25.8",
     "eslint": "^9.12.0",
     "jiti": "^2.4.2",
     "rimraf": "^6.0.1",
     "rollup": "^4.41.0",
-    "rollup-plugin-node-externals": "^8.0.0",
     "sort-package-json": "^3.3.1",
     "tslib": "^2.8.1",
     "typescript": "^5.0.2",