# AGENTS.md

Web framework built on Web Standards

## Setup

```
bun install
```

## Commands

```
bun build         # produce a build
bun test          # run the test suite, must pass before any commit
bun lint          # lint
bun format        # format
bun test:watch
bun test:deno
bun test:bun
bun test:fastly
```

## Layout

- `src/`           311 source files
- `benchmarks/`    21 source files
- `runtime-tests/` 21 source files
- `build/`         5 source files
- `perf-measures/` 4 source files

## Conventions

- Tests live alongside the code they cover, following `build/remove-private-fields.test.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/autofix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `src/types.test.ts` is 125KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.