Seedファイルフォーマット

Seedファイルは、EmDashサイトを初期化するJSONドキュメントです。コレクション、フィールド、タクソノミー、メニュー、リダイレクト、ウィジェットエリア、サイト設定、およびオプションのサンプルコンテンツを定義します。

ルート構造

Seedファイルには次のトップレベルの構造があります：

{
	"$schema": "https://emdashcms.com/seed.schema.json",
	"version": "1",
	"meta": {},
	"settings": {},
	"collections": [],
	"taxonomies": [],
	"bylines": [],
	"menus": [],
	"redirects": [],
	"widgetAreas": [],
	"sections": [],
	"content": {}
}

Meta

metaオブジェクトには、Seedに関するオプションの説明的なメタデータが含まれます：

{
	"meta": {
		"name": "Blog Starter",
		"description": "A simple blog with posts, pages, and categories",
		"author": "EmDash"
	}
}

Settings

settingsオブジェクトには、サイト全体の設定値が含まれます：

{
	"settings": {
		"title": "My Site",
		"tagline": "A modern CMS",
		"postsPerPage": 10,
		"dateFormat": "MMMM d, yyyy"
	}
}

設定はsite:プレフィックス付きでoptionsテーブルに適用されます。セットアップウィザードは、Seedファイルからtitleとtaglineを事前入力し（提供されている場合）、ユーザーが初期設定中にそれらを上書きできるようにします。

Collections

各コレクション定義は、データベースにコンテンツタイプを作成します：

{
	"collections": [
		{
			"slug": "posts",
			"label": "Posts",
			"labelSingular": "Post",
			"description": "Blog posts",
			"icon": "file-text",
			"supports": ["drafts", "revisions"],
			"fields": [
				{
					"slug": "title",
					"label": "Title",
					"type": "string",
					"required": true
				},
				{
					"slug": "content",
					"label": "Content",
					"type": "portableText"
				},
				{
					"slug": "featured_image",
					"label": "Featured Image",
					"type": "image"
				}
			]
		}
	]
}

コレクションプロパティ

フィールドプロパティ

フィールドタイプ

Taxonomies

タクソノミーはコンテンツの分類システムです：

{
	"taxonomies": [
		{
			"name": "category",
			"label": "Categories",
			"labelSingular": "Category",
			"hierarchical": true,
			"collections": ["posts"],
			"terms": [
				{ "slug": "news", "label": "News" },
				{ "slug": "tutorials", "label": "Tutorials" },
				{
					"slug": "advanced",
					"label": "Advanced Tutorials",
					"parent": "tutorials"
				}
			]
		},
		{
			"name": "tag",
			"label": "Tags",
			"labelSingular": "Tag",
			"hierarchical": false,
			"collections": ["posts"]
		}
	]
}

タクソノミープロパティ

タームプロパティ

Menus

menus配列は、管理画面から編集可能なナビゲーションメニューを定義します：

{
	"menus": [
		{
			"name": "primary",
			"label": "Primary Navigation",
			"items": [
				{ "type": "custom", "label": "Home", "url": "/" },
				{ "type": "page", "ref": "about" },
				{ "type": "custom", "label": "Blog", "url": "/posts" },
				{
					"type": "custom",
					"label": "External",
					"url": "https://example.com",
					"target": "_blank"
				}
			]
		}
	]
}

メニューアイテムタイプ

メニューアイテムプロパティ

Bylines

バイラインプロファイルは所有権（author_id）とは別です。再利用可能なバイラインIDを一度定義し、コンテンツエントリから参照します。

{
	"bylines": [
		{
			"id": "editorial",
			"slug": "emdash-editorial",
			"displayName": "EmDash Editorial"
		},
		{
			"id": "guest",
			"slug": "guest-contributor",
			"displayName": "Guest Contributor",
			"isGuest": true
		}
	]
}

Redirects

redirects配列は、移行後にレガシーURLを保持するリダイレクトルールを定義します：

{
	"redirects": [
		{ "source": "/old-about", "destination": "/about" },
		{ "source": "/legacy-feed", "destination": "/rss.xml", "type": 308 },
		{
			"source": "/category/news",
			"destination": "/categories/news",
			"groupName": "migration"
		}
	]
}

リダイレクトプロパティ

Widget Areas

widgetAreas配列は、設定可能なコンテンツ領域を定義します：

{
	"widgetAreas": [
		{
			"name": "sidebar",
			"label": "Main Sidebar",
			"description": "Appears on blog posts and pages",
			"widgets": [
				{
					"type": "component",
					"title": "Recent Posts",
					"componentId": "core:recent-posts",
					"props": { "count": 5 }
				},
				{
					"type": "menu",
					"title": "Quick Links",
					"menuName": "footer"
				},
				{
					"type": "content",
					"title": "About",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "Welcome to our site!" }]
						}
					]
				}
			]
		}
	]
}

ウィジェットタイプ

組み込みコンポーネント

Sections

セクションは、エディタが/sectionスラッシュコマンドを介してPortable Textフィールドに挿入する再利用可能なコンテンツブロックです：

