78 lines
3.5 KiB
Markdown
78 lines
3.5 KiB
Markdown
|
# AGENTS.md
|
||
|
|
|
||
|
|
## Commands
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm dev # Start development server
|
||
|
|
pnpm build # Production build
|
||
|
|
pnpm start # Start production server (Node.js)
|
||
|
|
pnpm preview # Build and preview on local Cloudflare Workers
|
||
|
|
pnpm deploy # Build and deploy to Cloudflare Workers
|
||
|
|
pnpm upload # Build and upload to Cloudflare Workers (no deploy)
|
||
|
|
pnpm cf-typegen # Generate CloudflareEnv types from wrangler.jsonc
|
||
|
|
pnpm lint # Run ESLint
|
||
|
|
pnpm typecheck # TypeScript type checking (tsc --noEmit)
|
||
|
|
pnpm format # Format with Prettier
|
||
|
|
pnpm clean # Delete .next, .open-next, and node_modules
|
||
|
|
pnpm nuke # Delete .next, .open-next, node_modules, and pnpm-lock.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
## Architecture
|
||
|
|
|
||
|
|
Next.js 16 landing page for [Frosty](https://frostyapp.io) using the App Router with React 19. Deployed on **Cloudflare Workers** via `@opennextjs/cloudflare`.
|
||
|
|
|
||
|
|
### Key Configuration
|
||
|
|
|
||
|
|
- **React Compiler**: Enabled in `next.config.ts` for automatic memoization
|
||
|
|
- **Typed Routes**: Enabled for type-safe navigation (use `Route` type from `next/navigation`)
|
||
|
|
- **Path Alias**: `@/*` maps to `./src/*`
|
||
|
|
- **Strict TypeScript**: `noUncheckedIndexedAccess`, `noImplicitReturns`, `noFallthroughCasesInSwitch`, `noImplicitOverride`, `verbatimModuleSyntax`
|
||
|
|
|
||
|
|
### Source Structure
|
||
|
|
|
||
|
|
- `src/app/` - App Router pages and layouts
|
||
|
|
- `src/components/` - React components (`ui/` subdirectory for shadcn `base-vega` style — add with `pnpm dlx shadcn@latest add <component>`)
|
||
|
|
- `src/lib/` - Utilities (`cn()` for className merging, `constants.ts` for external links)
|
||
|
|
- `src/assets/` - Static images (screenshots)
|
||
|
|
|
||
|
|
### Cloudflare Workers
|
||
|
|
|
||
|
|
- `wrangler.jsonc` - Cloudflare Workers configuration (bindings, R2, KV, etc.)
|
||
|
|
- `open-next.config.ts` - OpenNext adapter config (ISR requires uncommenting R2 incremental cache)
|
||
|
|
- `cloudflare-env.d.ts` - Generated types for Cloudflare bindings (run `pnpm cf-typegen` to regenerate)
|
||
|
|
- Dev mode calls `initOpenNextCloudflareForDev()` in `next.config.ts` for local Cloudflare emulation
|
||
|
|
|
||
|
|
## Naming Conventions
|
||
|
|
|
||
|
|
- Components: PascalCase (`Button.tsx`)
|
||
|
|
- Utilities: camelCase (`formatDate.ts`)
|
||
|
|
- Hooks: `use` prefix (`useDebounce.ts`)
|
||
|
|
- Types: PascalCase (`UserProfile`)
|
||
|
|
|
||
|
|
## ESLint Rules
|
||
|
|
|
||
|
|
Config: `eslint.config.mjs`. Ignores `src/components/ui/`.
|
||
|
|
|
||
|
|
Notable strict rules enforced:
|
||
|
|
|
||
|
|
- `eqeqeq: 'smart'` - Strict equality (except `== null`)
|
||
|
|
- `no-console` - Warn on console usage (allows `console.warn` and `console.error`)
|
||
|
|
- `@typescript-eslint/strict-boolean-expressions` - No implicit boolean coercion (but `allowNullableBoolean` and `allowNullableString` are enabled)
|
||
|
|
- `@typescript-eslint/switch-exhaustiveness-check` - Exhaustive switch statements
|
||
|
|
- `@typescript-eslint/consistent-type-imports` - Use `import type` for types (`fixStyle: 'inline-type-imports'`)
|
||
|
|
- `@typescript-eslint/no-unnecessary-condition` - No redundant conditions
|
||
|
|
- `@typescript-eslint/no-misused-promises` - Prevent floating promises (`checksVoidReturn.attributes` disabled for JSX)
|
||
|
|
- `@eslint-react/jsx-shorthand-boolean` - Use shorthand boolean JSX props
|
||
|
|
- `@eslint-react/no-array-index-key` - Warn on array index as key
|
||
|
|
- `react-you-might-not-need-an-effect` - Avoid unnecessary useEffect
|
||
|
|
- Unused variables must be prefixed with `_`
|
||
|
|
|
||
|
|
## Commits
|
||
|
|
|
||
|
|
Lowercase, no prefixes (e.g., `remove marquee emote background from hero section`). Keep commits tightly scoped.
|
||
|
|
|
||
|
|
## Dev Tooling
|
||
|
|
|
||
|
|
- **Prettier**: Auto-sorts imports (`prettier-plugin-organize-imports`) and Tailwind classes (`prettier-plugin-tailwindcss`)
|
||
|
|
- **react-scan**: Runtime render performance visualization (dev only)
|