Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huozhi/bunchee
Zero config bundler for ECMAScript and TypeScript packages
https://github.com/huozhi/bunchee
bundler commonjs esmodule javascript jsx minify react rsc server-components typescript
Last synced: 3 days ago
JSON representation
Zero config bundler for ECMAScript and TypeScript packages
- Host: GitHub
- URL: https://github.com/huozhi/bunchee
- Owner: huozhi
- Created: 2018-10-21T16:00:08.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T14:47:39.000Z (15 days ago)
- Last Synced: 2024-12-05T12:03:39.124Z (9 days ago)
- Topics: bundler, commonjs, esmodule, javascript, jsx, minify, react, rsc, server-components, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/bunchee
- Size: 1.59 MB
- Stars: 949
- Watchers: 6
- Forks: 29
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bunchee
> Zero-config bundler for JS/TS packages.
**bunchee** is a zero configuration bundler makes bundling JS/TS library effortless. It's built on top of Rollup and SWC ⚡️, allowing you to focus on writing code and generating multiple bundles (CommonJS or ESModule) at the same time.
It uses the standard exports configuration in `package.json` as the only source of truth, and uses entry file conventions to match your exports and build them into bundles.
## Quick Start
### Installation
```sh
npm install --save-dev bunchee typescript
```
### Configuration
Create entry files of your library and `package.json`.
```sh
cd ./coffee
mkdir src && touch ./src/index.ts && touch package.json
```
Add the exports in `package.json`.
```json
{
"name": "coffee",
"type": "module",
"main": "./dist/index.js",
"scripts": {
"build": "bunchee"
}
}
```
#### Build
```sh
npm run build
```
Then files in `src` folders will be treated as entry files and match the export names in package.json.
Simply like Node.js module resolution, each export name will match the file in `src/` directory.
For example:
- `src/index.ts` will match the exports name `"."` or the only main export.
- `src/lite.ts` will match the exports name `"./lite"`.
- `src/react/index.ts` will match the exports name `"./react"`.
Now just run `npm run build` (or `pnpm build` / `yarn build`) if you're using these package managers, `bunchee` will find the entry files and build them.
The output format will based on the exports condition and also the file extension. Given an example:
- It's CommonJS for `require` and ESM for `import` based on the exports condition.
- It's CommonJS for `.js` and ESM for `.mjs` based on the extension regardless the exports condition. Then for export condition like "node" you could choose the format with your extension.
> [!NOTE]
> All the `dependencies` and `peerDependencies` will be marked as external automatically and not included in the bundle. If you want to include them in the bundle, you can use the `--no-external` option.
#### Prepare Package
```sh
# Use bunchee to prepare package.json configuration
npm exec bunchee prepare
# "If you're using other package manager such as pnpm"
# pnpm bunchee prepare
# "Or use with npx"
# npx bunchee@latest prepare
```
Or you can checkout the following cases to configure your package.json.
JavaScript ESModule
Then use use the [exports field in package.json](https://nodejs.org/api/packages.html#exports-sugar) to configure different conditions and leverage the same functionality as other bundlers, such as webpack. The exports field allows you to define multiple conditions.
```json
{
"files": ["dist"],
"type": "module",
"exports": {
".": "./dist/es/index.js",
"./react": "./dist/es/react.js"
},
"scripts": {
"build": "bunchee"
}
}
```
TypeScript
If you're build a TypeScript library, separate the types from the main entry file and specify the types path in package.json. Types exports need to stay on the top of each export with `types` condition, and you can use `default` condition for the JS bundle file.
```json
{
"files": ["dist"],
"type": "module",
"main": "./dist/index.js",
"exports": {
".": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"./react": {
"types": "./dist/react/index.d.ts",
"default": "./dist/react/index.js"
}
},
"scripts": {
"build": "bunchee"
}
}
```
Hybrid (CJS & ESM) Module Resolution with TypeScript
If you're using TypeScript with Node 10 and Node 16 module resolution, you can use the `types` field in package.json to specify the types path. Then `bunchee` will generate the types file with the same extension as the main entry file.
_NOTE_: When you're using `.mjs` or `.cjs` extensions with TypeScript and modern module resolution (above node16), TypeScript will require specific type declaration files like `.d.mts` or `.d.cts` to match the extension. `bunchee` can automatically generate them to match the types to match the condition and extensions.
```json
{
"files": ["dist"],
"type": "module",
"main": "./dist/index.js",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
"exports": {
"import": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"require": {
"types": "./dist/index.d.cts",
"default": "./dist/index.cjs"
}
},
"scripts": {
"build": "bunchee"
}
}
```
#### Lint Package
`lint` command will check the package.json configuration is valid or not, it can valid few things like:
- if the entry files are matched with the exports conditions.
- if the entry files are matched with the exports paths.
```sh
# Use bunchee to lint if the package.json configuration is valid
npm exec bunchee lint
```
## Usage
### File Conventions
While `exports` field is becoming the standard of exporting in node.js, bunchee also supports to build multiple exports all in one command.
Provide entry files with the name (`[name].[ext]`) that matches the exported name from exports field in package.json. For instance:
- `/src/index.ts` will match `"."` export name or the if there's only one main export.
- `/src/lite.ts` will match `"./lite"` export name.
The build script can be just `bunchee` without configure any input sources for each exports. Of course you can still specify other arguments as you need.
Briefly, the entry files from `src/` folder will do matching with `exports` conditions from `package.json` and build them into bundles.
Assuming you have default export package as `"."` and subpath export `"./lite"` with different exports condition listed in package.json
```json
{
"name": "example",
"scripts": {
"build": "bunchee"
},
"type": "module",
"exports": {
"./lite": "./dist/lite.js",
".": {
"import": "./dist/index.js",
"require": "./dist/index.cjs"
}
}
}
```
Then you need to add two entry files `index.ts` and `lite.ts` in project root directory to match the export name `"."` and `"./lite"`, bunchee will associate these entry files with export names then use them as input source and output paths information.
```
- my-lib/
|- src/
|- lite.ts
|- index.ts
|- package.json
```
It will also look up for `index.` file under the directory having the name of the export path. For example, if you have `"./lite": "./dist/lite.js"` in exports field, then it will look up for `./lite/index.js` as the entry file as well.
### Multiple Runtime
For exports condition like `react-native`, `react-server` and `edge-light` as they're special platforms, they could have different exports or different code conditions. In this case bunchee provides an override input source file convention if you want to build them as different code bundle.
For instance:
```json
{
"exports": {
"react-server": "./dist/react-server.mjs",
"edge-light": "./dist/edge-light.mjs",
"import": "./dist/index.mjs"
}
}
```
### Executables
To build executable files with the `bin` field in package.json, `bunchee` requires you to create the `bin` directory under `src` directory. The source file matching will be same as the entry files convention.
For example:
```bash
|- src/
|- bin/
|- index.ts
```
This will match the `bin` field in package.json as:
```json
{
"bin": "./dist/bin.js"
}
```
For multiple executable files, you can create multiple files under the `bin` directory.
```bash
|- src/
|- bin/
|- foo.ts
|- bar.ts
```
This will match the `bin` field in package.json as:
```json
{
"bin": {
"foo": "./dist/bin/a.js",
"bar": "./dist/bin/b.js"
}
}
```
> Note: For multiple `bin` files, the filename should match the key name in the `bin` field.
### Server Components
`bunchee` supports to build server components and server actions with library directives like `"use client"` or `"use server"`. It will generate the corresponding chunks for client and server that scope the client and server boundaries properly.
Then when the library is integrated to an app such as Next.js, app bundler can transform the client components and server actions correctly and maximum the benefits.
If you're using `"use client"` or `"use server"` in entry file, then it will be preserved on top and the dist file of that entry will become a client component.
If you're using `"use client"` or `"use server"` in a file that used as a dependency for an entry, then that file containing directives be split into a separate chunk and hoist the directives to the top of the chunk.
### Shared Modules
In some cases, you may need to share code across multiple bundles without promoting them to separate entries or exports. These modules should be bundled into shared chunks that can be reused by various bundles. By convention, files or directories prefixed with an underscore (`_.` or `_/index.`) are treated as **shared modules**. They're private and not exposed publicly as entry points or exports.
Shared Utils Example
```js
// src/_util.js
export function sharedUtil() {
/* ... */
}
```
You can then use them in different entry files:
```js
// src/index.js
import { sharedUtil } from './_util'
```
```js
// src/lite.js
import { sharedUtil } from './_util'
```
`bunchee` will bundle the shared module into a separate chunk, keeping it private and ensuring it's referenced by multiple entry bundles.
For scenarios involving multiple runtime bundles, such as `default` and `react-server`, modules that need to be shared and remain as a single instance across different runtime bundles can also follow this convention. The leading underscore (`_`) ensures that these modules are private to your application while facilitating reuse.
Shared Runtime Module Example
```js
'use client'
// src/_app-context.js
export const AppContext = React.createContext(null)
```
These modules can be imported in various runtime entry files:
```js
// src/index.js
import { AppContext } from './_app-context'
```
```js
// src/index.react-server.js
import { AppContext } from './_app-context'
```
The `_app-context` module will be bundled into a shared chunk that exists as a single instance across different runtime bundles.
This convention keeps shared modules private while enabling efficient bundling and reuse across your codebase.
### CLI
#### CLI Options
`bunchee` CLI provides few options to create different bundles or generating types.
- Output (`-o `): Specify output filename.
- Format (`-f `): Set output format (default: `'esm'`).
- External (`--external `): Specifying extra external dependencies, by default it is the list of `dependencies` and `peerDependencies` from `package.json`. Values are separate by comma.
- Target (`--target `): Set ECMAScript target (default: `'es2015'`).
- Runtime (`--runtime `): Set build runtime (default: `'browser'`).
- Environment (`--env `): Define environment variables. (default: `NODE_ENV`, separate by comma)
- Working Directory (`--cwd `): Set current working directory where containing `package.json`.
- Minify (`-m`): Compress output.
- Watch (`-w`): Watch for source file changes.
- No Clean(`--no-clean`): Do not clean the dist folder before building. (default: `false`)
- TSConfig (`--tsconfig `): Specify the path to the TypeScript configuration file. (default: `tsconfig.json`)
- Bundle Types (`--dts-bundle`): Bundle type declaration files. (default: `false`)
```sh
cd
# specifying input, output and format
bunchee ./src/index.js -f cjs -o ./dist/bundle.js
bunchee ./src/index.js -f esm -o ./dist/bundle.esm.js
# build node.js library, or change target to es2019
bunchee ./src/index.js --runtime node --target es2019
```
#### Specifying extra external dependencies
By default, `bunchee` will mark all the `dependencies` and `peerDependencies` as externals so you don't need to pass them as CLI args.
But if there's any dependency that used but not in the dependency list and you want to mark as external, you can use the `--external` option to specify them.
```sh
bunchee --external=dep1,dep2,dep3
```
Replace `dep1`, `dep2`, and `dep3` with the names of the dependencies you want to exclude from the bundle.
#### Bundling everything without external dependencies
To bundle your library without external dependencies, use the `--no-external` option:
```sh
bunchee --no-external
```
This will include all dependencies within your output bundle.
### Environment Variables
To pass environment variables to your bundled code, use the --env option followed by a comma-separated list of environment variable names:
```bash
bunchee --env=ENV1,ENV2,ENV3
```
Replace `ENV1`, `ENV2`, and `ENV3` with the names of the environment variables you want to include in your bundled code. These environment variables will be inlined during the bundling process.
You can use `index..` to override the input source file for specific export name. Or using `/index..` also works. Such as:
```
|- src/
|- index/.ts
|- index.react-server.ts
|- index.edge-light.ts
```
This will match the export name `"react-server"` and `"edge-light"` then use the corresponding input source file to build the bundle.
#### Auto Development and Production Mode
`process.env.NODE_ENV` is injected by default if present that you don't need to manually inject yourself. If you need to separate the development build and production build, `bunchee` provides different export conditions for development and production mode with `development` and `production` export conditions.
```json
{
"exports": {
"development": "./dist/index.development.js",
"production": "./dist/index.production.js"
}
}
```
Then you can use `bunchee` to build the development bundle and production bundle automatically.
### CSS
`bunchee` has basic CSS support for pure CSS file imports. It will be bundled into js bundle and insert the style tag into the document head when the bundle is loaded by browser.
```css
/* src/style.css */
.foo {
color: orange;
}
```
```tsx
// src/index.tsx
import './style.css'
export const Foo = () =>
foo
```
### Text Files
If you just want to import a file as string content, you can name the extension as `.txt` or `.data` and it will be bundled as string content.
For example:
src/index.ts
```js
import data from './data.txt'
export default data
```
src/data.txt
```txt
hello world
```
output
```
export default "hello world"
```
### Node.js API
```ts
import path from 'path'
import { bundle, type BundleConfig } from 'bunchee'
// The definition of these options can be found in help information
await bundle(path.resolve('./src/index.ts'), {
dts: false, // Boolean
watch: false, // Boolean
minify: false, // Boolean
sourcemap: false, // Boolean
external: [], // string[]
format: 'esm', // 'esm' | 'cjs'
target: 'es2015', // ES syntax target
runtime: 'nodejs', // 'browser' | 'nodejs'
cwd: process.cwd(), // string
clean: true, // boolean
tsconfig: 'tsconfig.json', // string
})
```
#### Watch Mode
Bunchee offers a convenient watch mode for rebuilding your library whenever changes are made to the source files. To enable this feature, use either `-w` or `--watch`.
#### `target`
If you specify `target` option in `tsconfig.json`, then you don't have to pass it again through CLI.
To target a range of browsers, you can use the `browserslist` field in `package.json`, bunchee will use it to determine the target browsers for the output bundle.
For example:
```json
{
"browserslist": [
"last 1 version",
"> 1%",
"maintained node versions",
"not dead"
]
}
```
#### Package lint
`bunchee` has support for checking the package bundles are matched with package exports configuration.
### License
MIT