Replace custom RemoveSpectreFormatting with Spectre.Console's Markup.Remove#18209
Open
JamesNK wants to merge 2 commits into
Open
Replace custom RemoveSpectreFormatting with Spectre.Console's Markup.Remove#18209JamesNK wants to merge 2 commits into
JamesNK wants to merge 2 commits into
Conversation
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 18209Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18209" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR replaces a custom regex-based RemoveSpectreFormatting() extension method with Spectre.Console's built-in Markup.Remove() static method across the CLI codebase. The change improves correctness (proper handling of escaped brackets and nested tags) and reduces maintenance of a custom regex pattern.
Changes:
- Replaced all usages of
StringUtils.RemoveSpectreFormatting()withMarkup.Remove()across three files - Removed the
RemoveSpectreFormattingextension method, itsGeneratedRegex, thepartialmodifier, and theSystem.Text.RegularExpressionsusing fromStringUtils.cs
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Aspire.Cli/Utils/StringUtils.cs | Removed the RemoveSpectreFormatting extension method, associated regex, partial modifier, and regex using |
| src/Aspire.Cli/Interaction/ExtensionInteractionService.cs | Replaced 17 call sites from .RemoveSpectreFormatting() to Markup.Remove(...) |
| src/Aspire.Cli/Interaction/ConsoleInteractionService.cs | Replaced 1 call site from .RemoveSpectreFormatting() to Markup.Remove(...) |
| src/Aspire.Cli/Backchannel/ExtensionBackchannel.cs | Replaced 2 call sites from .RemoveSpectreFormatting() to Markup.Remove(...) |
Member
Author
PR Testing ReportPR Information
Artifact Version Verification
Changes AnalyzedFiles Changed
Change Categories
Test Scenarios ExecutedScenario 1: Unit TestsObjective: Verify all CLI unit tests pass with the replacement Results: 4106 tests executed, 0 failed, 4080 succeeded, 26 skipped Scenario 2: Template Creation (aspire-starter)Objective: Exercise DisplayMessage/ShowStatus paths that use Markup.Remove Steps:
Observations:
Scenario 3: Error Display (invalid apphost path)Objective: Verify error display through Markup.Remove renders cleanly Steps:
Observations:
Scenario 4: Doctor CommandObjective: Exercise multiple status/warning/success display paths Steps:
Observations:
Summary
Overall Result✅ PR VERIFIED Low-risk internal refactoring. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Member
Author
|
@adamint The VS Code E2E tests have failed 6 times on this PR. Please fix them. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
❓ CLI E2E Tests unknown — 114 passed, 0 failed, 3 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #27551911405 |
14 tasks
…in choice label throws InvalidOperationException Tests that Markup.Remove throws InvalidOperationException when a choice formatter returns text with unescaped ']' characters, which was previously silently stripped by the regex-based RemoveSpectreFormatting. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
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.
Summary
Replace the custom
RemoveSpectreFormatting()extension method with Spectre.Console's built-inMarkup.Remove()static method.Changes
StringUtils.RemoveSpectreFormatting()withMarkup.Remove()acrossExtensionInteractionService.cs,ConsoleInteractionService.cs, andExtensionBackchannel.csRemoveSpectreFormattingextension method and itsGeneratedRegexfromStringUtils.cspartialmodifier andSystem.Text.RegularExpressionsusing fromStringUtils.csMotivation
Markup.Remove()is the official Spectre.Console API for stripping markup tags. It properly handles edge cases (escaped brackets, nested tags) that the simple regex\[[^\]]+\]could miss. Using the built-in method reduces maintenance burden and improves correctness.Testing
All 4106 CLI tests pass.