Danijel Martinek
2c2375920f
- Rename eslint-config → core-eslint, typescript-config → core-typescript in all docs (package map, AGENTS.md, overview.md, dependency-flow.md, etc.) - Document the five-tag model (app, feature, core, core-composition, tooling) — refinement of ADR-006's three-tag mention - Document core-trpc's core-composition tag (transitively reaches features through core-api's AppRouter type) - Note Turborepo boundaries as a second enforcement layer alongside ESLint - Add ADR-010 explaining the two-layer enforcement decision and five-tag refinement Files updated: - docs/architecture/overview.md: package map, enforcement layers, five-tag section - docs/architecture/dependency-flow.md: boundary rules, enforcement strategy - docs/architecture/vertical-feature-spec.md: package names, five-tag model - AGENTS.md: package map, boundary rules, commands - CLAUDE.md: tooling package names, quick-start command - packages/core-eslint/AGENTS.md: tag clarification - packages/core-typescript/AGENTS.md: tag clarification - packages/core-api/AGENTS.md: core-composition tag - packages/core-cms/AGENTS.md: core-composition tag - packages/core-trpc/AGENTS.md: core-composition tag + rationale - docs/decisions/adr-010-turbo-boundaries.md: new ADR Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# AGENTS.md — core-trpc
|
|
|
|
**Tag:** core-composition
|
|
|
|
Frontend tRPC platform providing the client and framework-specific providers (Next.js, TanStack). Bridges typed backend (`@repo/core-api`) to frontend applications. Tagged `core-composition` (not `core`) because it transitively reaches features through `core-api`'s `AppRouter` type.
|
|
|
|
## Responsibilities
|
|
|
|
- **Create tRPC React client** — `createTRPCReact<AppRouter>()` for use in React apps
|
|
- **Query client factory** — TanStack React Query setup per app
|
|
- **Framework-specific providers** — Next.js App Router provider + TanStack Start provider
|
|
- **No business logic** — purely framework integration
|
|
|
|
## Must NOT import
|
|
|
|
- Any feature package (`@repo/auth`, `@repo/blog`, etc.)
|
|
- Any app package
|
|
- `@repo/core-api`, `@repo/core-cms`, `@repo/core-ui`
|
|
|
|
## Public exports
|
|
|
|
From `package.json`:
|
|
- `.` — client + query client factory
|
|
- `./next` — Next.js App Router provider
|
|
- `./tanstack` — TanStack Start provider
|
|
|
|
Example usage:
|
|
```typescript
|
|
// In Next.js app
|
|
import { TrpcProvider } from "@repo/core-trpc/next";
|
|
|
|
// In TanStack Start app
|
|
import { TrpcProvider } from "@repo/core-trpc/tanstack";
|
|
|
|
// In client components
|
|
import { useTRPC } from "@repo/core-trpc";
|
|
const trpc = useTRPC();
|
|
```
|
|
|
|
## Test conventions
|
|
|
|
- No unit tests (provider layer)
|
|
- Verify at app boot: `pnpm dev --filter @repo/web-next` or `pnpm dev --filter @repo/web-tanstack` succeeds
|
|
- Verify client type safety: `pnpm typecheck` confirms `AppRouter` is imported and typed correctly
|
|
|
|
## Structure
|
|
|
|
```
|
|
src/
|
|
client.ts # createTRPCReact<AppRouter>()
|
|
query-client.ts # makeQueryClient()
|
|
providers/
|
|
next-provider.tsx # 'use client' provider for Next.js
|
|
tanstack-provider.tsx # Provider for TanStack Start
|
|
index.ts # re-exports client + factories
|
|
```
|