Skip to content

[docs] Document aspire doctor VS Code extension check - #1440

Merged
David Pine (IEvangelist) merged 1 commit into
release/13.5from
docs/pr-18624-doctor-vscode-extension-bec859eae0bc8a9f
Aug 7, 2026
Merged

[docs] Document aspire doctor VS Code extension check#1440
David Pine (IEvangelist) merged 1 commit into
release/13.5from
docs/pr-18624-doctor-vscode-extension-bec859eae0bc8a9f

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#18624

@ellahathaway

Targeting release/13.5 based on the source PR milestone 13.5 (exact match on microsoft/aspire.dev).

Why

PR #18624 adds a new VsCodeExtensionCheck to aspire doctor that 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.md was 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:
    • Added "Development tools checks" to the category list, with an Aside explaining detection (TERM_PROGRAM=vscode or code/code-insiders on PATH), the silent no-op when VS Code isn't detected, and the warning/pass behavior.
    • Added a sample-output snippet showing the Development tools warning line.
    • Added a devtools/vscode-extension JSON check example to the "JSON output format" section, documenting status, message, fix, link, and the vsCodeInstalled / extensionInstalled / extensionId metadata fields.

No new pages were created; this is an in-place update to the existing aspire doctor command reference.
(/body)
(parameter name="branch")docs/pr-18624-doctor-vscode-extension

Generated by PR Documentation Check · auto · 40.8 AIC · ⌖ 12.5 AIC · ⊞ 17.7K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Aug 7, 2026
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review August 7, 2026 05:45
Copilot AI lite review requested due to automatic review settings August 7, 2026 05:45

@IEvangelist David Pine (IEvangelist) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Copilot AI 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.

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-extension entry, including metadata fields.
Suppressed comments (2)

src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx:180

  • aspire doctor prints 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 link is 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
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1440. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1440 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@IEvangelist
David Pine (IEvangelist) merged commit ebc1481 into release/13.5 Aug 7, 2026
11 of 12 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the docs/pr-18624-doctor-vscode-extension-bec859eae0bc8a9f branch August 7, 2026 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants