Skip to content

Fix text prompt underlines in Windows consoles #8489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amcaplan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix text prompt underlines in Windows consoles #8489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a9b3a4
Fix text prompt underlines in Windows consoles
amcaplan Sep 7, 2026
0746103
Preserve text prompt underlines on macOS and Linux
amcaplan Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/windows-prompt-underline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/cli-kit': patch
---

Fix text prompt underlines rendering as unsupported characters in Windows consoles.
25 changes: 24 additions & 1 deletion packages/cli-kit/src/private/node/ui/components/DangerousConfirmationPrompt.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,37 @@
import {DangerousConfirmationPrompt} from './DangerousConfirmationPrompt.js'
import {getLastFrameAfterUnmount, sendInputAndWaitForChange, waitForInputsToBeReady, render} from '../../testing/ui.js'
import {unstyled} from '../../../../public/node/output.js'
import colors from '../../../../public/node/colors.js'
import {platformAndArch} from '../../../../public/node/os.js'
import React from 'react'

import {describe, expect, test, vi} from 'vitest'
import {beforeEach, describe, expect, test, vi} from 'vitest'

vi.mock('../../../../public/node/os.js')

beforeEach(() => {
vi.mocked(platformAndArch).mockReturnValue({platform: 'darwin', arch: 'arm64'})
})

const ENTER = '\r'
const ESC = '\x1b'

describe('DangerousConfirmationPrompt', () => {
test.each(['windows', 'darwin', 'linux'] as const)('renders the underline on %s', async (platform) => {
vi.mocked(platformAndArch).mockReturnValue({platform, arch: 'amd64'})
const renderInstance = render(
<DangerousConfirmationPrompt onSubmit={() => {}} message="Test question" confirmation="yes" />,
)
const underline = (platform === 'windows' ? '─' : '▔').repeat(77)

expect(renderInstance.lastFrame()).toContain(colors.cyan(underline))

await waitForInputsToBeReady()
await sendInputAndWaitForChange(renderInstance, ENTER)

expect(renderInstance.lastFrame()).toContain(colors.red(underline))
})

test('default state', () => {
const {lastFrame} = render(
<DangerousConfirmationPrompt onSubmit={() => {}} message="Test question" confirmation="yes" />,
Expand Down
19 changes: 15 additions & 4 deletions packages/cli-kit/src/private/node/ui/components/DangerousConfirmationPrompt.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {handleCtrlC, useComplete} from '../../ui.js'
import useLayout from '../hooks/use-layout.js'
import {messageWithPunctuation} from '../utilities.js'
import {AbortSignal} from '../../../../public/node/abort.js'
import {platformAndArch} from '../../../../public/node/os.js'
import useAbortSignal from '../hooks/use-abort-signal.js'
import usePrompt, {PromptState} from '../hooks/use-prompt.js'

Expand Down Expand Up @@ -44,7 +45,6 @@ const DangerousConfirmationPrompt: FunctionComponent<DangerousConfirmationPrompt
const complete = useComplete()
const [error, setError] = useState<TokenItem<InlineToken> | undefined>(undefined)
const color = promptState === PromptState.Error ? 'red' : 'cyan'
const underline = new Array(oneThird - 3).fill('▔')
const {isAborted} = useAbortSignal(abortSignal)

useInput((input, key) => {
Expand Down Expand Up @@ -133,9 +133,20 @@ const DangerousConfirmationPrompt: FunctionComponent<DangerousConfirmationPrompt
/>
</Box>
</Box>
<Box marginLeft={3}>
<Text color={color}>{underline}</Text>
</Box>
{platformAndArch().platform === 'windows' ? (
<Box
marginLeft={3}
borderStyle="single"
borderColor={color}
borderBottom={false}
borderLeft={false}
borderRight={false}
/>
) : (
<Box marginLeft={3}>
<Text color={color}>{'▔'.repeat(oneThird - 3)}</Text>
</Box>
)}
{promptState === PromptState.Error && error ? (
<Box marginLeft={3}>
<Text color={color}>
Expand Down
22 changes: 21 additions & 1 deletion packages/cli-kit/src/private/node/ui/components/TextPrompt.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,33 @@ import {getLastFrameAfterUnmount, sendInputAndWaitForChange, waitForInputsToBeRe
import {unstyled} from '../../../../public/node/output.js'
import {AbortController} from '../../../../public/node/abort.js'
import colors from '../../../../public/node/colors.js'
import {platformAndArch} from '../../../../public/node/os.js'
import React from 'react'

import {describe, expect, test, vi} from 'vitest'
import {beforeEach, describe, expect, test, vi} from 'vitest'

vi.mock('../../../../public/node/os.js')

beforeEach(() => {
vi.mocked(platformAndArch).mockReturnValue({platform: 'darwin', arch: 'arm64'})
})

const ENTER = '\r'

describe('TextPrompt', () => {
test.each(['windows', 'darwin', 'linux'] as const)('renders the underline on %s', async (platform) => {
vi.mocked(platformAndArch).mockReturnValue({platform, arch: 'amd64'})
const renderInstance = render(<TextPrompt onSubmit={() => {}} message="Test question" />)
const underline = (platform === 'windows' ? '─' : '▔').repeat(77)

expect(renderInstance.lastFrame()).toContain(colors.cyan(underline))

await waitForInputsToBeReady()
await sendInputAndWaitForChange(renderInstance, ENTER)

expect(renderInstance.lastFrame()).toContain(colors.red(underline))
})

test('default state', () => {
const {lastFrame} = render(<TextPrompt onSubmit={() => {}} message="Test question" defaultValue="Placeholder" />)

Expand Down
19 changes: 15 additions & 4 deletions packages/cli-kit/src/private/node/ui/components/TextPrompt.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {handleCtrlC, useComplete} from '../../ui.js'
import useLayout from '../hooks/use-layout.js'
import {messageWithPunctuation} from '../utilities.js'
import {AbortSignal} from '../../../../public/node/abort.js'
import {platformAndArch} from '../../../../public/node/os.js'
import useAbortSignal from '../hooks/use-abort-signal.js'
import usePrompt, {PromptState} from '../hooks/use-prompt.js'
import React, {FunctionComponent, useCallback, useEffect, useState} from 'react'
Expand Down Expand Up @@ -64,7 +65,6 @@ const TextPrompt: FunctionComponent<TextPromptProps> = ({
const complete = useComplete()
const [error, setError] = useState<string | undefined>(undefined)
const color = promptState === PromptState.Error ? 'red' : 'cyan'
const underline = new Array(oneThird - 3).fill('▔')
const {isAborted} = useAbortSignal(abortSignal)

useInput((input, key) => {
Expand Down Expand Up @@ -128,9 +128,20 @@ const TextPrompt: FunctionComponent<TextPromptProps> = ({
/>
</Box>
</Box>
<Box marginLeft={3}>
<Text color={color}>{underline}</Text>
</Box>
{platformAndArch().platform === 'windows' ? (
<Box
marginLeft={3}
borderStyle="single"
borderColor={color}
borderBottom={false}
borderLeft={false}
borderRight={false}
/>
) : (
<Box marginLeft={3}>
<Text color={color}>{'▔'.repeat(oneThird - 3)}</Text>
</Box>
)}
{promptState === PromptState.Error ? (
<Box marginLeft={3}>
<Text color={color}>{error}</Text>
Expand Down
Loading