docs: include links to the docs in the wrangler config schema (#9265)

* docs: include links to the docs in the wrangler config schema

* add changeset

Author: edmundhung

.changeset/social-carpets-start.md

@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+docs: add documentation links to individual config properties in the JSON schema of the Wrangler config file

packages/wrangler/src/config/config.ts

@@ -65,6 +65,8 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 
 	/**
 	 * Options to configure the development server that your worker will use.
+	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#local-development-settings
 	 */
 	dev: Dev;
 
@@ -73,6 +75,8 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 	 * static assets with your Worker.
 	 *
 	 * More details at https://developers.cloudflare.com/workers/platform/sites
+	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#workers-sites
 	 */
 	site:
 		| {
@@ -152,6 +156,8 @@ export interface ConfigFields<Dev extends RawDevConfig> {
 	/**
 	 * A map of module aliases. Lets you swap out a module for any others.
 	 * Corresponds with esbuild's `alias` config
+	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#module-aliasing
 	 */
 	alias: { [key: string]: string } | undefined;
 

packages/wrangler/src/config/environment.ts

@@ -200,6 +200,7 @@ interface EnvironmentInheritable {
 	 * Whether we use <name>.<subdomain>.workers.dev to
 	 * test and deploy your Worker.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#workersdev
 	 *
 	 * @default true
 	 * @breaking
@@ -223,6 +224,8 @@ interface EnvironmentInheritable {
 	 *
 	 * Only required when workers_dev is false, and there's no scheduled Worker (see `triggers`)
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#types-of-routes
+	 *
 	 * @inheritable
 	 */
 	routes: Route[] | undefined;
@@ -280,6 +283,8 @@ interface EnvironmentInheritable {
 	 *
 	 * More details here https://developers.cloudflare.com/workers/platform/cron-triggers
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#triggers
+	 *
 	 * @default {crons:[]}
 	 * @inheritable
 	 */
@@ -289,6 +294,8 @@ interface EnvironmentInheritable {
 	 * Specify limits for runtime behavior.
 	 * Only supported for the "standard" Usage Model
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#limits
+	 *
 	 * @inheritable
 	 */
 	limits: UserLimits | undefined;
@@ -299,6 +306,8 @@ interface EnvironmentInheritable {
 	 * to use Text, Data, and CompiledWasm modules, or when you wish to
 	 * have a .js file be treated as an ESModule instead of CommonJS.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#bundling
+	 *
 	 * @inheritable
 	 */
 	rules: Rule[];
@@ -309,6 +318,8 @@ interface EnvironmentInheritable {
 	 * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
 	 * for more details.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#custom-builds
+	 *
 	 * @default {watch_dir:"./src"}
 	 */
 	build: {
@@ -376,6 +387,9 @@ interface EnvironmentInheritable {
 
 	/**
 	 * Include source maps when uploading this worker.
+	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#source-maps
+	 *
 	 * @inheritable
 	 */
 	upload_source_maps: boolean | undefined;
@@ -394,13 +408,17 @@ interface EnvironmentInheritable {
 	 *
 	 * More details at https://developers.cloudflare.com/workers/frameworks/
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#assets
+	 *
 	 * @inheritable
 	 */
 	assets: Assets | undefined;
 
 	/**
 	 * Specify the observability behavior of the Worker.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#observability
+	 *
 	 * @inheritable
 	 */
 	observability: Observability | undefined;
@@ -454,6 +472,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
+	 *
 	 * @default {}
 	 * @nonInheritable
 	 */
@@ -468,6 +488,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
+	 *
 	 * @default {bindings:[]}
 	 * @nonInheritable
 	 */
@@ -515,6 +537,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -535,6 +559,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#email-bindings
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -553,6 +579,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#queues
+	 *
 	 * @default {consumers:[],producers:[]}
 	 * @nonInheritable
 	 */
@@ -609,6 +637,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -631,6 +661,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -659,6 +691,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -675,6 +709,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -693,6 +729,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -719,6 +757,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -735,6 +775,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
+	 *
 	 * @default {}
 	 * @nonInheritable
 	 */
@@ -750,6 +792,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
+	 *
 	 * @default {}
 	 * @nonInheritable
 	 */
@@ -766,6 +810,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#images
+	 *
 	 * @default {}
 	 * @nonInheritable
 	 */
@@ -835,6 +881,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */
@@ -862,6 +910,8 @@ export interface EnvironmentNonInheritable {
 	 * NOTE: This field is not automatically inherited from the top level environment,
 	 * and so must be specified in every named environment.
 	 *
+	 * For reference, see https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
+	 *
 	 * @default []
 	 * @nonInheritable
 	 */