https://github.com/unjs/obuild
📦 😯 Zero-config ESM/TS package builder. powered by oxc, rolldown and rolldown-plugin-dts.
https://github.com/unjs/obuild
Last synced: about 2 months ago
JSON representation
📦 😯 Zero-config ESM/TS package builder. powered by oxc, rolldown and rolldown-plugin-dts.
- Host: GitHub
- URL: https://github.com/unjs/obuild
- Owner: unjs
- License: mit
- Created: 2025-04-16T13:36:55.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-01-20T01:24:09.000Z (about 2 months ago)
- Last Synced: 2026-01-20T06:12:17.321Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.42 MB
- Stars: 372
- Watchers: 4
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - unjs/obuild - 📦 😯 Zero-config ESM/TS package builder. (TypeScript)
README
# 📦 obuild 😯
✅ Zero-config ESM/TS package builder.
Powered by [**oxc**](https://oxc.rs/), [**rolldown**](https://rolldown.rs/) and [**rolldown-plugin-dts**](https://github.com/sxzz/rolldown-plugin-dts).
The **obuild** project aims to be the next-generation successor to the current [unbuild](https://github.com/unjs/unbuild).
- 👌 Focus on ESM compatibility.
- 🌱 Fresh rewrite with cleanups and removal of legacy features.
- 🚀 Using [**oxc**](https://oxc.rs/) (for transform) and [**rolldown**](https://rolldown.rs/) (for bundle) for much faster builds!
Some differences are not easy to adopt. Developing as a standalone project allows for faster progress and dogfooding in real projects.
## Proof of Concept
> [!IMPORTANT]
>
> This is a proof-of-concept project.
>
> Features are incomplete, and API and output behavior may change between 0.x versions.
>
> Feedback and contributions are very welcome! If you'd like to make changes with more than a few lines of code, please open an issue first to discuss.
## Currently Used by
- [📦 obuild](https://github.com/unjs/obuild/)
- [🌳 rou3](https://github.com/h3js/rou3/)
- [💥 srvx](https://github.com/h3js/srvx)
- [🕊️ unenv](https://github.com/unjs/unenv)
- [🕰️ omnichron](https://github.com/oritwoen/omnichron)
- [⚙️ c12](https://github.com/unjs/c12)
- [...add yours...]
## Usage
### CLI
```sh
# bundle
npx obuild ./src/index.ts
# transform
npx obuild ./src/runtime/:./dist/runtime
```
You can use `--dir` to set the working directory.
If paths end with `/`, obuild uses transpile mode using [oxc-transform](https://www.npmjs.com/package/oxc-transform) instead of bundle mode with [rolldown](https://rolldown.rs/).
### Programmatic
```js
import { build } from "obuild";
await build({
cwd: ".",
entries: ["./src/index.ts"],
});
```
## Config
You can use `build.config.mjs` (or `.ts`) or pass config to `build()` function.
```js
import { defineBuildConfig } from "obuild/config";
export default defineBuildConfig({
entries: [
{
type: "bundle",
input: ["./src/index.ts", "./src/cli.ts"],
// outDir: "./dist",
// minify: false,
// stub: false,
// rolldown: {}, // https://rolldown.rs/reference/config-options
// dts: {}, // https://github.com/sxzz/rolldown-plugin-dts#options
},
{
type: "transform",
input: "./src/runtime",
outDir: "./dist/runtime",
// minify: false,
// stub: false,
// oxc: {},
// resolve: {}
},
],
hooks: {
// start: (ctx) => {},
// end: (ctx) => {},
// entries: (entries, ctx) => {},
// rolldownConfig: (config, ctx) => {},
// rolldownOutput: (output, res, ctx) => {},
},
});
```
## Stub Mode
When working on a package locally, it can be tedious to rebuild or run the watch command every time.
You can use `stub: true` (per entry config) or the `--stub` CLI flag. In this mode, obuild skips the actual build and instead links the expected dist paths to the source files.
- For bundle entries, `.mjs` and `.d.mts` files re-export the source file.
- For transpile entries, src dir is symlinked to dist.
**Caveats:**
- You need a runtime that natively supports TypeScript. Deno, Bun, Vite, and Node.js (1)
- For transpile mode, you need to configure your bundler to resolve either `.ts` or `.mjs` extensions.
- For bundle mode, if you add a new entry or add/remove a `default` export, you need to run the stub build again.
(1) For Node.js, you have several options:
- Using `node --experimental-strip-types` (Available in [22.6](https://nodejs.org/en/blog/release/v22.6.0))
- Using [jiti](https://github.com/unjs/jiti) (`node --import jiti/register`)
- Using [oxc-node](https://github.com/oxc-project/oxc-node) (`node --import @oxc-node/core/register`)
- Using [unloader](https://github.com/sxzz/unloader) (`node --import unloader/register`)
## Prior Arts
- [unbuild](https://github.com/unjs/unbuild): Stable solution based on rollup and [mkdist](https://github.com/unjs/mkdist).
- [tsdown](https://tsdown.dev/): Alternative bundler based on rolldown.
## License
💛 Released under the [MIT](./LICENSE) license.