シードファイル形式

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

ルート構造

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

Meta

シードに関する任意のメタデータ:

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

Settings

サイト全体の設定値:

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

設定は site: プレフィックスで options テーブルに適用されます。セットアップウィザードでユーザーは 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": [
		{
			"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）とは別のものです。再利用可能な署名アイデンティティを一度定義し、コンテンツエントリから参照します。

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

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": [
		{
			"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." }
					]
				}
			]
		}
	]
}

セクションプロパティ

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

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." }]
						}
					]
				}
			}
		]
	}
}

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

コンテンツ参照

$ref: プレフィックスで他のコンテンツエントリを参照:

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

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

メディア参照

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 のいずれかが必須で、両方は不可。

プログラムによるシードの適用

CLI ツールやスクリプト用のシード 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);
}

// シードの適用
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 }
// }

適用オプション

冪等性

シード適用は複数回実行しても安全です。エンティティタイプ別の競合動作:

バリデーション

シードファイルは適用前にバリデーションされます:

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 コマンド

# シードファイルの適用
npx emdash seed .emdash/seed.json

# サンプルコンテンツなしで適用
npx emdash seed .emdash/seed.json --no-content

# バリデーションのみ
npx emdash seed .emdash/seed.json --validate

# 現在のスキーマをシードとしてエクスポート
npx emdash export-seed > seed.json

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

次のステップ

• テーマの作成 — 完全なテーマの構築
• テーマの概要 — テーマの仕組み