Various optimisations to Markup instantiation & formatting by benbryant0 · Pull Request #2008 · spectreconsole/spectre.console

benbryant0 · 2026-01-29T01:30:34Z

Somewhat related to #232

I have read the Contribution Guidelines
I have commented on the issue above and discussed the intended changes
A maintainer has signed off on the changes and the issue was assigned to me
All newly added code is adequately covered by tests
All existing tests are still running without errors
The documentation was modified to reflect the changes OR no documentation changes are required.

Changes

Added several benchmarks focused around the instantiation of the Markup type, since that's used all over the place when taking in strings. There's one overall benchmark (MarkupBenchmarks.Constructor) and every other benchmark I added is focused on a part of the logic called by the constructor at various levels. I did this mostly just to demonstrate the effects of individual changes. They're in separate commits, so feel free to just drop any benchmarks that aren't wanted.

The actual changes are also in independent commits except for the last one concerning spans in Paragraph.Append, which depends on the one before it. So again, feel free to drop any that are unwanted or that you'd want reworked heavily.

Benchmarks

Here are benchmark runs for before and after (with some minor editing to make comparison easier). I ran them for .NET Framework 4.8.1 as well since .NET standard is still supported. Just to make sure there were no unexpected negative effects.

.NET 10

Before
| Method             | Mean       | Error     | StdDev    | Gen0   | Gen1   | Allocated |
|------------------- |-----------:|----------:|----------:|-------:|-------:|----------:|
| Markup_Constructor | 3,140.0 ns | 0.0060 μs | 0.0050 μs | 1.4801 | 0.0076 |   9.07 KB |
| AnsiMarkup_Parse   | 2,339.0 ns | 0.0100 μs | 0.0089 μs | 1.0376 | 0.0038 |   6.38 KB |
After
| Method             | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Markup_Constructor | 1,057.4 ns | 3.40 ns | 3.01 ns | 0.4883 | 0.0019 |   2.99 KB |
| AnsiMarkup_Parse   |   760.3 ns | 2.01 ns | 1.79 ns | 0.3710 | 0.0010 |   2.27 KB |

Before
| Method                   | Mean       | Error    | StdDev   | Gen0   | Allocated |
|------------------------- |-----------:|---------:|---------:|-------:|----------:|
| Replace_NoEmoji          |   17.58 ns | 0.131 ns | 0.116 ns | 0.0280 |     176 B |
| Replace_NoEmoji_ButColon |   49.38 ns | 0.201 ns | 0.178 ns | 0.0459 |     288 B |
| Replace_Emoji            |   72.19 ns | 0.322 ns | 0.301 ns | 0.0471 |     296 B |
After
| Method                   | Mean       | Error     | StdDev    | Gen0   | Allocated |
|------------------------- |-----------:|----------:|----------:|-------:|----------:|
| Replace_NoEmoji          |   3.013 ns | 0.0024 ns | 0.0021 ns |      - |         - |
| Replace_NoEmoji_ButColon |   6.906 ns | 0.0018 ns | 0.0016 ns |      - |         - |
| Replace_Emoji            |  70.942 ns | 0.2063 ns | 0.1722 ns | 0.0471 |     296 B |

Before
| Method | text                 | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------- |--------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Append | Multiple lines. [31] |   649.6 ns | 3.08 ns | 2.73 ns | 0.3872 | 0.0010 |   2.38 KB |
| Append | One line....... [31] |   830.3 ns | 1.86 ns | 1.55 ns | 0.5341 | 0.0029 |   3.27 KB |
After
| Method | text                 | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------- |--------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Append | Multiple lines. [31] |   295.3 ns | 0.80 ns | 0.71 ns | 0.1373 |      - |     864 B |
| Append | One line....... [31] |   451.7 ns | 3.20 ns | 3.00 ns | 0.2089 | 0.0005 |    1312 B |

.NET Framework 4.8.1

Before
| Method             | Mean       | Error     | StdDev    | Gen0   | Gen1   | Allocated |
|------------------- |-----------:|----------:|----------:|-------:|-------:|----------:|
| Markup_Constructor | 9,269.0 ns | 0.0328 μs | 0.0274 μs | 2.4261 | 0.0153 |  14.97 KB |
| AnsiMarkup_Parse   | 7,513.0 ns | 0.0108 μs | 0.0096 μs | 1.9455 | 0.0076 |  11.96 KB |
After
| Method             | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Markup_Constructor | 2,784.1 ns | 8.68 ns | 7.70 ns | 0.5646 |      - |   3.47 KB |
| AnsiMarkup_Parse   | 1,886.2 ns | 5.86 ns | 5.48 ns | 0.4330 |      - |   2.66 KB |

