# AGENTS.md

Node.js JavaScript runtime ✨🐢🚀✨

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make help
make install
make uninstall
make clean
make testclean
make distclean
```

## Layout

- `deps/`      27425 source files
- `test/`      9787 source files
- `benchmark/` 627 source files
- `src/`       475 source files
- `lib/`       429 source files
- `tools/`     279 source files

## Conventions

- Tests live alongside the code they cover, following `.github/ISSUE_TEMPLATE/4-report-a-flaky-test.yml`.
- 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/author-ready-conflicts.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `test/fixtures/snapshot/typescript.js` is 10296KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.