47 Commits

Author SHA1 Message Date
Eric
dae19ed2dc chore(release): v0.1.0
Some checks failed
Copilot Setup Steps / copilot-setup-steps (push) Failing after 39s
2026-03-06 20:02:35 +01:00
Eric
e84bd920be feat: bun_script 2026-03-06 19:51:52 +01:00
Eric
7569ca914c chore: script 2026-03-04 20:32:02 +01:00
Eric
cac266ee25 chore(release): v0.0.8 2026-03-04 20:32:02 +01:00
Eric
bf87497c27 fix: .env is located next to package.json 2026-03-04 20:32:01 +01:00
Eric
0872bf7b20 chore(release): v0.0.7 2026-03-04 20:32:01 +01:00
Eric
075a1159cf feat: add docs 2026-03-04 20:32:01 +01:00
Eric
d5b3f5c5ac feat: add option for process cwd (.env support) 2026-03-04 20:32:01 +01:00
Eric
63839fce52 chore(release): v0.0.6 2026-03-04 20:32:01 +01:00
Eric
ab6ee39f62 feat: bun dev target support 2026-03-04 20:32:01 +01:00
Eric
22220b6408 chore(release): v0.0.5 2026-03-04 20:32:01 +01:00
Eric
90be857640 docs: update readme on release 2026-03-04 20:32:01 +01:00
Eric
6b1a2ce1c0 chore(release): v0.0.4 2026-03-04 20:32:00 +01:00
Eric
092aa0cc14 docs: readme instructions 2026-03-04 20:32:00 +01:00
Eric
5dda02dba3 chore(release): v0.0.3 2026-03-04 20:32:00 +01:00
Eric
9116913740 feat: release script 2026-03-04 20:32:00 +01:00
Eric
07210d89d2 test: add bun workspace tests 2026-03-04 20:32:00 +01:00
Eric
799fe61c56 test: add workspace monorepo bun install test 2026-03-04 20:32:00 +01:00
Eric
ce9fff76a3 fix: bazel is green 2026-03-04 20:32:00 +01:00
Eric
45e8f75ca5 feat: cache nix packages in ci 2026-03-04 20:31:59 +01:00
Eric
c00d949936 chore(release): v0.0.2 2026-03-04 20:31:59 +01:00
Eric
c25535b59b chore: update flake 2026-03-04 20:31:59 +01:00
Eric
96d0c2e79d fix: all tests 2026-03-04 20:31:59 +01:00
Eric
56fbea32d8 test: refine new shape test assertions 2026-03-04 20:31:59 +01:00
Eric
c823d3ec19 test: add missing implementation-plan test targets 2026-03-04 20:31:59 +01:00
Eric
f5d42b24db docs: define missing tests 2026-03-04 20:31:59 +01:00
Eric
3bf65e9fc6 fix: harden phase 8 CI workflow and checks 2026-03-04 20:31:59 +01:00
Eric
ed3b159dc2 feat: add phase 8 ci matrix workflow 2026-03-04 20:31:59 +01:00
Eric
5302f573fb fix: tests 2026-03-04 20:31:59 +01:00
Eric
db16748cd1 chore: address phase 7 review feedback 2026-03-04 20:31:58 +01:00
Eric
bdc5e6d976 feat: add phase 7 bun_install module extension 2026-03-04 20:31:58 +01:00
Eric
972a7b238d chore: update flake 2026-03-04 20:31:58 +01:00
Eric
d1b209eb0e fix: tests 2026-03-04 20:31:58 +01:00
Eric
604dc41a95 feat: add phase 6 js_library and ts_library bootstrap 2026-03-04 20:31:58 +01:00
Eric
7b549e9b4f feat: update nix flake 2026-03-04 20:31:58 +01:00
Eric
b33a395c44 fix: use correct bazel 9.0.0 imports 2026-03-04 20:31:58 +01:00
Eric
7d4b9abdd9 feat: implement phase 5 bun_bundle bootstrap 2026-03-04 20:31:58 +01:00
Eric
861a677582 fix: harden bun_test launcher args and test metadata 2026-03-04 20:31:57 +01:00
Eric
42469425e1 feat: add phase 4 bun_test bootstrap 2026-03-04 20:31:57 +01:00
Eric
5044478363 test: simplify bun_binary test targets 2026-03-04 20:31:57 +01:00
Eric
324ca9395b feat: add phase 3 bun_binary bootstrap and tests 2026-03-04 20:31:57 +01:00
Eric
bd6bebd562 docs: add bun_install parameter docs 2026-03-04 20:31:57 +01:00
Eric
e69e2754ca feat: add phase 2 bun_install repository rule bootstrap 2026-03-04 20:31:57 +01:00
Eric
fbfdef222d docs: add plan to repo 2026-03-04 20:31:57 +01:00
Eric
5220c76290 chore: centralize bun version and release URL constants 2026-03-04 20:31:57 +01:00
Eric
ebce24804c feat: bootstrap bun toolchain skeleton and smoke test 2026-03-04 20:31:56 +01:00
Eric
b66339a33b Initial plan 2026-03-04 20:31:36 +01:00
47 changed files with 3196 additions and 75 deletions

19
.direnv/bin/nix-direnv-reload Executable file
View File

