Binding contrib guide

[RamIdeas]

What this PR solves / how to test

Fixes DEVX-1368

Author has addressed the following

• Tests
  • TODO (before merge)
  • Tests included
  • Tests not necessary because: internal docs
• E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
  • I don't know
  • Required
  • Not required because: internal docs
• Changeset (Changeset guidelines)
  • TODO (before merge)
  • Changeset included
  • Changeset not necessary because: internal docs
• Public documentation
  • TODO (before merge)
  • Cloudflare docs PR(s):
  • Documentation not necessary because: internal docs

[changeset-bot]

⚠️ No Changeset found

Latest commit: d91f615

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-wrangler-6864

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6864/npm-package-wrangler-6864

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-wrangler-6864 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-create-cloudflare-6864 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-cloudflare-kv-asset-handler-6864

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-miniflare-6864

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-cloudflare-pages-shared-6864

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-cloudflare-vitest-pool-workers-6864

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-cloudflare-workers-editor-shared-6864

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11383752220/npm-package-cloudflare-workers-shared-6864

Note that these links will no longer work once the GitHub Actions artifact expires.

---

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
miniflare	workspace:*	3.20241011.0
workerd	1.20241011.1	1.20241011.1
workerd --version	1.20241011.1	2024-10-11

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

[penalosa]

This should also include:

• wrangler types
• wrangler init --from-dash
• SDW types

[RamIdeas]

This should also include:

• wrangler types
• wrangler init --from-dash
• SDW types

Addressed in a02a88e

[andyjessop]

This looks fine in a markdown viewer (the numbers are corrected), but looks odd in the raw state.

[RamIdeas]

That's a feature of markdown imo. You don't need to manually mess with bullet numbers, it will do it for you.

[petebacondarwin]

Nice! It's scary how spread out this stuff is.

Does one also need to update the resolveBindings() function in ConfigController.ts too?

Also, I feel like this should be in some kind of docs folder rather than the root of the wrangler package... e.g. packages/wrangler/docs/how-to/add-a-binging.md?

[RamIdeas]

Also, I feel like this should be in some kind of docs folder rather than the root of the wrangler package... e.g. packages/wrangler/docs/how-to/add-a-binging.md?

Agreed, moved.

Does one also need to update the resolveBindings() function in ConfigController.ts too?

That function internally calls a function already mentioned in this guide https://github.com/cloudflare/workers-sdk/blob/binding-contrib-guide/packages/wrangler/src/api/startDevWorker/ConfigController.ts#L152

And the extractBindingsOfType stuff above is only for cli args bindings, which we won't be extending (if we do, we can address it then, but for now I would consider it not recommended)

addressed