https://github.com/groupguanfang/unbuilder
⚡️Another simple and easy to use unified build tool for JavaScript/TypeScript projects 📦 easily switch rollup/vite/swc/esbuild/tsc and more compiler
https://github.com/groupguanfang/unbuilder
esbuild rollup swc tsc typescript vite
Last synced: 4 months ago
JSON representation
⚡️Another simple and easy to use unified build tool for JavaScript/TypeScript projects 📦 easily switch rollup/vite/swc/esbuild/tsc and more compiler
- Host: GitHub
- URL: https://github.com/groupguanfang/unbuilder
- Owner: Groupguanfang
- Created: 2024-11-25T07:20:04.000Z (over 1 year ago)
- Default Branch: v1
- Last Pushed: 2024-11-29T16:36:37.000Z (over 1 year ago)
- Last Synced: 2025-04-16T20:23:34.442Z (about 1 year ago)
- Topics: esbuild, rollup, swc, tsc, typescript, vite
- Language: TypeScript
- Homepage: https://github.com/Groupguanfang/unbuilder
- Size: 649 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📦 unbuilder
Another `simple` and `easy to use` unified build tool for JavaScript/TypeScript projects.
## ✨ Features
- ⚔️ Multi-builder support:
- 🔪 `rollup` + `swc`/`tsc`: `stable`
- 🔪 `bundle-dts-generator`: `stable`
- 🔪 `tsup`: `stable`
- 🔪 `vite-lib-mode`: `stable`
- 🔪 `esbuild`: `stable`, but since tsup is based on esbuild, if you use this builder, you might as well use tsup (OAQ?)
- 🔪 `rolldown`: `experimental`, not recommended for production.
- 🌎️ Default automatically lookup your `package.json` and `tsconfig.json` to generate:
- 🔪 `input/entry` options from `package.json` `main`/`exports` fields
- 🔪 `output` options from `package.json` `main`/`exports` fields
- 🔪 `external` dependencies from `package.json` `dependencies`/`peerDependencies`/`devDependencies`/`optionalDependencies` fields
- 🔪 `alias` paths options from `tsconfig.json`'s `compilerOptions.paths` field
- 🚀 Support `.vue` file out of box, built-in `postcss plugin` and support for `.vue` files, good👌
- 📻 Support `d.ts` file generation, use `rollup-plugin-dts` to generate `d.ts` files. We also can generate `.vue` file's `.d.ts` file, start writing component libraries has never been easier😉
## ⬇️ Install
```bash
pnpm install unbuilder
```
## ✍️ How to use
When you create a new project, you will create a `src` directory, write your project code, and of course you will declare the `main`/`module`/`types`/`exports` fields in the `package.json`.
`unbuilder` automatically recognizes the fields in your `package.json`. After specifying the `main`/`module`/`types`/`exports` fields, add the `unbuilder` field to the `package.json`, add a configuration array, and then execute `npm run build`. Cool! The files you want are transpiled.
```json
// package.json
{
"name": "my-project",
// Specify the main/module/types/exports fields
"main": "dist/index.cjs",
"module": "dist/index.mjs",
"types": "dist/index.d.ts",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs",
"types": "./dist/index.d.ts"
}
},
// Add scripts
"scripts": {
"build": "unbuilder"
},
"unbuilder": {
// Add configuration array
"config": [
// `rollup` is mean to use rollup to build
"rollup",
// `bundle-dts-generator` is mean to generate `d.ts` files
"bundle-dts-generator"
]
}
}
```
By default, `rollup` builder will use `swc` to transpile the code, and `rollup-dts` builder will use `dts-bundle-generator` to generate `d.ts` files.
If you don't want to write in package.json, you can also write the configuration in the `unbuilder.config.ts` file:
```ts
import { defineConfig } from 'unbuilder'
export default defineConfig([
'vite-lib-mode',
'bundle-dts-generator'
])
```
You can see how simple the configuration items are no matter where they are declared, cool!😎
## Custom configuration
If the basic rollup preset does not meet your requirements, you can customize the configuration in the `unbuilder.config.ts`:
```ts
import { defineConfig } from 'unbuilder'
export default defineConfig([
{
builder: 'vite-lib-mode',
// vite config
viteOptions: {}
},
{
builder: 'bundle-dts-generator',
// bundle-dts-generator config, please see definitions
buildOptions: {}
}
])
```
For more information, please refer to the tsdoc comments in the source code.
## Author & License
[Naily Zero](https://github.com/groupguanfang) & MIT