[docs] Document aspire doctor VS Code extension check - #1440
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Validated against microsoft/aspire#18624 and the CLI output-format spec. Detection behavior, category/check names, warning output, link, and JSON metadata are documented accurately.
There was a problem hiding this comment.
Pull request overview
Updates the aspire doctor CLI reference to document the new VS Code extension check introduced upstream, including the new “Development Tools” category, sample output, and JSON output shape.
Changes:
- Adds a new “Development Tools checks” category description and a note explaining VS Code detection behavior.
- Adds a sample warning output snippet for the missing VS Code extension scenario.
- Adds a JSON check example for the
devtools/vscode-extensionentry, including metadata fields.
Suppressed comments (2)
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx:180
aspire doctorprints the category header as "Development Tools" (capital T). This sentence refers to "Development tools", which doesn't match the actual section header text.
When VS Code is detected but the Aspire extension isn't installed, the Development tools section reports a warning:
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx:185
- The human-readable doctor output prints a marketplace link line when
linkis set (e.g.,See: https://aka.ms/aspire/vscode-extension). The snippet currently omits that line and also uses "Development tools" instead of the actual "Development Tools" header, so it doesn't reflect the real output shape.
Development tools
⚠️ VS Code is installed, but the Aspire extension is not installed
Install the Aspire extension from the VS Code Marketplace for an integrated Aspire experience.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **SDK checks**: Verifies .NET SDK installation and version requirements | ||
| - **Container checks**: Validates container runtime (Docker and/or Podman) availability, running status, and version. Reports which runtime is active and why (explicit configuration, auto-detected default, or auto-detected only runtime running) | ||
| - **Environment checks**: Reports operating system information (type, version, and Linux distro details when available) and validates environment variables and other settings, including the JavaScript toolchain required by TypeScript AppHosts (npm, pnpm, Yarn, or Bun) | ||
| - **Development tools checks**: When VS Code is detected, reports whether the [Aspire VS Code extension](https://aka.ms/aspire/vscode-extension) is installed |
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Documents changes from microsoft/aspire#18624
@ellahathawayTargeting
release/13.5based on the source PR milestone13.5(exact match onmicrosoft/aspire.dev).Why
PR #18624 adds a new
VsCodeExtensionChecktoaspire doctorthat detects VS Code and warns when the Aspire VS Code extension (microsoft-aspire.aspire-vscode) isn't installed, reporting the result under a new Development tools category. This changes the CLI's documented check categories, sample output, and JSON schema (docs/specs/cli-output-formats.mdwas updated in the source PR to add this), so the corresponding CLI reference docs needed the same update.What changed
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx:Asideexplaining detection (TERM_PROGRAM=vscodeorcode/code-insidersonPATH), the silent no-op when VS Code isn't detected, and the warning/pass behavior.Development toolswarning line.devtools/vscode-extensionJSON check example to the "JSON output format" section, documentingstatus,message,fix,link, and thevsCodeInstalled/extensionInstalled/extensionIdmetadata fields.No new pages were created; this is an in-place update to the existing
aspire doctorcommand reference.(/body)
(parameter name="branch")docs/pr-18624-doctor-vscode-extension