Add VS Code workspace recommendations and launch config to aspire new templates#15532
Open
Add VS Code workspace recommendations and launch config to aspire new templates#15532
Conversation
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15532Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15532" |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds post-template scaffolding to aspire new so newly created projects are immediately VS Code-ready (workspace extension recommendation + default Aspire debug configuration), while preserving any existing workspace files.
Changes:
- Generate
.vscode/extensions.jsonrecommendingmicrosoft-aspire.aspire-vscodewhen missing. - Generate
.vscode/launch.jsonwith the default “Aspire: Launch default apphost” configuration when missing. - Add CLI tests validating file creation and non-overwrite behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Aspire.Cli/Commands/NewCommand.cs | Writes VS Code workspace files after successful template creation (without overwriting existing files). |
| tests/Aspire.Cli.Tests/Commands/NewCommandTests.cs | Adds tests for creating VS Code workspace files and ensuring existing files aren’t overwritten. |
Contributor
|
Re-running the failed jobs in the CI workflow for this pull request because 2 jobs were identified as retry-safe transient failures in the CI run attempt.
|
mitchdenny
approved these changes
Mar 25, 2026
Member
mitchdenny
left a comment
mitchdenny
left a comment
There was a problem hiding this comment.
We make the assumption that the output path is the root of the workspace, but I think that is probably fine for now. No plans to add it to the recommended extensions if the file already exists?
Member
|
What happens if someone isn't using vscode? How come adding this file is an extra step and not part of the other file creation in scaffolding? Who is the |
…ion-rec-template # Conflicts: # src/Aspire.Cli/Commands/NewCommand.cs
…NewCommand Add .vscode/extensions.json (recommending Aspire extension) and .vscode/launch.json (with Aspire debug config) directly to the four solution templates that include an AppHost: - aspire-empty - aspire-starter - aspire-ts-cs-starter - aspire-py-starter This is better than programmatic generation because it works with all template instantiation paths (dotnet new, aspire new, Visual Studio), not just the Aspire CLI. Remove WriteVsCodeWorkspaceFiles from NewCommand.cs and the three related tests.
Contributor
|
🎬 CLI E2E Test Recordings — 49 recordings uploaded (commit View recordings
📹 Recordings uploaded automatically from CI run #23520221869 |
Member
|
@davidfowl @DamianEdwards What do you think of including vscode files in templates? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
After
aspire newsuccessfully creates a project from any template, the CLI now generates.vscode/extensions.jsonand.vscode/launch.jsonin the output directory if they don't already exist.microsoft-aspire.aspire-vscodeextension as a workspace recommendationExisting files are preserved — if either file already exists, it is not overwritten.
Fixes #14802
Fixes #14391
Checklist