Before
| Method                   | Mean       | Error    | StdDev   | Gen0   | Allocated |
|------------------------- |-----------:|---------:|---------:|-------:|----------:|
| Replace_NoEmoji          |   38.21 ns | 0.197 ns | 0.175 ns | 0.0166 |     104 B |
| Replace_NoEmoji_ButColon |  133.24 ns | 0.685 ns | 0.607 ns | 0.0637 |     401 B |
| Replace_Emoji            |  221.65 ns | 0.224 ns | 0.199 ns | 0.0637 |     401 B |
After
| Method                   | Mean       | Error     | StdDev    | Gen0   | Allocated |
|------------------------- |-----------:|----------:|----------:|-------:|----------:|
| Replace_NoEmoji          |  17.674 ns | 0.1646 ns | 0.1539 ns |      - |         - |
| Replace_NoEmoji_ButColon |  22.404 ns | 0.0473 ns | 0.0443 ns |      - |         - |
| Replace_Emoji            | 210.119 ns | 0.4512 ns | 0.3768 ns | 0.0637 |     401 B |

Before
| Method | text                 | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------- |--------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Append | Multiple lines. [31] | 1,414.8 ns | 2.16 ns | 1.81 ns | 0.4463 | 0.0019 |   2.74 KB |
| Append | One line....... [31] | 1,780.9 ns | 5.19 ns | 4.60 ns | 0.5779 | 0.0019 |   3.56 KB |
After
| Method | text                 | Mean       | Error   | StdDev  | Gen0   | Gen1   | Allocated |
|------- |--------------------- |-----------:|--------:|--------:|-------:|-------:|----------:|
| Append | Multiple lines. [31] |   849.1 ns | 2.41 ns | 2.14 ns | 0.1535 |      - |     971 B |
| Append | One line....... [31] | 1,111.4 ns | 1.35 ns | 1.13 ns | 0.2270 |      - |    1436 B |

Please upvote 👍 this pull request if you are interested in it.

benbryant0 · 2026-01-29T01:31:43Z

@microsoft-github-policy-service agree

patriksvensson · 2026-02-22T23:15:21Z

Sorry for not getting back to you sooner about this PR. The results are very promising, but the PR needs to be rebased against upstream and have the merge conflicts resolved. I can do this for you, but it will take a couple of days since I'm away on vacation.

benbryant0 · 2026-02-22T23:28:39Z

No problem, thanks for taking a look at it. I just held off on rebasing due to instructions in the contribution guidelines, so I'll get on that now.

This will only allocate if an emoji replacement occurs. I think taking a span is pointless unless it'd be a TryReplace pattern or write to a span. As it was, it just forced a new string to be created in all circumstances.

src/Spectre.Console.Ansi/AnsiMarkup.cs

src/Spectre.Console/Internal/Text/WhiteSpaceSegmentEnumerator.cs

Co-authored-by: Patrik Svensson <[email protected]>

benbryant0 force-pushed the optimise branch from cf328f3 to b9a90ce Compare January 29, 2026 01:40

benbryant0 added 10 commits February 22, 2026 23:35

Add Markup benchmarks

67c9219

Add benchmarks for Emoji.Replace

b18cdb0

Add Paragraph benchmarks

2bedf56

Simplify AnsiMarkup style stack logic

895ee98

Optimise Cell.GetCellLength

b473161

Simplify dictionary operations

99c7068

Simplify & optimise MarkupTokenizer

c087485

Optimise Emoji.Replace

5d5587f

This will only allocate if an emoji replacement occurs. I think taking a span is pointless unless it'd be a TryReplace pattern or write to a span. As it was, it just forced a new string to be created in all circumstances.

Simplify Paragraph.Append

f0c70d7

Use spans in Paragraph.Append

16a5c81

benbryant0 force-pushed the optimise branch from b9a90ce to 16a5c81 Compare February 23, 2026 00:54

patriksvensson requested changes Feb 23, 2026

View reviewed changes

src/Spectre.Console.Ansi/AnsiMarkup.cs Show resolved Hide resolved

src/Spectre.Console/Internal/Text/WhiteSpaceSegmentEnumerator.cs Outdated Show resolved Hide resolved

benbryant0 force-pushed the optimise branch from 1c079f9 to 91fa2af Compare February 23, 2026 12:35

Make WhiteSpaceSegmentEnumerator namespace consistent

9215c95

Co-authored-by: Patrik Svensson <[email protected]>

benbryant0 force-pushed the optimise branch from 91fa2af to 9215c95 Compare February 23, 2026 13:35

patriksvensson approved these changes Feb 25, 2026

View reviewed changes

patriksvensson merged commit c82f755 into spectreconsole:main Feb 25, 2026
3 checks passed

dependabot bot mentioned this pull request Apr 3, 2026

Bump Spectre.Console from 0.54.0 to 0.55.0 DuckDuckStudio/DuckStudio.CatFood#5

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Various optimisations to Markup instantiation & formatting#2008

Various optimisations to Markup instantiation & formatting#2008
patriksvensson merged 11 commits intospectreconsole:mainfrom
benbryant0:optimise

benbryant0 commented Jan 29, 2026 •

edited by patriksvensson

Loading

Uh oh!

benbryant0 commented Jan 29, 2026

Uh oh!

patriksvensson commented Feb 22, 2026

Uh oh!

benbryant0 commented Feb 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

benbryant0 commented Jan 29, 2026 • edited by patriksvensson Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Benchmarks

Uh oh!

benbryant0 commented Jan 29, 2026

Uh oh!

patriksvensson commented Feb 22, 2026

Uh oh!

benbryant0 commented Feb 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

benbryant0 commented Jan 29, 2026 •

edited by patriksvensson

Loading