KM Koushik
487902421b
* feat: add web test framework with infra-backed suites * fix: honor DATABASE_URL env in integration prepare script * fix: apply web test review feedback * fix: streamline web test infra lifecycle and workflow scope
52 lines
2.9 KiB
Markdown
52 lines
2.9 KiB
Markdown
# Repository Guidelines
|
|
|
|
## Project Structure & Module Organization
|
|
|
|
- apps/web: Next.js app (primary product). Uses Prisma, TRPC, Tailwind.
|
|
- apps/marketing: Public marketing site (Next.js, static export).
|
|
- apps/docs: Mintlify docs content.
|
|
- apps/smtp-server: SMTP proxy/server (TypeScript → tsup build).
|
|
- packages/\*: Shared libraries (email-editor, ui, eslint-config, tailwind-config, typescript-config, sdk).
|
|
- docker/: Dev/compose files; .env\* at repo root define configuration.
|
|
|
|
## Build, Test, and Development Commands
|
|
|
|
- `pnpm i`: Install workspace deps (Node >= 20).
|
|
- `pnpm dev`: Turbo dev for all relevant apps (loads `.env`).
|
|
- `pnpm start:web:local`: Run only `apps/web` locally on port 3000.
|
|
- `pnpm build`: Turbo build across the monorepo.
|
|
- `pnpm lint`: Run ESLint via shared config; fail on warnings.
|
|
- `pnpm format`: Prettier over ts/tsx/md.
|
|
- `pnpm dx` / `pnpm dx:up` / `pnpm dx:down`: Spin up/down local infra via Docker Compose, then run migrations.
|
|
- Database (apps/web filter): `pnpm db:generate` | `db:migrate-dev` | `db:push` | `db:studio`.
|
|
- Never run migrations unless users explicitly asked
|
|
|
|
## Coding Style & Naming Conventions
|
|
|
|
- TypeScript-first; 2-space indent; semicolons enabled by Prettier.
|
|
- Linting: `@usesend/eslint-config`; run `pnpm lint` before PRs.
|
|
- Formatting: Prettier 3; run `pnpm format`.
|
|
- Files: React components PascalCase (e.g., `AppSideBar.tsx`); folders kebab/lowercase.
|
|
- Paths (web): use alias `~/` for src imports (e.g., `import { x } from "~/utils/x"`).
|
|
- NEVER USE DYNAMIC IMPORTS. ALWAYS IMPORT ON THE TOP
|
|
|
|
## Rules
|
|
|
|
- Prefer to use trpc alway unless asked otherwise
|
|
|
|
## Testing Guidelines
|
|
|
|
- Web testing is configured with Vitest in `apps/web`; add tests when changes impact logic, APIs, or behavior.
|
|
- Prefer targeted suites first: `pnpm test:web:unit`, `pnpm test:web:trpc`, `pnpm test:web:api`; use `pnpm test:web` for default non-integration coverage.
|
|
- Test file conventions: `*.unit.test.ts`, `*.trpc.test.ts`, `*.api.test.ts`, `*.integration.test.ts`.
|
|
- Integration tests require infra and env (`RUN_INTEGRATION=true` with Postgres/Redis available). Root commands `pnpm test:web:all` and `pnpm test:web:integration:full` auto-manage infra lifecycle.
|
|
- Use `pnpm test:infra:up` / `pnpm test:infra:down` when running targeted integration commands manually.
|
|
- `pnpm test:web:integration:full` and `test:integration:prepare` run Prisma migrations (`prisma migrate deploy`); never run these unless the user explicitly asks.
|
|
- Test defaults are cloud mode (`NEXT_PUBLIC_IS_CLOUD=true`); keep new tests compatible with cloud behavior unless the task says otherwise.
|
|
|
|
## Commit & Pull Request Guidelines
|
|
|
|
- Prefer Conventional Commits (`feat:`, `fix:`, `chore:`, `docs:`). Git history shows frequent feat/fix usage.
|
|
- PRs must include: clear description, linked issues, screenshots for UI changes, migration notes, and verification steps.
|
|
- never run build,migration commands unless asked for
|