Skip to content

Restore configuration field documentation in define* helpers - #15880

Merged
NuroDev merged 2 commits into
mainfrom
james/fix-config-helper-jsdoc
Sep 25, 2026
Merged

NuroDev merged 2 commits into
mainfrom
james/fix-config-helper-jsdoc

Conversation

@jamesopstad

Copy link
Copy Markdown
Contributor

Restore configuration field documentation in define* helpers

VS Code now displays JSDoc for fields passed to defineConfig, defineContainer, and defineWorker while retaining their exact inferred config types.


  • Tests
    • Tests included/updated
    • Automated tests not possible - manual testing has been completed as follows:
    • Additional testing not necessary because:
  • Public documentation
    • Cloudflare docs PR(s):
    • Documentation not necessary because: experimental feature

A picture of a cute animal (not mandatory, but encouraged)

@changeset-bot

changeset-bot Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5ae999e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@cloudflare/config Patch
@cloudflare/autoconfig Patch
@cloudflare/build-output-utils Patch
@cloudflare/containers-shared Patch
@cloudflare/deploy-helpers Patch
@cloudflare/remote-bindings Patch

Not sure what this means? Click here to learn what changesets are.

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

@ask-bonk

ask-bonk Bot commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

LGTM

github run

@jamesopstad
jamesopstad marked this pull request as ready for review September 25, 2026 20:00
@workers-devprod
workers-devprod requested review from a team and tpmmorris and removed request for a team September 25, 2026 20:00
@workers-devprod

workers-devprod commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Codeowners approval required for this PR:

  • ✅ @cloudflare/wrangler
Show detailed file reviewers

@pkg-pr-new

pkg-pr-new Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
@cloudflare/autoconfig

npm i https://pkg.pr.new/@cloudflare/autoconfig@15880

@cloudflare/build-output-utils

npm i https://pkg.pr.new/@cloudflare/build-output-utils@15880

@cloudflare/codemods

npm i https://pkg.pr.new/@cloudflare/codemods@15880

@cloudflare/config

npm i https://pkg.pr.new/@cloudflare/config@15880

@cloudflare/containers-shared

npm i https://pkg.pr.new/@cloudflare/containers-shared@15880

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@15880

@cloudflare/deploy-helpers

npm i https://pkg.pr.new/@cloudflare/deploy-helpers@15880

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@15880

miniflare

npm i https://pkg.pr.new/miniflare@15880

@cloudflare/pages-functions

npm i https://pkg.pr.new/@cloudflare/pages-functions@15880

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@15880

@cloudflare/runtime-types

npm i https://pkg.pr.new/@cloudflare/runtime-types@15880

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@15880

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@15880

@cloudflare/vitest-plugin

npm i https://pkg.pr.new/@cloudflare/vitest-plugin@15880

@cloudflare/workers-auth

npm i https://pkg.pr.new/@cloudflare/workers-auth@15880

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@15880

@cloudflare/workers-utils

npm i https://pkg.pr.new/@cloudflare/workers-utils@15880

wrangler

npm i https://pkg.pr.new/wrangler@15880

commit: 5ae999e

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@workers-devprod workers-devprod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codeowners reviews satisfied

@NuroDev
NuroDev enabled auto-merge (squash) September 25, 2026 20:10
@NuroDev
NuroDev merged commit 77e79b2 into main Sep 25, 2026
67 of 69 checks passed
@NuroDev
NuroDev deleted the james/fix-config-helper-jsdoc branch September 25, 2026 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants