# AGENTS.md

🤖 Powerful asynchronous state management, server-state utilities and data fetching for the web. TS/JS, React Query, Solid Query, Svelte Query and Vue Query.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
pnpm build         # produce a build
pnpm test          # run the test suite, must pass before any commit
pnpm format        # format
pnpm clean
pnpm test:pr
pnpm test:ci
pnpm test:eslint
```

## Layout

- `packages/`     755 source files
- `examples/`     409 source files
- `integrations/` 55 source files
- `scripts/`      6 source files

## Conventions

- Tests live alongside the code they cover, following `packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.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/autofix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/react-query/src/__tests__/useQuery.test.tsx` is 183KB. 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.