# AGENTS.md

ORM

## Setup

```
pnpm install
```

## Commands

```
pnpm build        # produce a build
pnpm test         # run the test suite, must pass before any commit
pnpm lint         # lint
pnpm build:orm
pnpm b
pnpm pack
pnpm t
pnpm test:types
```

## Layout

- `drizzle-orm/`       545 source files
- `drizzle-kit/`       153 source files
- `integration-tests/` 143 source files
- `drizzle-seed/`      63 source files
- `drizzle-arktype/`   18 source files
- `drizzle-typebox/`   17 source files

## Conventions

- Tests live alongside the code they cover, following `drizzle-arktype/tests/mysql.test.ts`.
- 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/codeql.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `drizzle-seed/src/datasets/cityNames.ts` is 594KB. 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.