mirror of
https://github.com/sanity-io/agent-toolkit.git
synced 2026-09-14 18:39:20 +08:00
Jon Eide Johnsen
120 lines
3.5 KiB
Plaintext
120 lines
3.5 KiB
Plaintext
---
|
|
description: Project structure patterns for Sanity projects including monorepo and embedded Studio setups.
|
|
globs: sanity.config.ts, sanity.cli.ts, package.json, pnpm-workspace.yaml
|
|
alwaysApply: false
|
|
---
|
|
|
|
# Sanity Project Structure
|
|
|
|
## Standalone Studio
|
|
|
|
Best for content-only projects, API-first architectures, or when frontend is managed separately.
|
|
|
|
```
|
|
your-project/
|
|
├── schemaTypes/
|
|
│ ├── index.ts
|
|
│ ├── documents/
|
|
│ ├── objects/
|
|
│ └── blocks/
|
|
├── sanity.config.ts
|
|
├── sanity.cli.ts
|
|
└── package.json
|
|
```
|
|
|
|
**Use cases:**
|
|
- Content modeling with MCP/AI tools (no frontend needed)
|
|
- Headless CMS with external consumers
|
|
- Prototyping and content design
|
|
|
|
## Embedded Studio (Recommended for Next.js)
|
|
|
|
Best for most Next.js projects. Unified deployment, simpler setup.
|
|
|
|
```
|
|
your-project/
|
|
├── src/
|
|
│ ├── app/ # Next.js App Router
|
|
│ │ └── studio/[[...tool]]/ # Embedded Studio route
|
|
│ └── sanity/
|
|
│ ├── lib/
|
|
│ │ ├── client.ts
|
|
│ │ ├── live.ts # defineLive setup
|
|
│ │ └── queries.ts
|
|
│ └── schemaTypes/
|
|
│ ├── index.ts
|
|
│ ├── documents/
|
|
│ ├── objects/
|
|
│ └── blocks/
|
|
├── sanity.config.ts
|
|
├── sanity.cli.ts
|
|
└── sanity-typegen.json
|
|
```
|
|
|
|
## Monorepo
|
|
|
|
Best when you need separation of concerns, multiple frontends, or strict dependency isolation.
|
|
|
|
```
|
|
your-project/
|
|
├── apps/
|
|
│ ├── studio/ # Sanity Studio (standalone)
|
|
│ │ ├── src/
|
|
│ │ │ └── schemaTypes/
|
|
│ │ │ ├── index.ts
|
|
│ │ │ ├── documents/
|
|
│ │ │ ├── objects/
|
|
│ │ │ └── blocks/
|
|
│ │ ├── sanity.config.ts
|
|
│ │ ├── sanity.cli.ts
|
|
│ │ └── package.json
|
|
│ └── web/ # Next.js (or other framework)
|
|
│ ├── src/
|
|
│ │ ├── app/
|
|
│ │ └── sanity/
|
|
│ │ ├── client.ts
|
|
│ │ ├── live.ts
|
|
│ │ └── queries.ts
|
|
│ └── package.json
|
|
├── sanity-typegen.json
|
|
├── pnpm-workspace.yaml
|
|
└── package.json
|
|
```
|
|
|
|
**Setup:**
|
|
1. Add web app URL to CORS origins in Sanity project settings
|
|
2. Configure `sanity-typegen.json` to read schema from `apps/studio` and output types to `apps/web`
|
|
|
|
## File Naming Conventions
|
|
|
|
- **kebab-case** for all files: `user-profile.ts`, `hero-block.ts`
|
|
- `.ts` for schemas/utilities, `.tsx` for React components
|
|
- Each schema exports a named const matching filename
|
|
|
|
## Schema Directory Structure
|
|
|
|
```
|
|
schemaTypes/
|
|
├── index.ts # Exports all types
|
|
├── documents/ # Standalone content types
|
|
│ ├── post.ts
|
|
│ └── author.ts
|
|
├── objects/ # Embeddable/reusable types
|
|
│ ├── seo.ts
|
|
│ └── link.ts
|
|
├── blocks/ # Portable Text blocks
|
|
│ ├── hero.ts
|
|
│ └── callout.ts
|
|
└── shared/ # Shared field definitions
|
|
└── seoFields.ts
|
|
```
|
|
|
|
## Key Files
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| `sanity.config.ts` | Studio configuration (plugins, schema, structure) |
|
|
| `sanity.cli.ts` | CLI configuration (project ID, dataset) |
|
|
| `sanity-typegen.json` | TypeGen configuration |
|
|
| `structure.ts` | Custom desk structure |
|