Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.67 KB

File metadata and controls

37 lines (24 loc) · 1.67 KB

AGENTS.md

@snelusha/balrun runs Ballerina from JavaScript/TypeScript by loading ballerina.wasm, which is built from the ballerina-lang-go submodule.

Repository structure

Workspaces are declared in the root package.json as apps/*, examples/*, and packages/*.

Path Package Role
packages/balrun @snelusha/balrun TypeScript library, React hook, and CLI.
packages/ballerina-wasm ballerina-wasm Builds ballerina.wasm with Go.
examples/memfs example-memfs In-memory filesystem usage example.
examples/vite example-vite Vite + React browser usage example.

packages/ballerina-wasm/ballerina-lang-go is an upstream submodule and has its own AGENTS.md.

Commands

Use Bun for installs and scripts. Do not use npm, pnpm, or yarn.

Useful root scripts:

  • bun install --frozen-lockfile
  • bun run build — Turbo build across workspaces
  • bun run test — Turbo test across workspaces
  • bun run lint / bun run lint:fix — Biome check (and auto-fix)
  • bun run format — Biome format (write)

Conventions

  • Biome is the formatter/linter; keep tab indentation and double quotes.
  • Avoid editing generated dist/ files unless explicitly required.

Task completion

Before considering work complete, bun run lint and bun run test should pass at the repository root.