AGENTS.md — src

Overview

Backend services (TypeScript/Node.js)

Key Files

Golden Samples (follow these patterns)

Setup & environment

• Install: pnpm install
• Node version: >=20.0.0
• Package manager: pnpm
• Environment variables: See .env or .env.example

Build & tests

• Typecheck (project-wide): pnpm typecheck
• Format: pnpm format
• Lint: pnpm lint
• Test: pnpm test
• Build: pnpm build
• Dev server: pnpm dev

Code style & conventions

• Use TypeScript strict mode (strict: true in tsconfig)
• No any without explicit justification comment
• Prefer interface over type for object shapes
• Naming: camelCase for functions/vars, PascalCase for classes/types
• Async/await over raw Promises
• Prefer const over let, never use var
• Destructure objects and arrays when appropriate

Security & safety

• Validate all user inputs (use zod or similar)
• Parameterized queries only (no string concatenation)
• Never use dynamic code execution with user data
• Sensitive data: never log or expose in errors
• Environment: use dotenv, never hardcode secrets
• CORS: configure explicitly, no wildcard in production
• Rate limiting: implement for public endpoints

PR/commit checklist

• Tests pass: pnpm test
• Type check clean: pnpm typecheck
• Lint clean: pnpm lint
• Formatted: pnpm format
• No any types without justification
• API endpoints have validation
• Error responses don't leak internals

Patterns to Follow

Prefer looking at real code in this repo over generic examples. See Golden Samples section above for files that demonstrate correct patterns.

When stuck

• Check Node.js docs: https://nodejs.org/docs
• TypeScript handbook: https://www.typescriptlang.org/docs
• Review existing patterns in this codebase
• Check root AGENTS.md for project-wide conventions