2 Commits

Author SHA1 Message Date
Eric
fd5b5ea8c0 chore(release): v0.0.4
Some checks failed
Copilot Setup Steps / copilot-setup-steps (push) Failing after 27s
2026-03-04 10:07:37 +01:00
Eric
0115bb3d27 docs: readme instructions 2026-03-04 10:07:28 +01:00
3 changed files with 85 additions and 35 deletions

View File

@@ -1,6 +1,6 @@
module( module(
name = "rules_bun", name = "rules_bun",
version = "0.0.3", version = "0.0.4",
) )
bazel_dep(name = "platforms", version = "1.0.0") bazel_dep(name = "platforms", version = "1.0.0")

116
README.md
View File

@@ -2,52 +2,102 @@
Bazel rules for bun. Bazel rules for bun.
## Current status ## Use
Phase 1 bootstrap is in place: These steps show how to consume a tagged release of `rules_bun` in a separate Bazel workspace.
- Bun toolchain rule and provider (`/bun/toolchain.bzl`) ### 1) Add the module dependency
- 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`)
Phase 2 bootstrap is in place: In your project's `MODULE.bazel`, add:
- Repository-rule based `bun_install` (`/internal/bun_install.bzl`) ```starlark
- Public export via `bun/defs.bzl` bazel_dep(name = "rules_bun", version = "0.0.3")
- Focused install behavior tests (`//tests/install_test:all`)
Phase 3 bootstrap is in place: archive_override(
module_name = "rules_bun",
urls = ["https://github.com/Eriyc/rules_bun/archive/refs/tags/v0.0.3.tar.gz"],
strip_prefix = "rules_bun-v0.0.3",
)
```
- Executable `bun_binary` rule (`/internal/bun_binary.bzl`) For channel/pre-release tags (for example `v0.0.3-rc.1`), use the matching folder prefix:
- Public export via `bun/defs.bzl`
- Focused JS/TS runnable tests (`//tests/binary_test:all`)
Phase 4 bootstrap is in place: ```starlark
bazel_dep(name = "rules_bun", version = "0.0.3-rc.1")
- Test rule `bun_test` (`/internal/bun_test.bzl`) archive_override(
- Public export via `bun/defs.bzl` module_name = "rules_bun",
- Focused passing/failing test targets (`//tests/bun_test_test:all`) urls = ["https://github.com/Eriyc/rules_bun/archive/refs/tags/v0.0.3-rc.1.tar.gz"],
strip_prefix = "rules_bun-v0.0.3-rc.1",
)
```
Phase 5 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`.
- Bundle rule `bun_bundle` (`/internal/bun_bundle.bzl`) ### 2) Create Bun repositories with the extension
- Public export via `bun/defs.bzl`
- Focused output/minify tests (`//tests/bundle_test:all`)
Phase 6 bootstrap is in place: Still in `MODULE.bazel`, add:
- Source grouping rules `js_library` / `ts_library` (`/internal/js_library.bzl`) ```starlark
- Transitive `deps` propagation wired into `bun_bundle` and `bun_test` bun_ext = use_extension("@rules_bun//bun:extensions.bzl", "bun")
- Focused dependency-propagation tests (`//tests/library_test:all`)
Phase 7 bootstrap is in place: use_repo(
bun_ext,
"bun_linux_x64",
"bun_linux_aarch64",
"bun_darwin_x64",
"bun_darwin_aarch64",
"bun_windows_x64",
)
```
- Bzlmod `bun_install` module extension (`/bun/extensions.bzl`) using Bazel 9-compatible extension/tag syntax ### 3) Register toolchains
- Focused module-extension shape test (`//tests/install_extension_test:all`)
Phase 8 bootstrap is in place: Also in `MODULE.bazel`, register:
- CI matrix workflow for linux-x64, darwin-arm64, and windows (`/.github/workflows/ci.yml`) ```starlark
- Bazel 9 pin in CI via `USE_BAZEL_VERSION=9.0.0` register_toolchains(
- Focused CI matrix shape test (`//tests/ci_test:all`) "@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_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
```

View File

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