{
	"sections": [
		{
			"slug": "hero-centered",
			"title": "Centered Hero",
			"description": "Full-width hero with centered heading and CTA button",
			"keywords": ["hero", "banner", "header", "landing"],
			"content": [
				{
					"_type": "block",
					"style": "h1",
					"children": [{ "_type": "span", "text": "Welcome to Our Site" }]
				},
				{
					"_type": "block",
					"children": [
						{ "_type": "span", "text": "Your compelling tagline goes here." }
					]
				}
			]
		}
	]
}

セクションプロパティ

Seedファイルからのセクションはsource: "theme"とマークされ、管理UIから削除できません。エディタは独自のセクション（source: "user"）を作成でき、コンテンツの編集時に任意のセクションタイプを挿入できます。

Content

contentオブジェクトには、コレクション別に整理されたサンプルコンテンツエントリが含まれます：

{
	"content": {
		"posts": [
			{
				"id": "hello-world",
				"slug": "hello-world",
				"status": "published",
				"bylines": [
					{ "byline": "editorial" },
					{ "byline": "guest", "roleLabel": "Guest essay" }
				],
				"data": {
					"title": "Hello World",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "Welcome!" }]
						}
					],
					"excerpt": "Your first post."
				},
				"taxonomies": {
					"category": ["news"],
					"tag": ["welcome", "first-post"]
				}
			}
		],
		"pages": [
			{
				"id": "about",
				"slug": "about",
				"status": "published",
				"data": {
					"title": "About Us",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "About page content." }]
						}
					]
				}
			}
		]
	}
}

コンテンツエントリプロパティ

Content References

$ref:プレフィックスを使用して他のコンテンツエントリを参照します：

{
	"data": {
		"related_posts": ["$ref:another-post", "$ref:third-post"]
	}
}

$ref:プレフィックスは、シード中にSeed IDをデータベースIDに解決します。

Media References

URLから画像を含める：

{
	"data": {
		"featured_image": {
			"$media": {
				"url": "https://images.unsplash.com/photo-xxx",
				"alt": "Description of the image",
				"filename": "hero.jpg",
				"caption": "Photo by Someone"
			}
		}
	}
}

.emdash/media/からローカル画像を含める：

{
	"data": {
		"featured_image": {
			"$media": {
				"file": "hero.jpg",
				"alt": "Description of the image"
			}
		}
	}
}

メディアプロパティ

*urlまたはfileのいずれかが必要です。両方は不可。

Applying Seeds Programmatically

CLIツールまたはスクリプト用のSeed APIを使用します：

import { applySeed, validateSeed } from "emdash/seed";
import seedData from "./.emdash/seed.json";

// 最初に検証
const validation = validateSeed(seedData);
if (!validation.valid) {
	console.error(validation.errors);
	process.exit(1);
}

// Seedを適用
const result = await applySeed(db, seedData, {
	includeContent: true,
	onConflict: "skip",
	storage: myStorage,
	baseUrl: "http://localhost:4321",
});

console.log(result);
// {
//   collections: { created: 2, skipped: 0 },
//   fields: { created: 8, skipped: 0 },
//   taxonomies: { created: 2, terms: 5 },
//   bylines: { created: 2, skipped: 0 },
//   menus: { created: 1, items: 4 },
//   redirects: { created: 3, skipped: 0 },
//   widgetAreas: { created: 1, widgets: 3 },
//   settings: { applied: 3 },
//   content: { created: 3, skipped: 0 },
//   media: { created: 2, skipped: 0 }
// }

Applyオプション

Idempotency

シードは複数回安全に実行できます。エンティティタイプ別の競合動作：

Validation

Seedファイルは適用前に検証されます：

import { validateSeed } from "emdash/seed";

const { valid, errors, warnings } = validateSeed(seedData);

if (!valid) {
	errors.forEach((e) => console.error(e));
}

warnings.forEach((w) => console.warn(w));

検証は次のことを確認します：

• 必須フィールドが存在する
• スラッグがそのタイプに対して有効である（コレクションとフィールドのスラッグは小文字、数字、アンダースコアを許可します。他のスラッグはハイフンも許可します）
• フィールドタイプが有効である
• 参照が既存のコンテンツを指している
• 階層タームの親が存在する
• リダイレクトパスが安全なローカルURLである
• リダイレクトソースが一意である
• コレクション内に重複するスラッグがない

CLI Commands

.emdash/seed.json、package.json#emdash.seed、またはseed/seed.jsonのSeedファイルは、ビルドにインライン化され、データベースが空の場合の最初のリクエストで適用されます。既存のサイトのスキーマ（およびオプションでそのコンテンツ）をSeedファイルとしてエクスポートするには：

# 新しいプロジェクトではまだ.emdash/が存在しない可能性があるため`mkdir -p`
mkdir -p .emdash

# 現在のスキーマをSeedファイルとしてエクスポート
npx emdash export-seed > .emdash/seed.json

# コンテンツ付きでエクスポート
npx emdash export-seed --with-content > .emdash/seed.json

Next Steps

• Creating Themes — 完全なテーマを作成
• Themes Overview — テーマの仕組み