Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 19 additions & 30 deletions src/ui/welcome-screen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,41 +77,30 @@ function canAnimate(): boolean {
/**
* Wait for Enter key press
*/
function waitForEnter(): Promise<void> {
return new Promise((resolve) => {
const { stdin } = process;

// Handle non-TTY gracefully
if (!stdin.isTTY) {
resolve();
return;
}

const wasRaw = stdin.isRaw;
stdin.setRawMode(true);
stdin.resume();

const onData = (data: Buffer): void => {
const char = data.toString();

// Enter key or Ctrl+C
if (char === '\r' || char === '\n' || char === '\u0003') {
stdin.removeListener('data', onData);
stdin.setRawMode(wasRaw);
stdin.pause();
async function waitForEnter(): Promise<void> {
if (!process.stdin.isTTY) {
return;
}

// Handle Ctrl+C
if (char === '\u0003') {
process.stdout.write('\n');
process.exit(0);
}
// Keep all interactive input on Inquirer's keypress lifecycle. Mixing a raw
// `data` listener between Inquirer prompts breaks arrow/space keys on Windows.
const { createPrompt, isEnterKey, useKeypress } = await import('@inquirer/core');
const prompt = createPrompt<void, Record<string, never>>((_config, done) => {
useKeypress((key) => {
if (key.ctrl && key.name === 'c') {
process.stdout.write('\n');
process.exit(0);
}

resolve();
if (isEnterKey(key)) {
done(undefined);
}
};
});

stdin.on('data', onData);
return '';
});

await prompt({});
}

/**
Expand Down
57 changes: 57 additions & 0 deletions test/ui/welcome-screen.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

const { useKeypressMock } = vi.hoisted(() => ({
useKeypressMock: vi.fn(),
}));

vi.mock('@inquirer/core', () => ({
createPrompt: vi.fn((view) => async (config: Record<string, never>) => {
let keypressHandler: ((key: { name: string; ctrl: boolean }) => void) | undefined;
useKeypressMock.mockImplementation((handler) => {
keypressHandler = handler;
});

return new Promise<void>((resolve) => {
view(config, resolve);
keypressHandler?.({ name: 'return', ctrl: false });
});
}),
isEnterKey: vi.fn((key) => key.name === 'return'),
useKeypress: useKeypressMock,
}));

describe('welcome screen', () => {
const originalNoColor = process.env.NO_COLOR;
const originalStdinIsTTY = process.stdin.isTTY;
const originalStdoutIsTTY = process.stdout.isTTY;
const originalColumns = process.stdout.columns;

beforeEach(() => {
delete process.env.NO_COLOR;
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true });
Object.defineProperty(process.stdout, 'isTTY', { value: true, configurable: true });
Object.defineProperty(process.stdout, 'columns', { value: 100, configurable: true });
vi.spyOn(process.stdout, 'write').mockImplementation(() => true);
useKeypressMock.mockClear();
});

afterEach(() => {
if (originalNoColor === undefined) {
delete process.env.NO_COLOR;
} else {
process.env.NO_COLOR = originalNoColor;
}
Object.defineProperty(process.stdin, 'isTTY', { value: originalStdinIsTTY, configurable: true });
Object.defineProperty(process.stdout, 'isTTY', { value: originalStdoutIsTTY, configurable: true });
Object.defineProperty(process.stdout, 'columns', { value: originalColumns, configurable: true });
vi.restoreAllMocks();
});

it('uses an Inquirer prompt to wait for Enter', async () => {
const { showWelcomeScreen } = await import('../../src/ui/welcome-screen.js');

await showWelcomeScreen();

expect(useKeypressMock).toHaveBeenCalledOnce();
});
});