fix(TextPrompt): support non-ASCII characters in editable default values by danjourno-dev · Pull Request #2159 · spectreconsole/spectre.console

danjourno-dev · 2026-06-29T21:38:46Z

I have read the Contribution Guidelines
I have checked that there isn't already another pull request that solves the above issue
All newly added code is adequately covered by tests
All existing tests are still running without errors

Claude Code assisted with designing a proper fix. Once reviewed, I applied the fix and created a local console app to manually test the fix. The results of that test are...

Non-ASCII default (press Enter to accept, or edit): (ㅎ): ㅎ
Got: ㅎ
Wide char default (press Enter to accept, or edit): (中文): 中文
Got: 中文
Mixed default (try backspace): (hello ㅎ): hello ㅎ
Got: hello ㅎ

Note: if you are testing this, you may need to add the following into your console app
Console.OutputEncoding = System.Text.Encoding.UTF8;

Changes

ConsoleKeyInfo constructor throws ArgumentOutOfRangeException when the ConsoleKey value exceeds 255. Non-ASCII chars (e.g. Korean, CJK) have code points above 255, so casting directly to ConsoleKey was invalid.

Also fixes two related wide-character display bugs:

Autocomplete erase used char count instead of cell width, leaving ghost characters on screen for double-width glyphs
Backspace in secret mode over-erased cells for wide chars; now erases one cell per mask character regardless of source char width
Backspace now handles surrogate pairs correctly instead of splitting them

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

ConsoleKeyInfo constructor throws ArgumentOutOfRangeException when the ConsoleKey value exceeds 255. Non-ASCII chars (e.g. Korean, CJK) have code points above 255, so casting directly to ConsoleKey was invalid. Also fixes two related wide-character display bugs: - Autocomplete erase used char count instead of cell width, leaving ghost characters on screen for double-width glyphs - Backspace in secret mode over-erased cells for wide chars; now erases one cell per mask character regardless of source char width - Backspace now handles surrogate pairs correctly instead of splitting them Closes spectreconsole#2132

danjourno-dev · 2026-06-29T21:40:03Z

@danjourno-dev please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

@microsoft-github-policy-service agree

patriksvensson · 2026-07-12T09:44:59Z

