# AGENTS.md

Delightful JavaScript Testing.

## Setup

```
yarn install
```

## Commands

```
yarn build         # produce a build
yarn test          # run the test suite, must pass before any commit
yarn typecheck     # type check without emitting
yarn lint          # lint
yarn build-clean
yarn build:js
yarn build:ts
yarn bundle:ts
```

## Layout

- `e2e/`        1140 source files
- `packages/`   1003 source files
- `examples/`   82 source files
- `scripts/`    15 source files
- `website/`    13 source files
- `benchmarks/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `benchmarks/test-file-overhead/0.test.js`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/check-changelog.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `.yarn/releases/yarn-4.18.0.cjs` is 3696KB. 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.