该组件可用于自动生成 Cloudflare Wrangler 配置文件的 toml 文件的 jsonc 版本(反之亦然)。
import { WranglerConfig } from "~/components";import { WranglerConfig } from "~/components";
<WranglerConfig>
```toml
[[d1_databases]]
binding = "DB" # 在您的 Worker 的 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),以便读者知道要保持该值最新。如果您需要指定固定日期,也可以这样做,但您可能会错过最新的功能和性能改进。您可以使用兼容性标志(compatibility flags)来禁用特定功能。
import { WranglerConfig } from "~/components";
<WranglerConfig>
```jsonc
{
"name": "my-worker",
"compatibility_date": "$today"
}
```
</WranglerConfig>某些功能需要最低兼容性日期。在记录这些功能时,请使用 :::note 组件在文档页面上清晰地传达该要求:
:::note
此功能需要 `compatibility_date` 为 `2024-09-23` 或更高版本。
:::removeSchema prop 可用于从生成的 JSON 文件中移除 $schema 引用。如果您想添加更易于复制粘贴的配置文件片段,并且将 toml 作为源配置格式,这将非常有用。
如果您提供 jsonc 作为源配置格式,removeSchema prop 将被忽略。
import { WranglerConfig } from "~/components";
<WranglerConfig removeSchema>
```toml
[[d1_databases]]
binding = "DB" # 在您的 Worker 的 env.DB 上可用
database_name = "prod-d1-tutorial"
database_id = "<unique-ID-for-your-database>"
```
</WranglerConfig>