# AGENTS.md

</> htmx - high power tools for HTML

## Setup

```
npm ci
```

## Commands

```
npm run test             # run the test suite, must pass before any commit
npm run lint             # lint
npm run format           # format
npm run dist
npm run types-check
npm run types-generate
npm run test:debug
npm run test:chrome
```

## Layout

- `www/`     62 source files
- `test/`    54 source files
- `dist/`    28 source files
- `scripts/` 4 source files
- `src/`     3 source files

## Conventions

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

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `www/static/node_modules/sinon/pkg/sinon.js` is 2578KB. 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.