AbdUlHamedMaree
lbundle
Small zero-configuration bundler build on top of Rollup.js and SWC for NPM libraries
🚀 Motivation
There is always this repeated pattern for creating a library while following best practices that you need to maintain across all of your libraries, but then I thought maybe creating a library for bundling libraries is a good idea.
💾 install
NPM registry
# npm
npm i -D lbundle
# yarn
yarn add -D lbundle
# pnpm
pnpm i -D lbundle
# bun
bun i -D lbundleJSR registry
# deno
deno add -D @mrii/lbundle
# jsr
npx jsr add -D @mrii/lbundle🔧 Usage
package.json
This bundler heavily relay on your package.json best practices.
{
"source": "./src/index.ts", // your source code entry
"main": "./dist/index.js", // cjs entry
"module": "./dist/index.mjs", // esm entry
"types": "./dist/index.d.ts", // declaration entry
"unpkg": "./dist/index.umd.js", // umd entry
// "unpkg": "./dist/index.amd.js", // or as amd
// "unpkg": "./dist/index.iife.js", // or as iife
"bin:source": "./src/cli.ts", // your source code bin entry
"bin": "./dist/cli.js", // bin entry
"sideEffects": false, // enable tree shaking for your library code, also useful for users bundlers
// the bundler will check for for different extension to bundle different formats
"exports": {
".": {
"default": "./dist/index.js",
"node": "./dist/index.js",
"require": "./dist/index.js",
"import": "./dist/index.mjs",
"types": "./dist/index.d.ts"
},
"./index.css": "./dist/index.css",
"./package.json": "./package.json"
}
}CLI
Just call lbundle binary
lbundleAnd That's it, it will generate the bundle for you at the target directory.
✨ Features
- 🤩 all in 1: supports bundling your library and binary into all known formats (
esm,cjs,umd,amdandiife), and generate declarations files as well. - 🚀 fast: it uses rust to compile source code into target env.
- 🍙 bun: can be used with
bunx --bun lbundleto speed up the bundling even more. - 🌲 tree shaking: it will preserve your file structure (for
cjsandesmformats) so bundlers can exclude unused code easily. - 🎮 typescript: it supports bundling typescript code out of the box (make sure have
typescriptinstalled). - 🎯 JSX: supports JSX transformation out of the box (make sure have
reactandreact-dominstalled). - 💅 styles: it support all kind of style files:
css,pcss,sss: out of the box.scss,sass: just installsass.less: just installless.styl,stylus: just installstylus.
- 🍇 CSS modules: all styles files support CSS modules by just appending
.module.before the file extension. - 🗺️ path alias: supports TS
pathandbaseUrltransformation. - 📤 auto externals: look for your
dependenciesandpeerDependenciesand exclude them from the bundle. - 🪛 json: supports importing
jsonfiles in your code. - 📦 polyfills: supports adding polyfills to the bundle if you're using latest ES features (make sure to have
core-jsinstalled)
🛣️ Roadmap
- <input checked="" disabled="" type="checkbox"> bundling into UMD and AMD formats.
- <input checked="" disabled="" type="checkbox"> reading
exportsfield and generate extra output according to it. - <input disabled="" type="checkbox">
vuejsx transformation. - <input disabled="" type="checkbox"> extending SWC and Rollup config.
- <input disabled="" type="checkbox"> useful logs.
- <input disabled="" type="checkbox"> schema validation and useful errors.
- <input disabled="" type="checkbox"> bundle info.
- <input disabled="" type="checkbox"> watch mode.
- <input disabled="" type="checkbox"> more options.
- <input disabled="" type="checkbox"> single entry instead of preserved modules.
- <input disabled="" type="checkbox"> JSX transformation options.
- ...
- <input disabled="" type="checkbox"> tests (partially done).
- <input checked="" disabled="" type="checkbox"> CI.
- <input checked="" disabled="" type="checkbox"> changelog.
- <input disabled="" type="checkbox"> contributors.
🧰 API
// esm
import { lbundle } from 'lbundle';
// cjs
const { lbundle } = require('lbundle');
// deno
import { lbundle } from '@mrii/lbundle';
await lbundle({
/* options */
});🔍 Options
| key | cli | default | description | version |
|---|---|---|---|---|
cwd |
---cwd, -c |
"." |
root dir path of your lib | 1.0.0 |