unbuild


> A unified JavaScript build system

$3

Robust rollup based bundler that supports typescript and generates commonjs and module formats + type declarations.

$3

Automagically infer build config and entries from package.json.

$3

Integration with mkdist for generating bundleless dists with file-to-file transpilation.

$3

Stub dist once using unbuild --stub (powered by jiti) and you can try and link your project without needing to watch and rebuild during development.

$3

Integration with untyped.

$3

Automatically check for various build issues such as potential missing and unused dependencies and fail CI.

CLI output also includes output size and exports for quick inspection.

Usage

Create src/index.ts:

``js
export const log = (...args) => {
console.log(...args);
};
`

Update package.json:

`json
{
"type": "module",
"scripts": {
"build": "unbuild",
"prepack": "unbuild"
},
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
},
"main": "./dist/index.cjs",
"types": "./dist/index.d.ts",
"files": ["dist"]
}
`

> Note
> You can find a more complete example in unjs/template for project setup.

Build with unbuild:

`sh
npx unbuild
`

Configuration is automatically inferred from fields in package.json mapped to src/ directory. For more control, continue with next section.

Configuration

Create build.config.ts:

`js
export default {
entries: ["./src/index"],
};
`

You can either use unbuild key in package.json or build.config.{js,cjs,mjs,ts,mts,cts,json} to specify configuration.

See options here.

Example:

`js
import { defineBuildConfig } from "unbuild";

export default defineBuildConfig({
// If entries is not provided, will be automatically inferred from package.json
entries: [
// default
"./src/index",
// mkdist builder transpiles file-to-file keeping original sources structure
{
builder: "mkdist",
input: "./src/package/components/",
outDir: "./build/components",
},
],

// Change outDir, default is 'dist'
outDir: "build",

// Generates .d.ts declaration file
declaration: true,
});
`

Or with multiple builds you can declare an array of configs:

`js
import { defineBuildConfig } from "unbuild";

export default defineBuildConfig([
{
// If entries is not provided, will be automatically inferred from package.json
entries: [
// default
"./src/index",
// mkdist builder transpiles file-to-file keeping original sources structure
{
builder: "mkdist",
input: "./src/package/components/",
outDir: "./build/components",
},
],

// Change outDir, default is 'dist'
outDir: "build",

/**
compatible means "src/index.ts" will generate "dist/index.d.mts", "dist/index.d.cts" and "dist/index.d.ts".
node16 means "src/index.ts" will generate "dist/index.d.mts" and "dist/index.d.cts".
true is equivalent to compatible.
false will disable declaration generation.
undefined will auto detect based on "package.json". If "package.json" has "types" field, it will be "compatible", otherwise false.
*/
declaration: "compatible",
},
{
name: "minified",
entries: ["./src/index"],
outDir: "build/min",
rollup: {
esbuild: {
minify: true,
},
},
},
]);
`

Recipes

$3

In build.config.ts

`ts
import { defineBuildConfig } from "unbuild";

export default defineBuildConfig({
rollup: {
esbuild: {
tsconfigRaw: {
compilerOptions: {
experimentalDecorators: true,
},
},
},
},
});
`

$3

`ts
import { defineBuildConfig } from "unbuild";

export default defineBuildConfig({
sourcemap: true,
});
`

💻 Development

- Clone this repository
- Enable Corepack using corepack enable (use npm i -g corepack for Node.js < 16.10)
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev`

License

MIT

[npm-version-src]: https://img.shields.io/npm/v/unbuild?style=flat-square
[npm-version-href]: https://npmjs.com/package/unbuild
[npm-downloads-src]: https://img.shields.io/npm/dm/unbuild?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/unbuild
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/unjs/unbuild/ci.yml?style=flat-square
[github-actions-href]: https://github.com/unjs/unbuild/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/unbuild/main?style=flat-square
[codecov-href]: https://codecov.io/gh/unjs/unbuild