このコンポーネントは、Cloudflare の Wrangler 設定ファイル について、toml から jsonc 版(またはその逆)を自動生成するために使えます。
import { WranglerConfig } from "~/components";import { WranglerConfig } from "~/components";
<WranglerConfig>
```toml
[[d1_databases]]
binding = "DB" # available in your Worker on env.DB
database_name = "prod-d1-tutorial"
database_id = "<unique-ID-for-your-database>"
```
</WranglerConfig>新規プロジェクトの compatibility_date には、通常 $today を使います。このマジック文字列はビルド時に当日の日付へ自動置換されるため、ドキュメントは常に最新の日付を案内できます。$today を使うと、コンポーネントは compatibility_date 行の上にコメントも自動挿入します(TOML では # Set this to today's date、JSONC では // Set this to today's date)。読者が値を最新に保つ必要があることが分かります。固定の日付を指定することもできますが、最新の機能や性能改善を逃すことがあります。特定の機能を無効にするには、互換性フラグ を使います。
import { WranglerConfig } from "~/components";
<WranglerConfig>
```jsonc
{
"name": "my-worker",
"compatibility_date": "$today"
}
```
</WranglerConfig>一部の機能には、最小の compatibility date が必要です。これらの機能を説明するときは、ドキュメントページで要件を明確に伝えるために :::note コンポーネントを使います。
:::note
This feature requires a `compatibility_date` of `2024-09-23` or later.
:::removeSchema プロパティを使うと、生成される JSON ファイルから $schema 参照を削除できます。コピー&ペーストしやすい設定ファイルの断片を載せたい場合に便利です。ソースの設定形式として toml を渡しているときに使います。
ソースの設定形式として jsonc を渡した場合、removeSchema プロパティは無視されます。
import { WranglerConfig } from "~/components";
<WranglerConfig removeSchema>
```toml
[[d1_databases]]
binding = "DB" # available in your Worker on env.DB
database_name = "prod-d1-tutorial"
database_id = "<unique-ID-for-your-database>"
```
</WranglerConfig>