@@ -0,0 +1,19 @@
#!/usr/bin/env bash
set -e
if [[ ! -d "/Users/eric/Projects/rules_bun" ]]; then
echo "Cannot find source directory; Did you move it?"
echo "(Looking for "/Users/eric/Projects/rules_bun")"
echo 'Cannot force reload with this script - use "direnv reload" manually and then try again'
exit 1
fi
# rebuild the cache forcefully
_nix_direnv_force_reload=1 direnv exec "/Users/eric/Projects/rules_bun" true
# Update the mtime for .envrc.
# This will cause direnv to reload again - but without re-building.
touch "/Users/eric/Projects/rules_bun/.envrc"
# Also update the timestamp of whatever profile_rc we have.
# This makes sure that we know we are up to date.
touch -r "/Users/eric/Projects/rules_bun/.envrc" "/Users/eric/Projects/rules_bun/.direnv"/*.rc

View File

@@ -0,0 +1 @@
/nix/store/7f0478ddr51i3r708dpkljnvmzwc2fhn-source

View File

@@ -0,0 +1 @@
/nix/store/affmc6lhad8f6q3iaa3iydcdjwr8lwgp-source

View File

@@ -0,0 +1 @@
/nix/store/arl2vkxnjyw2zri2g2v6g4k6x165iidj-source

View File

@@ -0,0 +1 @@
/nix/store/g5v3sgqy6a0fsmas7mnapc196flrplix-source

View File

@@ -0,0 +1 @@
/nix/store/jzfmmjnq1cip816awnliw7ir69pcyg00-source

View File

@@ -0,0 +1 @@
/nix/store/kx00h535s3jzb9803vnylxllij3zhix5-source

View File

@@ -0,0 +1 @@
/nix/store/ngdfag0pfs1h54pbjs9ywah4zhqsphf1-source

View File

@@ -0,0 +1 @@
/nix/store/nk13680f34w3q01a1q69c48my6fi7cxz-source

View File

@@ -0,0 +1 @@
/nix/store/khk85hba90fc8fa8h8b920qqry6nz0qw-nix-shell-env

File diff suppressed because one or more lines are too long

View File

@@ -1,3 +1,6 @@
package(default_visibility = ["//visibility:public"])
exports_files(["ci.yml"])
exports_files([
"ci.yml",
"pages.yml",
])

View File

@@ -5,6 +5,10 @@ on:
branches: ["main"]
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
permissions:
@@ -25,6 +29,12 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: bazel-contrib/setup-bazel@0.15.0
with:
bazelisk-cache: true
repository-cache: true
external-cache: true
disk-cache: ci-${{ matrix.phase8_target }}
cache-save: ${{ github.event_name != 'pull_request' }}
- name: Run tests (${{ matrix.phase8_target }})
run: |
echo "Phase 8 target: ${{ matrix.phase8_target }}"

61
.github/workflows/pages.yml vendored Normal file
View File

@@ -0,0 +1,61 @@
name: Docs Pages
on:
push:
branches: ["main"]
paths:
- "docs/**"
- "bun/**/*.bzl"
- "internal/**/*.bzl"
- ".github/workflows/pages.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
deploy:
runs-on: ubuntu-latest
env:
USE_BAZEL_VERSION: 9.0.0
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- uses: bazel-contrib/setup-bazel@0.15.0
with:
bazelisk-cache: true
repository-cache: true
external-cache: true
disk-cache: docs-pages
- name: Generate rule docs
run: |
bazel build //docs:rules_md
cp bazel-bin/docs/rules.md docs/rules.md
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: docs
destination: _site
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: _site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

1
.pre-commit-config.yaml Symbolic link
View File

@@ -0,0 +1 @@
/nix/store/mgb6bn9dy5bpczkl81jp4r03bplwfd8w-pre-commit-config.json

View File

@@ -1,18 +1,20 @@
module(
name = "rules_bun",
version = "0.0.3",
version = "0.1.0",
)
bazel_dep(name = "platforms", version = "1.0.0")
bazel_dep(name = "rules_shell", version = "0.6.1")
bazel_dep(name = "bazel_skylib", version = "1.8.2")
bazel_dep(name = "stardoc", version = "0.7.2")
bun_ext = use_extension("//bun:extensions.bzl", "bun")
use_repo(
bun_ext,
"bun_linux_x64",
"bun_linux_aarch64",
"bun_darwin_x64",
"bun_darwin_aarch64",
"bun_darwin_x64",
"bun_linux_aarch64",
"bun_linux_x64",
"bun_windows_x64",
)

4
MODULE.bazel.lock generated
View File

