https://github.com/devgauravjatt/obuild-starter

A minimal yet powerful ⚙️ starter template for creating packages with obuild.
https://github.com/devgauravjatt/obuild-starter

antfu npm oxc oxc-resolver package-builder packge rolldown starter-project starter-template unjs unjs-nitro vite

Last synced: 25 days ago
JSON representation

A minimal yet powerful ⚙️ starter template for creating packages with obuild.

• Host: GitHub
• URL: https://github.com/devgauravjatt/obuild-starter
• Owner: devgauravjatt
• License: mit
• Created: 2025-06-16T11:47:46.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-06-16T12:04:42.000Z (12 months ago)
• Last Synced: 2025-06-16T12:49:40.113Z (12 months ago)
• Topics: antfu, npm, oxc, oxc-resolver, package-builder, packge, rolldown, starter-project, starter-template, unjs, unjs-nitro, vite
• Language: TypeScript
• Homepage:
• Size: 52.7 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ⚡️ Obuild-starter

[![License](https://img.shields.io/github/license/devgauravjatt/obuild-starter?style=for-the-badge)](https://github.com/devgauravjatt/obuild-starter/LICENSE)

[![TypeScript](https://img.shields.io/badge/TypeScript-4.x-blue?style=for-the-badge&logo=typescript)](https://www.typescriptlang.org/)

[![pnpm](https://img.shields.io/badge/Built%20with-pnpm-F69220?style=for-the-badge&logo=pnpm)](https://pnpm.io)

[![Vitest](https://img.shields.io/badge/Tested%20with-Vitest-6E9F18?style=for-the-badge&logo=vitest)](https://vitest.dev)

[![ESLint](https://img.shields.io/badge/Code%20style-Antfu-4B32C3?style=for-the-badge&logo=eslint)](https://github.com/antfu/eslint-config)

[![Prettier](https://img.shields.io/badge/Formatted%20with-Prettier-F7B93E?style=for-the-badge&logo=prettier)](https://prettier.io/)

A minimal yet powerful ⚙️ **starter template** for creating packages with [`obuild`](https://github.com/unjs/obuild).

---

## ✨ Features

- 🚀 **Zero-config** setup with [`obuild`](https://github.com/unjs/obuild)

- 🧑‍💻 **TypeScript** with strict mode support

- 🧹 **ESLint** using [@antfu/eslint-config](https://github.com/antfu/eslint-config)

- 🧼 **Prettier** for consistent formatting

- 🧪 **Vitest** for blazing fast tests

- 📦 **Single-command release** using [bumpp](https://github.com/antfu/bumpp)

---

## 🚀 Getting Started

```bash

# 1. Clone the repo

git clone https://github.com/devgauravjatt/obuild-starter.git

# 2. Install dependencies

pnpm install

# 3. Build your package

pnpm run build

# 4. Run tests

pnpm run test

# 5. Type-check your code

pnpm run typecheck

# 6. Format code

pnpm run format

# 7. Release (bump version + publish to npm)

pnpm run release

```

---

## 📦 Ideal For

- Rapidly starting a new npm package

- Building TypeScript-first libraries

- Maintaining consistent lint/format/test configs across projects

---

## 📝 License

MIT License © 2025

Made with ❤️ by [Dev Gaurav Jatt](https://github.com/devgauravjatt)