# AGENTS.md

A modern runtime for JavaScript and TypeScript.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `tests/`   4486 source files
- `ext/`     647 source files
- `libs/`    544 source files
- `cli/`     436 source files
- `runtime/` 63 source files
- `tools/`   56 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/ecosystem_compat_test.ts`.
- CI defines what passing means. See `.github/workflows/cargo_publish.generated.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `cli/tsc/00_typescript.js` is 8930KB. 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.