Bun

Bun

This skill explains how Bun is used throughout the hr-skills monorepo. It covers workspace management, development workflows, validation commands, testing, and repository conventions.

The repository standardizes on Bun for all package management and script execution. Turborepo orchestrates tasks across workspace packages.

Supported tasks

• Explain how Bun is used within this repository
• Install and manage workspace dependencies
• Run repository scripts using Bun
• Validate HR skills and repository metadata
• Synchronize generated repository artifacts
• Build workspace packages
• Run tests and TypeScript type checking
• Troubleshoot Bun workspace issues
• Recommend Bun workflows for local development and CI
• Explain Bun compatibility with Node.js
• Recommend Bun-native APIs when appropriate
• Explain when to use Bun-specific features versus Node.js APIs

Repository usage

This repository uses Bun for:

• package management
• workspace dependency resolution
• script execution
• TypeScript execution
• test execution

Package managers such as npm, pnpm, and Yarn are not supported.

Dependency catalogs

This repository centralizes shared dependency versions using Bun catalogs.

Catalogs ensure that common dependencies are defined once in the root package.json and reused consistently across every workspace package.

Workspace packages should reference shared dependencies using the catalog: protocol instead of repeating version numbers.

Use the default catalog.

{
  "dependencies": {
    "typescript": "catalog:"
  }
}

Use a named catalog.

{
  "devDependencies": {
    "@biomejs/biome": "catalog:biome",
    "@commitlint/cli": "catalog:commit"
  }
}

Benefits:

• keeps dependency versions consistent across the repository
• updates shared dependency versions in one place
• reduces duplicated version declarations
• simplifies workspace maintenance

Internal workspace packages should continue using the workspace:* protocol.

Node.js compatibility

When working in this repository:

• Assume Node.js APIs are supported unless Bun documentation states otherwise.
• If a package works in Node.js but fails in Bun, treat it as a Bun compatibility issue rather than a repository issue.
• Prefer standard node: imports for built-in Node.js modules.
• Prefer Bun-native APIs only when they provide a clear repository benefit.

Workspace packages

The repository currently contains multiple Bun workspace packages.

hr-skills-build

Repository tooling responsible for:

• validating HR skills
• synchronizing repository metadata
• maintaining repository conventions

hr-skills-ref

Reusable library responsible for:

• parsing SKILL.md
• loading skills
• validating metadata
• generating prompts
• exposing reusable APIs for other packages

Common commands

Install dependencies.

bun install

Run validation.

bun run validate

Synchronize generated repository artifacts.

bun run sync

Build every workspace package.

bun run build

Run all test suites.

bun run test

Run TypeScript type checking.

bun run typecheck

Run repository linting and formatting.

bun run check
bun run lint
bun run format
bun run lint:md
bun run lint:md:fix
bun run lint:links

Analyze unused files and dependencies.

bun run knip

Create a release.

bun run release

Key prompts

Compatibility

• "Explain Bun compatibility with Node.js."
• "Does this Node.js package work with Bun?"
• "Explain whether this Node.js API is supported."
• "Recommend the Bun-native alternative."

Repository workflows

• "Explain how Bun is used in this repository."
• "List the common Bun commands used during development."
• "Describe the repository workspace structure."
• "Explain how Turborepo and Bun work together."

Validation

• "Run the repository validation workflow."
• "Explain what bun run validate does."
• "Explain what bun run sync does."
• "Recommend the correct validation order before opening a pull request."

Development

• "Build every workspace package."
• "Run all tests using Bun."
• "Run TypeScript type checking."
• "Explain how to troubleshoot Bun workspace issues."

CI

• "Generate a Bun-based CI workflow."
• "Recommend the fastest validation pipeline."
• "Explain how to use Turborepo caching."
• "Generate GitHub Actions steps for Bun."

CI recommendations

A typical validation workflow is:

bun ci
bun run typecheck
bun run validate
bun run test
bun run build

This order detects type, validation, and test failures before building distributable artifacts.

Examples

Install dependencies.

bun install

Validate the repository.

bun run validate

Synchronize repository metadata.

bun run sync

Build every package.

bun run build

Run all tests.

bun run test

Tips

• Always use Bun for package management and script execution.
• Prefer standard node: imports for built-in modules.
• Use bun:test instead of node:test.
• Prefer Bun-native runtime features only when repository portability is not required.
• Check Bun compatibility documentation before assuming a Node.js feature is unsupported.
• Prefer workspace commands from the repository root.
• Run validation before committing repository changes.
• Keep workspace dependencies synchronized.
• Use workspace:* for internal package dependencies.
• Use Turborepo to execute workspace tasks instead of running packages individually when possible.

Common issues

• Using npm, pnpm, or Yarn instead of Bun.
• Ignoring workspace dependency relationships.
• Assuming unsupported behavior without checking Bun compatibility.
• Using node:test instead of bun:test.
• Depending on Node.js APIs that Bun documents as partially implemented.
• Skipping repository validation before committing.
• Forgetting to synchronize generated repository artifacts.
• Running package scripts from the wrong workspace.
• Missing bun install after dependency changes.
• Hardcoding dependency versions that should come from a shared catalog.
• Using explicit semver instead of catalog: for repository-standard dependencies.
• Updating versions in workspace packages instead of the root catalog.
• Using catalog: for internal workspace packages instead of workspace:*.

Best practices

• Keep Bun updated across development environments.
• Prefer standard node: module specifiers for built-in modules.
• Use bun:test for repository tests.
• Prefer documented Bun APIs over undocumented compatibility workarounds.
• Mention Bun compatibility limitations only when they are relevant to the task.
• Run commands from the repository root unless package-specific behavior is required.
• Validate changes before opening a pull request.
• Use Turborepo to orchestrate workspace tasks.
• Keep internal packages versioned through the workspace.
• Prefer reproducible installations with bun install --frozen-lockfile in CI.
• Use catalog: for shared external dependencies.
• Use named catalogs to group related tooling (for example: biome, commit, markdown).
• Update dependency versions in the root catalog instead of individual workspace packages.
• Use workspace:* only for internal packages.