From 741dbe1b8461fbbec54d8900e663b5692a0413ee Mon Sep 17 00:00:00 2001 From: Jun Lee Date: Thu, 10 Apr 2025 15:26:06 +0100 Subject: [PATCH 1/2] Adding WranglerConfig, adding info on GitHubCode. --- .../style-guide/components/github-code.mdx | 14 +++++++-- .../components/wrangler-config.mdx | 29 +++++++++++++++++++ 2 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 src/content/docs/style-guide/components/wrangler-config.mdx diff --git a/src/content/docs/style-guide/components/github-code.mdx b/src/content/docs/style-guide/components/github-code.mdx index bfb62a5bafe76ef..74c01fbb8ea2761 100644 --- a/src/content/docs/style-guide/components/github-code.mdx +++ b/src/content/docs/style-guide/components/github-code.mdx @@ -89,14 +89,24 @@ const baz = foo(); **required** **type:** `string` -The owner and repository to pull from, for example `cloudflare/workers-rs`. +The owner and repository to pull from, in the form of `cloudflare/` + +For example: + +- `cloudflare/workers-rs`. +- `cloudflare/templates`. ### `file` **required** **type:** `string` -The file path to pull from, for example `templates/hello-world/src/lib.rs`. +The file path to pull from, in the form of `path/to/filename-including-extensions`. This path excludes the repo name. + +For example: + +- `templates/hello-world/src/lib.rs`. +- `d1-starter-sessions-api/src/index.ts`. ### `commit` diff --git a/src/content/docs/style-guide/components/wrangler-config.mdx b/src/content/docs/style-guide/components/wrangler-config.mdx new file mode 100644 index 000000000000000..1c207c88b3c96fa --- /dev/null +++ b/src/content/docs/style-guide/components/wrangler-config.mdx @@ -0,0 +1,29 @@ +--- +title: WranglerConfig +styleGuide: + component: WranglerConfig +--- + +This component can be used to automatically generate a `jsonc` version of the `toml` for a Cloudflare [Wrangler configuration file](/workers/wrangler/configuration/). + +## Import + +```mdx +import { WranglerConfig } from "~/components"; +``` + +## Usage + +````mdx live +import { WranglerConfig } from "~/components"; + + +```toml +[[d1_databases]] +binding = "DB" # available in your Worker on env.DB +database_name = "prod-d1-tutorial" +database_id = "" +``` + + +```` From b4b8bb11bbda3695ea2571d5cef1c0d8ac2ec72c Mon Sep 17 00:00:00 2001 From: Jun Lee Date: Mon, 14 Apr 2025 16:43:07 +0100 Subject: [PATCH 2/2] Update src/content/docs/style-guide/components/wrangler-config.mdx --- src/content/docs/style-guide/components/wrangler-config.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/style-guide/components/wrangler-config.mdx b/src/content/docs/style-guide/components/wrangler-config.mdx index 1c207c88b3c96fa..22905243694262e 100644 --- a/src/content/docs/style-guide/components/wrangler-config.mdx +++ b/src/content/docs/style-guide/components/wrangler-config.mdx @@ -4,7 +4,7 @@ styleGuide: component: WranglerConfig --- -This component can be used to automatically generate a `jsonc` version of the `toml` for a Cloudflare [Wrangler configuration file](/workers/wrangler/configuration/). +This component can be used to automatically generate a `jsonc` version of the `toml` (or vice versa) for a Cloudflare [Wrangler configuration file](/workers/wrangler/configuration/). ## Import