Skip to main content

Scaffold Configurator

Generate AI-native project defaults. Pick your stack, copy the files.

Project type
Language
Package manager
Features
# Project Name

One-line description of what this project does.

## Quick Start

```bash
pnpm install
pnpm gates
```

## Gates

The single command that validates everything:

```bash
pnpm gates
```

Gates runs: tsc --noEmit (typecheck) → biome check (lint + format) → vitest run (test) → build

Run gates before every commit. CI runs gates. Hooks run gates.
If gates passes, ship it.

## Repo Map

```text
src/
├── app/            # Routes and pages
├── components/     # React components
├── lib/            # Utilities and helpers
└── types/          # TypeScript type definitions
public/             # Static assets
```

## Do / Don't

### Do

- Run gates before every commit
- Write tests for new functionality
- Use environment variables for configuration
- Keep route handlers thin — business logic goes in services

### Don't

- Skip gates ("it worked locally")
- Commit with failing tests
- Hardcode secrets — use environment variables
- Put business logic in route handlers

## Common Tasks

- **Run tests**: `pnpm test`
- **Run single test**: `pnpm test -- path/to/file.test.ts`
- **Type check**: `pnpm tsc --noEmit`
- **Lint + format**: `pnpm biome check --write`
- **Build**: `pnpm run build`

## Debug Playbook

**Gates fails on typecheck**
Run `pnpm tsc --noEmit` to see the full error. Fix types, don't use `any`.

**Biome lint errors**
Run `pnpm biome check --write` to auto-fix. Review changes before committing.

**Tests fail**
Run the failing test in isolation: `pnpm test -- path/to/file.test.ts`
Check for stale mocks or missing test setup.