Danijel Martinek
5ea4c67f93
Captures the decision to add @repo/core-testing, factories, contract suites, vitest safety defaults, coverage thresholds, Storybook test-runner, and CI as one cohesive TDD foundation. Per-feature AGENTS.md gains a Tests section pointing to factories, contract suite, and the canonical test commands. Spec: §7.4, §7.5 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
134 lines
4.1 KiB
Markdown
134 lines
4.1 KiB
Markdown
# AGENTS.md — marketing-pages
|
|
|
|
Pages collection and SiteSettings global for site-wide metadata. Provides marketing/landing page content, SEO settings, and site configuration via Payload.
|
|
|
|
## What it owns
|
|
|
|
- **Entities** — Page type (slug, title, content, published), SiteSettings type (site name, description, logo)
|
|
- **Use cases** — Get page, list pages, publish page, get site settings, update settings
|
|
- **Repository interfaces** — `IPagesRepository`, `ISiteSettingsRepository`
|
|
- **Mock repositories** — In-memory stores for tests
|
|
- **Payload repositories** — Real Payload-backed repositories (constructor-injected at boot)
|
|
- **Payload collection** — Pages collection definition
|
|
- **Payload global** — SiteSettings global definition
|
|
- **tRPC router** — Procedures for list pages, get page, get site settings
|
|
- **DI container** — Per-feature InversifyJS container with marketing-pages symbols
|
|
- **UI components** — Page display, hero section, CTA blocks, footer with site settings
|
|
|
|
## Public exports
|
|
|
|
From `package.json`:
|
|
- `.` — Page type, SiteSettings type, UI components
|
|
- `./api` — tRPC router (`marketingPagesRouter`)
|
|
- `./cms` — Payload Pages collection + SiteSettings global (as separate exports)
|
|
- `./di/bind-production` — `bindProductionMarketing()` to wire Payload repos at boot
|
|
|
|
## What it must NOT import
|
|
|
|
- Any other feature package (`@repo/auth`, `@repo/blog`, etc.)
|
|
- Any app package
|
|
- `@repo/core-api`, `@repo/core-cms`, `@repo/core-trpc`, `@repo/core-ui` directly; only import from `@repo/core-shared` and use DI for Payload config
|
|
|
|
## Layer rules
|
|
|
|
### `src/` files use relative imports
|
|
|
|
```typescript
|
|
// ✓ Correct
|
|
import type { IPagesRepository } from "../repositories/pages.repository.interface.js";
|
|
|
|
// ✗ Wrong
|
|
import { Page } from "@/entities/page.js";
|
|
```
|
|
|
|
### Tests use @/ alias
|
|
|
|
```typescript
|
|
// ✓ Correct
|
|
import { getPageUseCase } from "@/application/use-cases/get-page.use-case.js";
|
|
```
|
|
|
|
### DI container is per-feature
|
|
|
|
Tests rebind:
|
|
|
|
```typescript
|
|
import { container as marketingContainer, MARKETING_SYMBOLS } from "@/di/container.js";
|
|
import { MockPagesRepository } from "@/infrastructure/repositories/mock-pages.repository.js";
|
|
|
|
beforeEach(() => {
|
|
marketingContainer.unbindAll();
|
|
marketingContainer.bind(MARKETING_SYMBOLS.IPagesRepository).to(MockPagesRepository);
|
|
});
|
|
```
|
|
|
|
## Test conventions
|
|
|
|
- **Unit tests** colocated: `*.test.ts`
|
|
- **Feature tests** in `tests/`: `*.feature.test.ts`
|
|
- **Vitest environment** — `node`
|
|
- **Alias** — `@/` resolves to `src/`
|
|
- **Run** — `pnpm test --filter @repo/marketing-pages`
|
|
|
|
## Tests
|
|
|
|
- **Factories:** `src/__factories__/page.factory.ts`, `src/__factories__/site-settings.factory.ts` — use `pageFactory.build({ overrides })` to construct test data with stable defaults.
|
|
- **Contract suite:** `src/__contracts__/pages-repository.contract.ts` — runs against every repository implementation (mock + payload).
|
|
- **Unit tests:** colocated as `*.test.ts` next to the source file.
|
|
- **Feature integration:** `tests/page-by-slug.feature.test.ts` — full slice through tRPC router → controller → use case → mock repo.
|
|
|
|
```bash
|
|
pnpm test --filter @repo/marketing-pages # all tests for this feature
|
|
pnpm test --filter @repo/marketing-pages -- --watch # watch mode
|
|
```
|
|
|
|
See `docs/guides/tdd-workflow.md` for the cycle.
|
|
|
|
## Structure (minimal)
|
|
|
|
```
|
|
src/
|
|
entities/
|
|
page.ts
|
|
site-settings.ts
|
|
errors.ts
|
|
application/
|
|
repositories/
|
|
pages.repository.interface.ts
|
|
site-settings.repository.interface.ts
|
|
use-cases/
|
|
get-page.use-case.ts
|
|
list-pages.use-case.ts
|
|
get-site-settings.use-case.ts
|
|
infrastructure/
|
|
repositories/
|
|
payload-pages.repository.ts
|
|
payload-site-settings.repository.ts
|
|
mock-pages.repository.ts
|
|
mock-site-settings.repository.ts
|
|
di/
|
|
symbols.ts
|
|
container.ts
|
|
bind-production.ts
|
|
interface-adapters/
|
|
controllers/
|
|
pages.controller.ts
|
|
integrations/
|
|
cms/
|
|
collections/
|
|
pages.ts
|
|
globals/
|
|
site-settings.ts
|
|
index.ts
|
|
api/
|
|
router.ts
|
|
index.ts
|
|
ui/
|
|
page-display.tsx
|
|
hero-section.tsx
|
|
footer.tsx
|
|
index.ts
|
|
tests/
|
|
publish-page.feature.test.ts
|
|
```
|