Use command displayName for CodeLens button text with blank-name fallback#16909
Open
Use command displayName for CodeLens button text with blank-name fallback#16909
Conversation
- Add DisplayName property to ResourceCommandJson (C# shared model) - Map DisplayName in ResourceSnapshotMapper and TelemetryExportService - Add displayName to TypeScript ResourceCommandJson interface - Use displayName for CodeLens button title, description for tooltip Agent-Logs-Url: https://github.com/microsoft/aspire/sessions/d3063561-9cf3-45e3-b2e9-65ee168099f9 Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update VS Code extension to use command display name
Use command displayName for CodeLens button text instead of description
May 9, 2026
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16909Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16909" |
Member
|
@copilot Fix the failing tests |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Aspire resource command JSON shape so VS Code CodeLens buttons use the short command display name for the button text, while keeping the longer description for tooltips—improving readability for custom commands.
Changes:
- Add
DisplayNameto the sharedResourceCommandJsonmodel and populate it from both the CLI snapshot mapper and Dashboard telemetry export. - Extend the VS Code extension’s
ResourceCommandJsoninterface withdisplayName. - Update CodeLens rendering to prefer
displayNamefor the label and usedescriptionfor tooltip text.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Shared/Model/Serialization/ResourceJson.cs | Adds DisplayName to the shared command JSON model. |
| src/Aspire.Dashboard/Model/TelemetryExportService.cs | Maps command display name into exported ResourceJson. |
| src/Aspire.Cli/Backchannel/ResourceSnapshotMapper.cs | Maps backchannel command DisplayName into ResourceCommandJson. |
| extension/src/views/AppHostDataRepository.ts | Adds displayName to the extension’s command JSON interface. |
| extension/src/editor/AspireCodeLensProvider.ts | Uses displayName for CodeLens button title; keeps description for tooltip. |
Agent-Logs-Url: https://github.com/microsoft/aspire/sessions/95c8316c-4458-48d9-8ca5-894fc10fb4ab Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Contributor
Author
Addressed in 9095e96. I fixed the extension test fixtures for the new Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Member
|
@copilot apply changes based on the comments in this thread |
Agent-Logs-Url: https://github.com/microsoft/aspire/sessions/94a11f1e-98cf-49fc-acfd-12d1e35de7be Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Contributor
Author
Applied in 07c0be5. Blank/whitespace command display names now normalize correctly in the CLI mapper and fall back to the command name in CodeLens, with regression coverage added for both paths. No screenshot attached because this only affects fallback behavior for empty/whitespace command metadata. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
Use command displayName for CodeLens button text instead of description
Use command displayName for CodeLens button text with blank-name fallback
May 9, 2026
maddymontaquila
approved these changes
May 9, 2026
Contributor
maddymontaquila
left a comment
maddymontaquila
left a comment
There was a problem hiding this comment.
i mean fix the tests but i tried it and it looks great !!!!
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
CodeLens buttons for custom resource commands were using the
descriptionfield as button text, which can be very long (for example, "Stop the resource, rebuild the project from source, and restart..."). The button text should be the shortdisplayName; thedescriptionbelongs in the tooltip.This change also normalizes empty or whitespace-only command display names so clients safely fall back to the command name instead of rendering a blank CodeLens label or tooltip.
Changes:
DisplayNametoResourceCommandJson(shared C# model) and map it in bothResourceSnapshotMapperandTelemetryExportServicedisplayNameto the TypeScriptResourceCommandJsoninterfacedisplayNamefor CodeLens button label, fall back todescriptionfor tooltipResourceSnapshotMapperso serialized JSON emitsnulland downstream clients can fall back safelydisplayNameordescriptionvalues fall back to the command namedisplayNamefield on resource commandsChecklist
<remarks />and<code />elements on your triple slash comments?