+    [Fact]
+    public void Should_Backspace_Remove_Surrogate_Pair_As_Single_Rune_Leaving_Preceding_Char()
+    {
+        // Given: "a😀" — 'a' then emoji (surrogate pair 😀)


Suggested change

// Given: "a😀" — 'a' then emoji (surrogate pair 😀)

// Given

patriksvensson · 2026-07-12T09:45:08Z

+        // When
+        var result = console.Prompt(new TextPrompt<string>("Enter:"));
+
+        // Then: both surrogate chars removed as one rune; 'a' remains


Suggested change

// Then: both surrogate chars removed as one rune; 'a' remains

// Then

patriksvensson · 2026-07-12T09:45:17Z

+    [Fact]
+    public void Should_Backspace_Remove_Lone_Emoji_Leaving_Empty_String()
+    {
+        // Given: only an emoji (surrogate pair); AllowEmpty so prompt accepts ""


Suggested change

// Given: only an emoji (surrogate pair); AllowEmpty so prompt accepts ""

// Given

patriksvensson · 2026-07-12T09:45:27Z

+        // When
+        var result = console.Prompt(new TextPrompt<string>("Enter:").AllowEmpty());
+
+        // Then: both surrogate chars removed, nothing left


Suggested change

// Then: both surrogate chars removed, nothing left

// Then

patriksvensson · 2026-07-12T09:45:40Z

+    [Expectation("SecretValueBackspaceWideChar")]
+    public Task Should_Erase_One_Mask_Cell_Per_Backspace_For_Wide_Char_In_Secret_Mode()
+    {
+        // Given: type '한' (double-width CJK), backspace, enter — in secret mode


Suggested change

// Given: type '한' (double-width CJK), backspace, enter — in secret mode

// Given

patriksvensson · 2026-07-12T09:46:00Z

+    [Fact]
+    public void Should_Backspace_Through_Mixed_Width_Sequence_Peeling_One_Rune_At_A_Time()
+    {
+        // Given: "a한😀" — ASCII (1 cell) + CJK (1 char, 2 cells) + emoji (surrogate pair)


Suggested change

// Given: "a한😀" — ASCII (1 cell) + CJK (1 char, 2 cells) + emoji (surrogate pair)

// Given

patriksvensson · 2026-07-12T09:46:08Z

+        var console = new TestConsole();
+        console.Input.PushKey(new ConsoleKeyInfo('a', ConsoleKey.A, false, false, false));
+        console.Input.PushKey(new ConsoleKeyInfo('한', ConsoleKey.Packet, false, false, false));
+        // 😀 = U+1F600 = surrogate pair 😀


Suggested change

// 😀 = U+1F600 = surrogate pair 😀

patriksvensson · 2026-07-12T09:46:19Z

+        // 😀 = U+1F600 = surrogate pair 😀
+        console.Input.PushKey(new ConsoleKeyInfo('\uD83D', ConsoleKey.Packet, false, false, false));
+        console.Input.PushKey(new ConsoleKeyInfo('\uDE00', ConsoleKey.Packet, false, false, false));
+        console.Input.PushKey(ConsoleKey.Backspace); // removes emoji surrogate pair as one rune


Suggested change

console.Input.PushKey(ConsoleKey.Backspace); // removes emoji surrogate pair as one rune

console.Input.PushKey(ConsoleKey.Backspace);

patriksvensson · 2026-07-12T09:46:28Z

+        console.Input.PushKey(new ConsoleKeyInfo('\uD83D', ConsoleKey.Packet, false, false, false));
+        console.Input.PushKey(new ConsoleKeyInfo('\uDE00', ConsoleKey.Packet, false, false, false));
+        console.Input.PushKey(ConsoleKey.Backspace); // removes emoji surrogate pair as one rune
+        console.Input.PushKey(ConsoleKey.Backspace); // removes '한'


Suggested change

console.Input.PushKey(ConsoleKey.Backspace); // removes '한'

console.Input.PushKey(ConsoleKey.Backspace);

patriksvensson · 2026-07-12T09:46:38Z

+        // When
+        var result = console.Prompt(new TextPrompt<string>("Enter:"));
+
+        // Then: 'a' remains; emoji and CJK each removed as single runes


Suggested change

// Then: 'a' remains; emoji and CJK each removed as single runes

// Then

byte2pixel reviewed Jul 6, 2026

View reviewed changes

Comment thread src/Spectre.Console/Extensions/AnsiConsoleExtensions.Input.cs

Add missing tests

48ca69f

byte2pixel approved these changes Jul 6, 2026

View reviewed changes

github-actions Bot added the ⭐ top pull request Top pull request. label Jul 7, 2026

github-actions Bot mentioned this pull request Jul 7, 2026

Top Issues Dashboard #1517

Open

patriksvensson requested changes Jul 12, 2026

View reviewed changes

Navigation Menu

Uh oh!

fix(TextPrompt): support non-ASCII characters in editable default values - #2159

fix(TextPrompt): support non-ASCII characters in editable default values#2159
danjourno-dev wants to merge 2 commits into
spectreconsole:mainfrom
danjourno-dev:fix/2132

danjourno-dev commented Jun 29, 2026

Uh oh!

danjourno-dev commented Jun 29, 2026

Uh oh!

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

patriksvensson Jul 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// Given: "a😀" — 'a' then emoji (surrogate pair 😀)
	// Given

	// Then: both surrogate chars removed as one rune; 'a' remains
	// Then

	// Given: only an emoji (surrogate pair); AllowEmpty so prompt accepts ""
	// Given

	// Given: type '한' (double-width CJK), backspace, enter — in secret mode
	// Given

	// Given: "a한😀" — ASCII (1 cell) + CJK (1 char, 2 cells) + emoji (surrogate pair)
	// Given

	console.Input.PushKey(ConsoleKey.Backspace); // removes emoji surrogate pair as one rune
	console.Input.PushKey(ConsoleKey.Backspace);

	// Then: 'a' remains; emoji and CJK each removed as single runes
	// Then

Uh oh!

Conversation

danjourno-dev commented Jun 29, 2026

Changes

Uh oh!

danjourno-dev commented Jun 29, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants