react-fetch-streams AGENTS.md

AGENTS.md

Guidance for AI coding agents in this repo. Human contributors: see the Contribute section of the README.

This is react-fetch-streams: React hooks for streaming a response body over the Fetch + Streams APIs (useStream, plus useNdjsonStream for newline-delimited JSON) and for Server-Sent Events (useEventSource, useEventStream). It is a small, dependency-free, published npm library written in TypeScript. Keep it that way; think twice before adding a runtime dependency.

The toolchain is the Rust-based oxc stack: oxlint to lint, Prettier to format, tsdown (Rolldown + oxc) to build and emit declarations, and Vitest to test; TypeScript (tsc --noEmit) type-checks. There is no Babel, ESLint, or Rollup; do not reintroduce them.

Workflow

• Clarify the design before implementing. For anything non-trivial, agree on the approach first.
• One unit of change per commit. Never mix unrelated changes. Present the change for review before committing.
• Every change ships with tests. Run local CI before calling it done, and do not claim it passes without running it.
• Verify against the code and the tools: read before you answer, run before you assert.

Local CI (must be green before review):

npm run typecheck     # tsc --noEmit
npm run lint          # oxlint
npm run format:check  # prettier
npm run build         # tsdown
npm run test:cov      # vitest

Writing: code, comments, docs, commits

• Concise and to the point. No fluff. Explain the non-obvious; do not narrate the obvious.
• ASCII only. No em-dash and no --; write -. Use -> not the arrow glyph, != not the not-equal glyph, and so on.
• Comments justify why, not what. Delete any comment that restates the code.
• Formatting is not a matter of taste: Prettier owns it. Run npm run format rather than hand-formatting. House style (.prettierrc.json) is single quotes, no trailing commas, no bracket spacing, and arrow parens omitted when possible.