bun-boilerplate 🚀

Developer Ready: A comprehensive template. Works out of the box for most Bun.js projects. This project is intended to be used with the latest active LTS release of Bun.js.

Instant Value - All basic tools included and configured:

• 🚀 Typescript >= 5.3
• 🧅 Bun.js >= 1.0.26
• 🧅 Use Bun as package manager
• 🌈 ESM
• 🧪 Biome for code formatting and linting
• ✅ Jest or Bun test for fast unit testing and code coverage
• 📚 Type definitions for Bun.js and Jest
• ⚙️ EditorConfig for consistent coding style
• 📦 NPM scripts for common operations
• 🛠️ Example configuration for GitHub Actions
• 📝 Simple example of TypeScript code and unit test
• 🐗 Run tasks with Grunt (example for backup)
• 🚄 Build faster
• 🖥️ Ungit for version control (git) with a GUI
• 📘 Runtime library for TypeScript helpers with tslib
• 🗃️ Utility functions for working with ts-api-utils

---

📌 Usage

To use this template, use the following commands:

bun create github.com/RajaRakoto/bun-boilerplate <project-name>
cd <project-name>
bun run pkg-upgrade # to upgrade outdated dependencies in interactive mode

NOTE 1: I employ the MIT license for this starter kit, which includes my name and GitHub profile. Please remember to adjust or remove it if deemed unnecessary.

NOTE 2: In order to help you better understand the structure of this boilerplate, there is a README.md file in each subdirectory of src.

NOTE 3: For certain configurations in the package.json file, you need to modify them to tailor them to your project (e.g: name, description, author, keywords, main, repository, ...).

---

📌 NPM Scripts

Start

• 📜 start - Run your application with bun.
• 📜 start:smol - Run your application with bun and a flag which configures the JavaScriptCore heap size to be smaller and grow slower.
• 📜 start:bin - Run your standalone binary app.

Clean

• 📜 clean - Remove coverage data, prod, build.

Development

• 📜 dev - Launch your application in development mode with bun.
• 📜 dev:watch - Interactive watch mode to automatically transpile source files with bun in development.
• 📜 dev:hot - Hot reloading of source files with bun in development.
• 📜 dev:smol:watch - Interactive watch mode to automatically transpile source files with bun in development, while using --smol flag.
• 📜 dev:smol:hot - Hot reloading source files with bun in development, while using --smol flag.

Build

• 📜 build - Transpile and bundle source files with bun.
• 📜 build:watch - Interactive watch mode to automatically transpile source files with bun.
• 📜 build:bin - bun's bundler implements a --compile flag for generating a standalone binary from a TypeScript or JavaScript file, use this in your production environment to ensure optimal execution of your app.

Testing

• 📜 test - Run bun test.
• 📜 test:watch - Interactive watch mode to automatically re-run tests with bun.

Linting and Formatting

• 📜 biome:start - Starts the Biome daemon server. You can specify a custom configuration file path using the --config-path option.
• 📜 biome:stop - Stops the Biome daemon server.
• 📜 biome:fix - Runs a source code check and applies automatic fixes (linter & formatter) according to the defined rules.
• 📜 biome:unsafe - Works like biome:fix, but may apply more invasive or risky changes.

Backup and Dependency Management

• 📜 backup - Backup files with Grunt.
• 📜 pkg-check - Check useless dependencies with depcheck.
• 📜 pkg-upgrade - Upgrade outdated dependencies (interactive mode) with npm-check-updates.

Versioning

• 📜 versioning - Start ungit server.

NPM Commands

• 📜 npm-version:major - Increments the major version number of your project using npm.
• 📜 npm-version:minor - Increments the minor version number of your project using npm.
• 📜 npm-version:patch - Increments the version patch number of your project using npm.

---

📌 Build

When using the build.js file in this boilerplate, it's important to note the significance of the target option. By default, if the target option is not specified in the build.js file, it will be set to browser. However, for projects utilizing the bun.js runtime environment, it's imperative to explicitly set the target to bun. This guarantees compatibility with the bun shell environment and prevents unexpected behavior. Furthermore, it's noteworthy that the target supports three possible values: browser, bun, and node, providing flexibility in defining the build target according to specific project requirements.

---

📌 Similar

You can also check out my other starter projects:

• 🚀 node-boilerplate
• 🚀 react-boilerplate
• 🚀 next-boilerplate
• 🚀 qwik-boilerplate
• 🚀 vscode-boilerplate
• 🚀 cli-boilerplate