bundlib

library0.21.9jsnpmunverified

Bundlib is an automatic library bundler built on top of Rollup.js, designed to streamline the process of packaging JavaScript and TypeScript libraries. The current stable version is 0.21.9, with active development indicated by frequent patch releases (0.21.9, 0.21.8, 0.21.7, etc.) that introduce new features like parallel builds and improved CLI commands, alongside bug fixes. It aims to simplify Rollup configuration for common library bundling scenarios, offering both automatic configuration derived from `package.json` and advanced programmatic or file-based configuration via `defineConfig`. A key differentiator is its focus on opinionated defaults to reduce setup complexity, while still allowing fine-grained control for various build types (ESM, CJS, UMD, types). Users should note that while powerful, the project is explicitly stated to be "under development," suggesting potential for evolving APIs or unresolved edge cases. It ships with TypeScript types and requires Node.js >=18.

web-framework devops

npm install bundlib

github ↗package ↗

INSTALL

IMPORT

SIG · BUNDLIB

bundlib

web-frameworkjavascriptv0.21.9

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

defineConfig

✓ import { defineConfig } from 'bundlib'

✗ const { defineConfig } = require('bundlib');

Primarily used in `bundlib.config.ts` or `bundlib.config.js` files for type-safe configuration. CommonJS `require` is incorrect in most modern Node.js environments as Bundlib targets ESM.

bundlib

✓ import { bundlib } from 'bundlib'

✗ const bundlib = require('bundlib').bundlib;

The main programmatic function for initiating a build. Bundlib is an ESM-first package, requiring named imports even for the main function.

BundlibConfig

✓ import type { BundlibConfig } from 'bundlib'

✗ import { BundlibConfig } from 'bundlib'

This is a TypeScript type definition, exclusively for type-checking. Using `type` import is crucial to prevent runtime errors or unnecessary bundling in modern TypeScript.

Demonstrates defining a multi-format library configuration using `defineConfig` in a `bundlib.config.ts` file, and shows how to invoke the build via the CLI in `package.json`.

/* bundlib.config.ts */ import { defineConfig } from 'bundlib'; export default defineConfig({ input: 'src/index.ts', // Your main entry point output: [ { format: 'es', file: 'dist/index.mjs', sourcemap: true }, { format: 'cjs', file: 'dist/index.cjs', sourcemap: true }, { format: 'umd', file: 'dist/index.umd.js', name: 'MyLibrary', sourcemap: true } ], // Optional: Define external dependencies to prevent bundling them external: ['lodash'], // Optional: Configure TypeScript for type declarations project: 'tsconfig.json', // Optional: Enable minification for production builds min: process.env.NODE_ENV === 'production' }); /* package.json */ // Add a script to your package.json // "scripts": { // "build": "bundlib build", // "watch": "bundlib watch" // } // To run the build: // npm install --save-dev bundlib rollup typescript // npm run build

bundlib --version

Debug

Known issues

gotchaBundlib is explicitly stated to be "under development". This implies that APIs might still evolve, and users should be prepared for potential changes or edge cases as the project matures.

fix

Monitor official releases and changelogs closely for updates. Consider pinning to minor versions and thoroughly testing updates in a staging environment.

affects: >=0.1.0

breakingBundlib requires Node.js version >=18. Running with older Node.js versions will result in execution errors.

fix

Upgrade your Node.js environment to version 18 or newer using tools like `nvm` or by installing a recent Node.js distribution.

affects: >=0.21.0

breakingCLI commands for `build` and `watch` were significantly refactored and introduced in version 0.21.5, potentially changing how users interact with the bundler from the command line.

fix

Refer to the updated documentation or run `bundlib --help` to understand the correct CLI syntax for `build` and `watch` commands. Ensure your `package.json` scripts are updated accordingly.

affects: >=0.21.5

gotchaUpgrades to underlying Rollup plugins (e.g., `@rollup/plugin-commonjs` fix in v0.21.4) can introduce subtle breaking changes or require configuration adjustments, particularly for browser builds.

fix

Always test new Bundlib versions thoroughly, especially if you rely on specific Rollup plugins or complex build configurations. Consult the Rollup plugin's changelogs for breaking changes when updating Bundlib.

affects: >=0.21.4

Errors

Common errors & fixes

Error: Cannot find module 'bundlib' or its corresponding type declarations.

Attempting to `require()` Bundlib in a CommonJS context when it's primarily an ESM package, or incorrect module resolution in a TypeScript project.

fix

Ensure you are using ESM `import` statements (e.g., `import { defineConfig } from 'bundlib';`). For TypeScript, verify `moduleResolution` in `tsconfig.json` supports modern ESM (e.g., `"node16"` or `"bundler"`).

Error: Your current Node.js version is X. Bundlib requires Node.js >=18.

Running Bundlib with an unsupported Node.js version as specified in its `engines` field.

fix

Update your Node.js environment to version 18 or newer. Use `nvm install 18` and `nvm use 18` or similar version management tools.

Error: Missing "input" option

The Rollup configuration generated by Bundlib lacks a specified entry point for bundling.

fix

Ensure your `bundlib.config.ts` or `package.json` configuration explicitly defines the `input` option, pointing to your library's main source file (e.g., `input: 'src/index.ts'`).

TypeError: bundlib.defineConfig is not a function

Incorrect import of `defineConfig` or attempting to access it as a property of a default import.

fix

Use named import: `import { defineConfig } from 'bundlib';`. If using CommonJS, ensure your setup correctly transpiles ESM or update to an ESM-compatible environment.

Upgrade

Version history

0.21.9latest on npm

Audit

Dependencies

rolluprequiredBundlib is powered by Rollup.js and uses it for the underlying bundling process. It's a fundamental dependency for Bundlib's operation.

Agent activity

10 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/manferlo81/bundlib ↗

packagehttps://www.npmjs.com/package/bundlib ↗