EXPRESS + TYPESCRIPT AGENTS.MD

A Node.js REST API on Express, written in TypeScript. The rules focus on the boundaries agents most often leave open: input validation, async error handling and SQL safety.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The Express + TypeScript filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: express-api. A REST API on Express and Node.js, written in TypeScript, backed by PostgreSQL.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: TypeScript
- Framework: Express
- Database: PostgreSQL
- Hosting: Render
- Tests: Vitest
- Package manager: npm

## Commands

Run these from the repository root.

- Install dependencies: `npm ci`
- Run locally: `npm run dev`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `npx vitest run src/path/to/file.test.ts`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npx prettier --write .`

## Project layout

- `src/routes/`: Routers: one file per resource
- `src/services/`: Business logic, no req or res objects
- `src/db/`: Queries and migrations
- `src/middleware/`: Auth, validation and error-handling middleware
- `test/`: Integration tests with Supertest

## Code style

- Indent with 2 spaces. Never tabs.
- TypeScript runs in strict mode. Do not use `any`; use `unknown` and narrow it, or write the real type.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Use named exports. Do not add default exports.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Treat user data as sensitive: never log personal data, tokens or request bodies, and collect nothing the feature does not need.
- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.

## Project-specific notes

- Validate `req.body`, `req.params` and `req.query` with a zod schema in every route before using them.
- Route handlers stay thin: parse input, call a service, send the response. Business logic lives in `src/services/` and never touches `req` or `res`.
- Async errors must reach the central error middleware: call `next(err)` or use the async wrapper; never leave a rejected promise unhandled.
- Use parameterized queries only (`$1`, `$2`); never build SQL with string concatenation or template literals.
- Error responses never include stack traces or raw database errors outside development.
- Every new endpoint gets a Supertest integration test covering success, validation failure and auth failure.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: express-api. A REST API on Express and Node.js, written in TypeScript, backed by PostgreSQL.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: TypeScript
- Framework: Express
- Database: PostgreSQL
- Hosting: Render
- Tests: Vitest
- Package manager: npm

## Commands

- Install dependencies: `npm ci`
- Run locally: `npm run dev`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `npx vitest run src/path/to/file.test.ts`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npx prettier --write .`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Express + TypeScript preset

What Is in the Express + TypeScript AGENTS.md?

The preset describes a a REST API on Express and Node.js, written in TypeScript, backed by PostgreSQL. Its AGENTS.md is 53 non-empty lines with 8 exact commands, 5 key directories, and 6 stack-specific rules on top of the shared working rules.

  • Commands: npm ci, npm run dev, npm run build, npm test, npx vitest run src/path/to/file.test.ts, npm run lint, npx tsc --noEmit, npx prettier --write ..
  • Layout: src/routes/, src/services/, src/db/, src/middleware/, test/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Express + TypeScript?

Unvalidated input is the default in Express

Express hands you whatever the client sent. Agents read req.body.email directly because it works in the happy path. A schema at the boundary is cheap and stops type confusion and injection at the door.

Async errors can crash or hang

Depending on the Express version and the code path, a thrown error in an async handler may never reach the error middleware, leaving the request hanging. Being explicit about the error path avoids a class of production incidents.

Template literals make SQL injection easy

Modern JavaScript makes string building so convenient that agents write WHERE id = ${id} without thinking. The rule forbids it outright.

Thin handlers are testable

Services without req and res can be unit tested directly, and the routes only need a few integration tests.

Which Stack Rules Does the File Add?

  • Validate req.body, req.params and req.query with a zod schema in every route before using them.
  • Route handlers stay thin: parse input, call a service, send the response. Business logic lives in src/services/ and never touches req or res.
  • Async errors must reach the central error middleware: call next(err) or use the async wrapper; never leave a rejected promise unhandled.
  • Use parameterized queries only ($1, $2); never build SQL with string concatenation or template literals.
  • Error responses never include stack traces or raw database errors outside development.
  • Every new endpoint gets a Supertest integration test covering success, validation failure and auth failure.

How Do You Add These Files to a Express + TypeScript Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Which Similar Stacks Are in the Library?

All presets are on the stacks page.

Frequently Asked Questions

Does this work with plain JavaScript Express apps?

The structure and safety rules do. Remove the TypeScript language and conventions in the generator and the type-check command disappears from the output.

Why zod?

It gives runtime validation and a TypeScript type from one schema. Any validator works; replace zod in the notes if your project uses Joi, Valibot or something else.

Should I use Fastify or Hono instead?

For new projects they are worth a look, and there is a Hono template in the library. For an existing Express codebase, these rules make it safer without a rewrite.

Are these Express + TypeScript files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?