@@ -189,8 +189,8 @@
"moduleExtensions": {
"//bun:extensions.bzl%bun": {
"general": {
"bzlTransitiveDigest": "Q0uQOwFAgAU+etePCZ4TUDO+adLX7Z0EmRLaEsKgncw=",
"usagesDigest": "qk1PDh3WICa0VONYKXJLsmWCesNJxz3Jkb/aH/voIeI=",
"bzlTransitiveDigest": "oLR98WtKDCc+zh7Tvu9jtakNg8q/T1IPE38QR1FEQtI=",
"usagesDigest": "NfJgMuTjZXXRLr1/kxxFkS1IKV2UyehFyr3fMvAke/k=",
"recordedInputs": [
"REPO_MAPPING:,bazel_tools bazel_tools"
],

204
README.md
View File

@@ -2,52 +2,190 @@
Bazel rules for bun.
## Current status
## Rule reference
Phase 1 bootstrap is in place:
- Published docs site: https://eriyc.github.io/rules_bun/
- Generated API docs: [docs/rules.md](docs/rules.md)
- Regenerate: `bazel build //docs:rules_md && cp bazel-bin/docs/rules.md docs/rules.md`
- Bun toolchain rule and provider (`/bun/toolchain.bzl`)
- Platform-specific Bun repository downloads (`/bun/repositories.bzl`)
- Toolchain declarations and registration targets (`/bun/BUILD.bazel`)
- Smoke test for `bun --version` (`//tests/toolchain_test:bun_version_test`)
## Use
Phase 2 bootstrap is in place:
These steps show how to consume a tagged release of `rules_bun` in a separate Bazel workspace.
- Repository-rule based `bun_install` (`/internal/bun_install.bzl`)
- Public export via `bun/defs.bzl`
- Focused install behavior tests (`//tests/install_test:all`)
### 1) Add the module dependency
Phase 3 bootstrap is in place:
In your project's `MODULE.bazel`, add:
- Executable `bun_binary` rule (`/internal/bun_binary.bzl`)
- Public export via `bun/defs.bzl`
- Focused JS/TS runnable tests (`//tests/binary_test:all`)
```starlark
bazel_dep(name = "rules_bun", version = "0.1.0")
Phase 4 bootstrap is in place:
archive_override(
module_name = "rules_bun",
urls = ["https://github.com/Eriyc/rules_bun/archiv0.0.5.tar.gz"],
strip_prefix = "rules_bun-v0.1.0",
)
```
- Test rule `bun_test` (`/internal/bun_test.bzl`)
- Public export via `bun/defs.bzl`
- Focused passing/failing test targets (`//tests/bun_test_test:all`)
For channel/pre-release tags (for example `v0.1.0-rc.1`), use the matching folder prefix:
Phase 5 bootstrap is in place:
```starlark
bazel_dep(name = "rules_bun", version = "0.1.0-rc.1")
- Bundle rule `bun_bundle` (`/internal/bun_bundle.bzl`)
- Public export via `bun/defs.bzl`
- Focused output/minify tests (`//tests/bundle_test:all`)
archive_override(
module_name = "rules_bun",
urls = ["https://github.com/Eriyc/rules_bun/archiv0.0.5-rc.1.tar.gz"],
strip_prefix = "rules_bun-v0.1.0-rc.1",
)
```
Phase 6 bootstrap is in place:
Note: keep the `v` prefix in the Git tag URL and `strip_prefix`; for `bazel_dep(..., version = ...)`, use the module version string without the leading `v`.
- Source grouping rules `js_library` / `ts_library` (`/internal/js_library.bzl`)
- Transitive `deps` propagation wired into `bun_bundle` and `bun_test`
- Focused dependency-propagation tests (`//tests/library_test:all`)
### 2) Create Bun repositories with the extension
Phase 7 bootstrap is in place:
Still in `MODULE.bazel`, add:
- Bzlmod `bun_install` module extension (`/bun/extensions.bzl`) using Bazel 9-compatible extension/tag syntax
- Focused module-extension shape test (`//tests/install_extension_test:all`)
```starlark
bun_ext = use_extension("@rules_bun//bun:extensions.bzl", "bun")
Phase 8 bootstrap is in place:
use_repo(
bun_ext,
"bun_linux_x64",
"bun_linux_aarch64",
"bun_darwin_x64",
"bun_darwin_aarch64",
"bun_windows_x64",
)
```
- CI matrix workflow for linux-x64, darwin-arm64, and windows (`/.github/workflows/ci.yml`)
- Bazel 9 pin in CI via `USE_BAZEL_VERSION=9.0.0`
- Focused CI matrix shape test (`//tests/ci_test:all`)
### 3) Register toolchains
Also in `MODULE.bazel`, register:
```starlark
register_toolchains(
"@rules_bun//bun:darwin_aarch64_toolchain",
"@rules_bun//bun:darwin_x64_toolchain",
"@rules_bun//bun:linux_aarch64_toolchain",
"@rules_bun//bun:linux_x64_toolchain",
"@rules_bun//bun:windows_x64_toolchain",
)
```
### 4) Load rules in `BUILD.bazel`
```starlark
load(
"@rules_bun//bun:defs.bzl",
"bun_binary",
"bun_bundle",
"bun_dev",
"bun_script",
"bun_test",
"js_library",
"ts_library",
)
```
### 5) (Optional) Use `bun_install` module extension
If you want Bazel-managed install repositories, add:
```starlark
bun_install_ext = use_extension("@rules_bun//bun:extensions.bzl", "bun_install")
bun_install_ext.install(
name = "npm",
package_json = "//:package.json",
bun_lockfile = "//:bun.lock",
)
use_repo(bun_install_ext, "npm")
```
### 6) Verify setup
Run one of your bun-backed targets, for example:
```bash
bazel test //path/to:your_bun_test
```
All `rules_bun` rule-driven Bun invocations pass `--bun`.
## Package scripts (`bun_script`)
Use `bun_script` to expose a `package.json` script as a Bazel executable target.
```starlark
load("@rules_bun//bun:defs.bzl", "bun_script")
bun_script(
name = "web_dev",
script = "dev",
package_json = "package.json",
node_modules = "@npm//:node_modules",
data = glob([
"src/**",
"static/**",
"vite.config.*",
"svelte.config.*",
"tsconfig*.json",
]),
)
```
Run it with:
```bash
bazel run //path/to:web_dev -- --host
```
`bun_script` defaults to running from the directory containing `package.json`, which matches the usual expectations for `vite`, `svelte-kit`, and similar package scripts.
## Development mode (`bun_dev`)
Use `bun_dev` for long-running local development with Bun watch mode.
```starlark
load("@rules_bun//bun:defs.bzl", "bun_dev")
bun_dev(
name = "web_dev",
entry_point = "src/main.ts",
# Optional: run from the entry point directory so Bun auto-loads colocated .env files.
# working_dir = "entry_point",
)
```
Run it with:
```bash
bazel run //path/to:web_dev
```
`bun_dev` supports:
- `watch_mode = "watch"` (default) for `bun --watch`
- `watch_mode = "hot"` for `bun --hot`
- `restart_on = [...]` to force full process restarts when specific files change
- `working_dir = "workspace" | "entry_point"` (default: `workspace`)
## Runtime working directory (`bun_binary`, `bun_dev`)
`bun_binary` and `bun_dev` support `working_dir`:
- `"workspace"` (default): runs from the Bazel runfiles workspace root.
- `"entry_point"`: runs from the nearest ancestor of the entry point that contains `.env` or `package.json` (falls back to the entry point directory).
Use `"entry_point"` when Bun should resolve local files such as colocated `.env` files relative to the program directory.
### Hybrid Go + Bun + protobuf workflow
For monorepos that mix Go and Bun (including FFI):
1. Run Bun app with native watch/HMR via `bun_dev`.
2. Put generated artifacts or bridge files in `restart_on` (for example generated JS/TS files from proto/go steps).
3. Rebuild Go/proto artifacts separately (for example with `ibazel build`) so their output files change.
4. `bun_dev` detects those `restart_on` changes and restarts Bun, while ordinary JS edits continue to use Bun watch/HMR without full Bazel restarts.
This keeps the fast Bun JS loop while still supporting full restarts when non-JS dependencies change.

View File

@@ -1,3 +1,3 @@
0.0.3
0.1.0
stable
0

View File

@@ -1,3 +1,4 @@
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load(":toolchain.bzl", "bun_toolchain")
load(":version.bzl", "BUN_VERSION")
@@ -6,6 +7,27 @@ exports_files([
"extensions.bzl",
])
bzl_library(
name = "toolchain_bzl",
srcs = ["toolchain.bzl"],
visibility = ["//visibility:public"],
)
bzl_library(
name = "defs_bzl",
srcs = ["defs.bzl"],
visibility = ["//visibility:public"],
deps = [
":toolchain_bzl",
"//internal:bun_binary_bzl",
"//internal:bun_bundle_bzl",
"//internal:bun_dev_bzl",
"//internal:bun_script_bzl",
"//internal:bun_test_bzl",
"//internal:js_library_bzl",
],
)
toolchain_type(name = "toolchain_type")
bun_toolchain(

View File

@@ -1,5 +1,8 @@
"""Public API surface for Bun Bazel rules."""
load("//internal:bun_binary.bzl", _bun_binary = "bun_binary")
load("//internal:bun_bundle.bzl", _bun_bundle = "bun_bundle")
load("//internal:bun_dev.bzl", _bun_dev = "bun_dev")
load("//internal:bun_script.bzl", _bun_script = "bun_script")
load("//internal:bun_test.bzl", _bun_test = "bun_test")
load("//internal:js_library.bzl", _js_library = "js_library", _ts_library = "ts_library")
load(":toolchain.bzl", _BunToolchainInfo = "BunToolchainInfo", _bun_toolchain = "bun_toolchain")
@@ -8,8 +11,11 @@ visibility("public")
bun_binary = _bun_binary
bun_bundle = _bun_bundle
bun_dev = _bun_dev
bun_script = _bun_script
bun_test = _bun_test
js_library = _js_library
ts_library = _ts_library
BunToolchainInfo = _BunToolchainInfo
bun_toolchain = _bun_toolchain

19
docs/BUILD.bazel Normal file
View File

@@ -0,0 +1,19 @@
load("@stardoc//stardoc:stardoc.bzl", "stardoc")
package(default_visibility = ["//visibility:public"])
stardoc(
name = "rules_md",
out = "rules.md",
input = "//bun:defs.bzl",
symbol_names = [
"bun_binary",
"bun_bundle",
"bun_dev",
"bun_script",
"bun_test",
"js_library",
"ts_library",
],
deps = ["//bun:defs_bzl"],
)

16
docs/index.md Normal file
View File

@@ -0,0 +1,16 @@
# rules_bun docs
Documentation site for `rules_bun`.
## Rule reference
- [rules.md](rules.md)
## Regeneration
The rule reference is generated from Starlark rule docstrings:
```bash
bazel build //docs:rules_md
cp bazel-bin/docs/rules.md docs/rules.md
```

84
docs/rules.md Normal file
View File

@@ -0,0 +1,84 @@
# rules_bun rule reference
This file documents the public rules exported from `@rules_bun//bun:defs.bzl`.
## bun_binary
Runs a JS/TS entry point with Bun as an executable target (`bazel run`).
Attributes:
- `entry_point` (label, required): path to the main JS/TS file to execute.
- `node_modules` (label, optional): Bun/npm package files in runfiles.
- `data` (label_list, optional): additional runtime files.
- `working_dir` (string, default: `"workspace"`, values: `"workspace" | "entry_point"`): runtime working directory.
## bun_dev
Runs a JS/TS entry point in Bun development watch mode (`bazel run`).
Attributes:
- `entry_point` (label, required): path to the main JS/TS file.
- `watch_mode` (string, default: `"watch"`, values: `"watch" | "hot"`): Bun live-reload mode.
- `restart_on` (label_list, optional): files that trigger full process restart when changed.
- `node_modules` (label, optional): Bun/npm package files in runfiles.
- `data` (label_list, optional): additional runtime files for dev process.
- `working_dir` (string, default: `"workspace"`, values: `"workspace" | "entry_point"`): runtime working directory.
## bun_script
Runs a named `package.json` script with Bun as an executable target (`bazel run`).
Attributes:
- `script` (string, required): package script name passed to `bun run <script>`.
- `package_json` (label, required): `package.json` file containing the named script.
- `node_modules` (label, optional): Bun/npm package files in runfiles.
- `data` (label_list, optional): additional runtime files for the script.
- `working_dir` (string, default: `"package"`, values: `"workspace" | "package"`): runtime working directory.
## bun_bundle
Bundles one or more JS/TS entry points with Bun build.
Attributes:
- `entry_points` (label_list, required): entry files to bundle.
- `node_modules` (label, optional): Bun/npm package files for resolution.
- `deps` (label_list, optional): source/library dependencies for transitive inputs.
- `data` (label_list, optional): additional non-source files needed during bundling.
- `target` (string, default: `"browser"`, values: `"browser" | "node" | "bun"`): Bun build target.
- `format` (string, default: `"esm"`, values: `"esm" | "cjs" | "iife"`): module format.
- `minify` (bool, default: `False`): minifies bundle output.
- `sourcemap` (bool, default: `False`): emits source maps.
- `external` (string_list, optional): package names treated as external (not bundled).
## bun_test
Runs Bun tests as a Bazel test target (`bazel test`).
Attributes:
- `srcs` (label_list, required): test source files passed to `bun test`.
- `node_modules` (label, optional): Bun/npm package files in runfiles.
- `deps` (label_list, optional): library dependencies required by tests.
- `data` (label_list, optional): additional runtime files needed by tests.
## js_library
Aggregates JavaScript sources and transitive Bun source dependencies.
Attributes:
- `srcs` (label_list, optional): `.js`, `.jsx`, `.mjs`, `.cjs` files.
- `deps` (label_list, optional): dependent source libraries.
## ts_library
Aggregates TypeScript sources and transitive Bun source dependencies.
Attributes:
- `srcs` (label_list, optional): `.ts`, `.tsx` files.
- `deps` (label_list, optional): dependent source libraries.

View File

@@ -1,5 +1,13 @@
load("//bun:defs.bzl", "bun_dev")
package(default_visibility = ["//visibility:public"])
exports_files([
"README.md",
"main.ts",
])
bun_dev(
name = "web_dev",
entry_point = "main.ts",
)

View File

@@ -1,3 +1,11 @@
# basic example
Placeholder for end-to-end bun rules example.
Minimal `bun_dev` example.
Run:
```bash
bazel run //examples/basic:web_dev
```
This starts Bun in watch mode for `main.ts`.

1
examples/basic/main.ts Normal file
View File

@@ -0,0 +1 @@
console.log("rules_bun bun_dev example");

View File

@@ -136,6 +136,36 @@
sed -E -i 's#^([[:space:]]*version[[:space:]]*=[[:space:]]*")[^"]*(",)$#\1'"$FULL_VERSION"'\2#' "$ROOT_DIR/MODULE.bazel"
'';
}
{
run = ''
README="$ROOT_DIR/README.md"
TMP="$README.tmp"
awk -v stable="$BASE_VERSION" -v prerelease="$BASE_VERSION-rc.1" '
{
line = $0
if (line ~ /bazel_dep\(name = "rules_bun", version = "/ && line !~ /-rc\.1/) {
sub(/version = "[^"]+"/, "version = \"" stable "\"", line)
} else if (line ~ /bazel_dep\(name = "rules_bun", version = "/ && line ~ /-rc\.1/) {
sub(/version = "[^"]+"/, "version = \"" prerelease "\"", line)
} else if (line ~ /archive\/refs\/tags\/v/ && line !~ /-rc\.1/) {
sub(/v[^"]+\.tar\.gz/, "v" stable ".tar.gz", line)
} else if (line ~ /archive\/refs\/tags\/v/ && line ~ /-rc\.1/) {
sub(/v[^"]+\.tar\.gz/, "v" prerelease ".tar.gz", line)
} else if (line ~ /strip_prefix = "rules_bun-v/ && line !~ /-rc\.1/) {
sub(/rules_bun-v[^"]+/, "rules_bun-v" stable, line)
} else if (line ~ /strip_prefix = "rules_bun-v/ && line ~ /-rc\.1/) {
sub(/rules_bun-v[^"]+/, "rules_bun-v" prerelease, line)
} else if (line ~ /For channel\/pre-release tags \(for example `v.*-rc\.1`\), use the matching folder prefix:/) {
sub(/`v[^`]+`/, "`v" prerelease "`", line)
}
print line
}
' "$README" > "$TMP" && mv "$TMP" "$README"
'';
}
];
postVersion = ''

View File

@@ -1,9 +1,45 @@
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
package(default_visibility = ["//visibility:public"])
exports_files([
"bun_binary.bzl",
"bun_bundle.bzl",
"bun_dev.bzl",
"bun_install.bzl",
"bun_script.bzl",
"bun_test.bzl",
"js_library.bzl",
])
bzl_library(
name = "bun_binary_bzl",
srcs = ["bun_binary.bzl"],
)
bzl_library(
name = "bun_bundle_bzl",
srcs = ["bun_bundle.bzl"],
deps = [":js_library_bzl"],
)
bzl_library(
name = "bun_dev_bzl",
srcs = ["bun_dev.bzl"],
)
bzl_library(
name = "bun_script_bzl",
srcs = ["bun_script.bzl"],
)
bzl_library(
name = "bun_test_bzl",
srcs = ["bun_test.bzl"],
deps = [":js_library_bzl"],
)
bzl_library(
name = "js_library_bzl",
srcs = ["js_library.bzl"],
)

View File

@@ -14,13 +14,38 @@ def _bun_binary_impl(ctx):
set -euo pipefail
runfiles_dir="${{RUNFILES_DIR:-$0.runfiles}}"
workspace_root="${{runfiles_dir}}/_main"
bun_bin="${{runfiles_dir}}/_main/{bun_short_path}"
entry_point="${{runfiles_dir}}/_main/{entry_short_path}"
exec "${{bun_bin}}" run "${{entry_point}}" "$@"
resolve_entrypoint_workdir() {{
local dir
dir="$(dirname "${{entry_point}}")"
while [[ "${{dir}}" == "${{workspace_root}}"* ]]; do
if [[ -f "${{dir}}/.env" || -f "${{dir}}/package.json" ]]; then
echo "${{dir}}"
return 0
fi
if [[ "${{dir}}" == "${{workspace_root}}" ]]; then
break
fi
dir="$(dirname "${{dir}}")"
done
echo "$(dirname "${{entry_point}}")"
}}
working_dir="{working_dir}"
if [[ "${{working_dir}}" == "entry_point" ]]; then
cd "$(resolve_entrypoint_workdir)"
else
cd "${{workspace_root}}"
fi
exec "${{bun_bin}}" --bun run "${{entry_point}}" "$@"
""".format(
bun_short_path = bun_bin.short_path,
entry_short_path = entry_point.short_path,
working_dir = ctx.attr.working_dir,
),
)
@@ -43,13 +68,28 @@ exec "${{bun_bin}}" run "${{entry_point}}" "$@"
bun_binary = rule(
implementation = _bun_binary_impl,
doc = """Runs a JS/TS entry point with Bun as an executable target.
Use this rule for non-test scripts and CLIs that should run via `bazel run`.
""",
attrs = {
"entry_point": attr.label(
mandatory = True,
allow_single_file = [".js", ".ts", ".jsx", ".tsx", ".mjs", ".cjs"],
doc = "Path to the main JS/TS file to execute.",
),
"node_modules": attr.label(
doc = "Optional label providing Bun/npm package files in runfiles.",
),
"data": attr.label_list(
allow_files = True,
doc = "Additional runtime files required by the program.",
),
"working_dir": attr.string(
default = "workspace",
values = ["workspace", "entry_point"],
doc = "Working directory at runtime: `workspace` root or nearest `entry_point` ancestor containing `.env`/`package.json`.",
),
"node_modules": attr.label(),
"data": attr.label_list(allow_files = True),
},
executable = True,
toolchains = ["//bun:toolchain_type"],

View File

@@ -27,6 +27,7 @@ def _bun_bundle_impl(ctx):
outputs.append(output)
args = ctx.actions.args()
args.add("--bun")
args.add("build")
args.add(entry.path)
args.add("--outfile")
@@ -60,25 +61,47 @@ def _bun_bundle_impl(ctx):
bun_bundle = rule(
implementation = _bun_bundle_impl,
doc = """Bundles one or more JS/TS entry points using Bun build.
Each entry point produces one output JavaScript artifact.
""",
attrs = {
"entry_points": attr.label_list(
mandatory = True,
allow_files = [".js", ".ts", ".jsx", ".tsx", ".mjs", ".cjs"],
doc = "Entry files to bundle.",
),
"node_modules": attr.label(
doc = "Optional label providing Bun/npm package files for resolution.",
),
"deps": attr.label_list(
doc = "Source/library dependencies that provide transitive inputs.",
),
"data": attr.label_list(
allow_files = True,
doc = "Additional non-source files needed during bundling.",
),
"node_modules": attr.label(),
"deps": attr.label_list(),
"data": attr.label_list(allow_files = True),
"target": attr.string(
default = "browser",
values = ["browser", "node", "bun"],
doc = "Bun build target environment.",
),
"format": attr.string(
default = "esm",
values = ["esm", "cjs", "iife"],
doc = "Output module format.",
),
"minify": attr.bool(
default = False,
doc = "If true, minifies bundle output.",
),
"sourcemap": attr.bool(
default = False,
doc = "If true, emits source maps.",
),
"external": attr.string_list(
doc = "Package names to treat as externals (not bundled).",
),
"minify": attr.bool(default = False),
"sourcemap": attr.bool(default = False),
"external": attr.string_list(),
},
toolchains = ["//bun:toolchain_type"],
)

186
internal/bun_dev.bzl Normal file
View File

@@ -0,0 +1,186 @@
"""Rule for running JS/TS scripts with Bun in watch mode for development."""
def _bun_dev_impl(ctx):
toolchain = ctx.toolchains["//bun:toolchain_type"]
bun_bin = toolchain.bun.bun_bin
entry_point = ctx.file.entry_point
restart_watch_paths = "\n".join([path.short_path for path in ctx.files.restart_on])
launcher = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = launcher,
is_executable = True,
content = """#!/usr/bin/env bash
set -euo pipefail
runfiles_dir="${{RUNFILES_DIR:-$0.runfiles}}"
workspace_root="${{runfiles_dir}}/_main"
bun_bin="${{runfiles_dir}}/_main/{bun_short_path}"
entry_point="${{runfiles_dir}}/_main/{entry_short_path}"
resolve_entrypoint_workdir() {{
local dir
dir="$(dirname "${{entry_point}}")"
while [[ "${{dir}}" == "${{workspace_root}}"* ]]; do
if [[ -f "${{dir}}/.env" || -f "${{dir}}/package.json" ]]; then
echo "${{dir}}"
return 0
fi
if [[ "${{dir}}" == "${{workspace_root}}" ]]; then
break
fi
dir="$(dirname "${{dir}}")"
done
echo "$(dirname "${{entry_point}}")"
}}
working_dir="{working_dir}"
if [[ "${{working_dir}}" == "entry_point" ]]; then
cd "$(resolve_entrypoint_workdir)"
else
cd "${{workspace_root}}"
fi
watch_mode="{watch_mode}"
if [[ "${{watch_mode}}" == "hot" ]]; then
dev_flag="--hot"
else
dev_flag="--watch"
fi
run_dev() {{
exec "${{bun_bin}}" --bun "${{dev_flag}}" run "${{entry_point}}" "$@"
}}
if [[ {restart_count} -eq 0 ]]; then
run_dev "$@"
fi
readarray -t restart_paths <<'EOF_RESTART_PATHS'
{restart_watch_paths}
EOF_RESTART_PATHS
file_mtime() {{
local p="$1"
if stat -f '%m' "${{p}}" >/dev/null 2>&1; then
stat -f '%m' "${{p}}"
return 0
fi
stat -c '%Y' "${{p}}"
}}
declare -A mtimes
for rel in "${{restart_paths[@]}}"; do
path="${{runfiles_dir}}/_main/${{rel}}"
if [[ -e "${{path}}" ]]; then
mtimes["${{rel}}"]="$(file_mtime "${{path}}")"
else
mtimes["${{rel}}"]="missing"
fi
done
child_pid=""
restart_child() {{
if [[ -n "${{child_pid}}" ]] && kill -0 "${{child_pid}}" 2>/dev/null; then
kill "${{child_pid}}"
wait "${{child_pid}}" || true
fi
"${{bun_bin}}" --bun "${{dev_flag}}" run "${{entry_point}}" "$@" &
child_pid=$!
}}
cleanup() {{
if [[ -n "${{child_pid}}" ]] && kill -0 "${{child_pid}}" 2>/dev/null; then
kill "${{child_pid}}"
wait "${{child_pid}}" || true
fi
}}
trap cleanup EXIT INT TERM
restart_child "$@"
while true; do
sleep 1
changed=0
for rel in "${{restart_paths[@]}}"; do
path="${{runfiles_dir}}/_main/${{rel}}"
if [[ -e "${{path}}" ]]; then
current="$(file_mtime "${{path}}")"
else
current="missing"
fi
if [[ "${{current}}" != "${{mtimes[${{rel}}]}}" ]]; then
mtimes["${{rel}}"]="${{current}}"
changed=1
fi
done
if [[ "${{changed}}" -eq 1 ]]; then
restart_child "$@"
fi
done
""".format(
bun_short_path = bun_bin.short_path,
entry_short_path = entry_point.short_path,
watch_mode = ctx.attr.watch_mode,
working_dir = ctx.attr.working_dir,
restart_count = len(ctx.files.restart_on),
restart_watch_paths = restart_watch_paths,
),
)
transitive_files = []
if ctx.attr.node_modules:
transitive_files.append(ctx.attr.node_modules[DefaultInfo].files)
runfiles = ctx.runfiles(
files = [bun_bin, entry_point] + ctx.files.data + ctx.files.restart_on,
transitive_files = depset(transitive = transitive_files),
)
return [
DefaultInfo(
executable = launcher,
runfiles = runfiles,
),
]
bun_dev = rule(
implementation = _bun_dev_impl,
doc = """Runs a JS/TS entry point in Bun development watch mode.
This rule is intended for local dev loops (`bazel run`) and supports Bun
watch/HMR plus optional full restarts on selected file changes.
""",
attrs = {
"entry_point": attr.label(
mandatory = True,
allow_single_file = [".js", ".ts", ".jsx", ".tsx", ".mjs", ".cjs"],
doc = "Path to the main JS/TS file to execute in dev mode.",
),
"watch_mode": attr.string(
default = "watch",
values = ["watch", "hot"],
doc = "Bun live-reload mode: `watch` (default) or `hot`.",
),
"restart_on": attr.label_list(
allow_files = True,
doc = "Files that trigger a full Bun process restart when they change.",
),
"node_modules": attr.label(
doc = "Optional label providing Bun/npm package files in runfiles.",
),
"data": attr.label_list(
allow_files = True,
doc = "Additional runtime files required by the dev process.",
),
"working_dir": attr.string(
default = "workspace",
values = ["workspace", "entry_point"],
doc = "Working directory at runtime: `workspace` root or nearest `entry_point` ancestor containing `.env`/`package.json`.",
),
},
executable = True,
toolchains = ["//bun:toolchain_type"],
)

View File

@@ -19,7 +19,6 @@ def _select_bun_binary(repository_ctx):
fail("Unsupported host platform: os={}, arch={}".format(repository_ctx.os.name, repository_ctx.os.arch))
def _bun_install_repository_impl(repository_ctx):
package_json = repository_ctx.path(repository_ctx.attr.package_json)
bun_lockfile = repository_ctx.path(repository_ctx.attr.bun_lockfile)
@@ -36,14 +35,14 @@ def _bun_install_repository_impl(repository_ctx):
repository_ctx.symlink(bun_lockfile, "bun.lockb")
result = repository_ctx.execute(
[str(bun_bin), "install", "--frozen-lockfile", "--no-progress"],
[str(bun_bin), "--bun", "install", "--frozen-lockfile", "--no-progress"],
timeout = 600,
quiet = False,
environment = {"HOME": str(repository_ctx.path("."))},
)
if result.return_code:
fail("""bun_install failed running `bun install --frozen-lockfile`.
fail("""bun_install failed running `bun --bun install --frozen-lockfile`.
stdout:
{}
stderr:
@@ -60,7 +59,6 @@ stderr:
""",
)
bun_install_repository = repository_rule(
implementation = _bun_install_repository_impl,
attrs = {
@@ -74,9 +72,6 @@ bun_install_repository = repository_rule(
},
)
_bun_install_repository = bun_install_repository
def bun_install(name, package_json, bun_lockfile):
"""Create an external repository containing installed node_modules.

91
internal/bun_script.bzl Normal file
View File

@@ -0,0 +1,91 @@
"""Rule for running package.json scripts with Bun."""
def _shell_quote(value):
return "'" + value.replace("'", "'\"'\"'") + "'"
def _bun_script_impl(ctx):
toolchain = ctx.toolchains["//bun:toolchain_type"]
bun_bin = toolchain.bun.bun_bin
package_json = ctx.file.package_json
launcher = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = launcher,
is_executable = True,
content = """#!/usr/bin/env bash
set -euo pipefail
runfiles_dir="${{RUNFILES_DIR:-$0.runfiles}}"
workspace_root="${{runfiles_dir}}/_main"
bun_bin="${{runfiles_dir}}/_main/{bun_short_path}"
package_json="${{runfiles_dir}}/_main/{package_json_short_path}"
package_dir="$(dirname "${{package_json}}")"
working_dir="{working_dir}"
if [[ "${{working_dir}}" == "package" ]]; then
cd "${{package_dir}}"
else
cd "${{workspace_root}}"
fi
exec "${{bun_bin}}" --bun run {script} "$@"
""".format(
bun_short_path = bun_bin.short_path,
package_json_short_path = package_json.short_path,
working_dir = ctx.attr.working_dir,
script = _shell_quote(ctx.attr.script),
),
)
transitive_files = []
if ctx.attr.node_modules:
transitive_files.append(ctx.attr.node_modules[DefaultInfo].files)
runfiles = ctx.runfiles(
files = [bun_bin, package_json] + ctx.files.data,
transitive_files = depset(transitive = transitive_files),
)
return [
DefaultInfo(
executable = launcher,
runfiles = runfiles,
),
]
bun_script = rule(
implementation = _bun_script_impl,
doc = """Runs a named `package.json` script with Bun as an executable target.
Use this rule to expose existing package scripts such as `dev`, `build`, or
`check` via `bazel run` without adding wrapper shell scripts.
""",
attrs = {
"script": attr.string(
mandatory = True,
doc = "Name of the `package.json` script to execute via `bun run <script>`.",
),
"package_json": attr.label(
mandatory = True,
allow_single_file = True,
doc = "Label of the `package.json` file containing the named script.",
),
"node_modules": attr.label(
doc = "Optional label providing Bun/npm package files in runfiles.",
),
"data": attr.label_list(
allow_files = True,
doc = "Additional runtime files required by the script.",
),
"working_dir": attr.string(
default = "package",
values = ["workspace", "package"],
doc = "Working directory at runtime: Bazel runfiles `workspace` root or the directory containing `package.json`.",
),
},
executable = True,
toolchains = ["//bun:toolchain_type"],
)

View File

@@ -24,15 +24,15 @@ bun_bin="${{runfiles_dir}}/_main/{bun_short_path}"
cd "${{runfiles_dir}}/_main"
if [[ -n "${{TESTBRIDGE_TEST_ONLY:-}}" && -n "${{COVERAGE_DIR:-}}" ]]; then
exec "${{bun_bin}}" test {src_args} --test-name-pattern "${{TESTBRIDGE_TEST_ONLY}}" --coverage "$@"
exec "${{bun_bin}}" --bun test {src_args} --test-name-pattern "${{TESTBRIDGE_TEST_ONLY}}" --coverage "$@"
fi
if [[ -n "${{TESTBRIDGE_TEST_ONLY:-}}" ]]; then
exec "${{bun_bin}}" test {src_args} --test-name-pattern "${{TESTBRIDGE_TEST_ONLY}}" "$@"
exec "${{bun_bin}}" --bun test {src_args} --test-name-pattern "${{TESTBRIDGE_TEST_ONLY}}" "$@"
fi
if [[ -n "${{COVERAGE_DIR:-}}" ]]; then
exec "${{bun_bin}}" test {src_args} --coverage "$@"
exec "${{bun_bin}}" --bun test {src_args} --coverage "$@"
fi
exec "${{bun_bin}}" test {src_args} "$@"
exec "${{bun_bin}}" --bun test {src_args} "$@"
""".format(
bun_short_path = bun_bin.short_path,
src_args = src_args,
@@ -63,14 +63,26 @@ exec "${{bun_bin}}" test {src_args} "$@"
bun_test = rule(
implementation = _bun_test_impl,
doc = """Runs Bun tests as a Bazel test target.
Supports Bazel test filtering (`--test_filter`) and coverage integration.
""",
attrs = {
"srcs": attr.label_list(
mandatory = True,
allow_files = [".js", ".ts", ".jsx", ".tsx", ".mjs", ".cjs"],
doc = "Test source files passed to `bun test`.",
),
"node_modules": attr.label(
doc = "Optional label providing Bun/npm package files in runfiles.",
),
"deps": attr.label_list(
doc = "Library dependencies required by test sources.",
),
"data": attr.label_list(
allow_files = True,
doc = "Additional runtime files needed by tests.",
),
"node_modules": attr.label(),
"deps": attr.label_list(),
"data": attr.label_list(allow_files = True),
},
test = True,
toolchains = ["//bun:toolchain_type"],

View File

@@ -1,7 +1,9 @@
"""Lightweight JS/TS source grouping rules."""
BunSourcesInfo = provider(fields = ["transitive_sources"])
BunSourcesInfo = provider(
"Provides transitive sources for Bun libraries.",
fields = ["transitive_sources"],
)
def _bun_library_impl(ctx):
transitive_sources = [
@@ -18,23 +20,30 @@ def _bun_library_impl(ctx):
DefaultInfo(files = all_sources),
]
js_library = rule(
implementation = _bun_library_impl,
doc = "Aggregates JavaScript sources and transitive Bun source dependencies.",
attrs = {
"srcs": attr.label_list(
allow_files = [".js", ".jsx", ".mjs", ".cjs"],
doc = "JavaScript source files in this library.",
),
"deps": attr.label_list(
doc = "Other Bun source libraries to include transitively.",
),
"deps": attr.label_list(),
},
)
ts_library = rule(
implementation = _bun_library_impl,
doc = "Aggregates TypeScript sources and transitive Bun source dependencies.",
attrs = {
"srcs": attr.label_list(
allow_files = [".ts", ".tsx"],
doc = "TypeScript source files in this library.",
),
"deps": attr.label_list(
doc = "Other Bun source libraries to include transitively.",
),
"deps": attr.label_list(),
},
)

View File

@@ -43,3 +43,31 @@ sh_test(
"//tests/binary_test:BUILD.bazel",
],
)
bun_binary(
name = "env_cwd_bin",
entry_point = "env.ts",
data = [".env"],
working_dir = "entry_point",
)
sh_test(
name = "bun_binary_env_cwd_test",
srcs = ["run_env_binary.sh"],
args = ["$(location :env_cwd_bin)"],
data = [":env_cwd_bin"],
)
bun_binary(
name = "env_parent_cwd_bin",
entry_point = "env_parent/src/main.ts",
data = ["env_parent/.env"],
working_dir = "entry_point",
)
sh_test(
name = "bun_binary_env_parent_cwd_test",
srcs = ["run_parent_env_binary.sh"],
args = ["$(location :env_parent_cwd_bin)"],
data = [":env_parent_cwd_bin"],
)

2
tests/binary_test/env.ts Normal file
View File

@@ -0,0 +1,2 @@
const value = process.env.BUN_ENV_CWD_TEST ?? "missing";
console.log(value);

View File

@@ -0,0 +1,2 @@
const value = process.env.BUN_ENV_PARENT_TEST ?? "missing";
console.log(value);

View File

@@ -0,0 +1,10 @@
#!/usr/bin/env bash
set -euo pipefail
binary="$1"
output="$(${binary})"
if [[ ${output} != "from-dotenv" ]]; then
echo "Expected .env value from entry-point directory, got: ${output}" >&2
exit 1
fi

View File

@@ -0,0 +1,10 @@
#!/usr/bin/env bash
set -euo pipefail
binary="$1"
output="$(${binary})"
if [[ ${output} != "from-parent-dotenv" ]]; then
echo "Expected .env value from parent directory, got: ${output}" >&2
exit 1
fi

View File

@@ -0,0 +1,33 @@
load("//bun:defs.bzl", "bun_script")
load("@rules_shell//shell:sh_test.bzl", "sh_test")
bun_script(
name = "hello_script",
script = "hello",
package_json = "package.json",
data = ["hello.ts"],
)
sh_test(
name = "bun_script_ts_test",
srcs = ["run_script.sh"],
args = ["$(location :hello_script)", "hello-script"],
data = [":hello_script"],
)
bun_script(
name = "env_script",
script = "print-env",
package_json = "package.json",
data = [
".env",
"env.ts",
],
)
sh_test(
name = "bun_script_package_cwd_test",
srcs = ["run_env_script.sh"],
args = ["$(location :env_script)"],
data = [":env_script"],
)

2
tests/script_test/env.ts Normal file
View File

@@ -0,0 +1,2 @@
const value = process.env.BUN_SCRIPT_ENV_TEST ?? "missing";
console.log(value);

View File

@@ -0,0 +1 @@
console.log("hello-script");

View File

@@ -0,0 +1,9 @@
{
"name": "script-test",
"private": true,
"type": "module",
"scripts": {
"hello": "bun ./hello.ts",
"print-env": "bun ./env.ts"
}
}

View File

@@ -0,0 +1,10 @@
#!/usr/bin/env bash
set -euo pipefail
binary="$1"
output="$(${binary})"
if [[ ${output} != "from-dotenv" ]]; then
echo "Expected .env value from package directory, got: ${output}" >&2
exit 1
fi

11
tests/script_test/run_script.sh Executable file
View File

@@ -0,0 +1,11 @@
#!/usr/bin/env bash
set -euo pipefail
binary="$1"
expected="$2"
output="$(${binary})"
if [[ ${output} != "${expected}" ]]; then
echo "Unexpected output from ${binary}: ${output}" >&2
exit 1
fi