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
5 changes: 5 additions & 0 deletions .changeset/swift-spinners-cancel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

Run spinner `onCancel` handlers when <kbd>Ctrl</kbd>+<kbd>C</kbd> cancels through blocked input.
17 changes: 9 additions & 8 deletions packages/prompts/src/spinner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,18 @@ export const spinner = ({
let _prevMessage: string | undefined;
let _origin: number = performance.now();
const columns = getColumns(output);
const input = opts.input ?? process.stdin;
const styleFn = opts?.styleFrame ?? defaultStyleFn;

const handleExit = (code: number) => {
const msg =
code > 1
? (errorMessage ?? settings.messages.error)
: (cancelMessage ?? settings.messages.cancel);
isCancelled = code === 1;
const cancelled = code <= 1;
const msg = cancelled
? (cancelMessage ?? settings.messages.cancel)
: (errorMessage ?? settings.messages.error);
isCancelled = cancelled;
if (isSpinnerActive) {
_stop(msg, code);
if (isCancelled && typeof onCancel === 'function') {
_stop(msg, cancelled ? 1 : code);
if (cancelled && typeof onCancel === 'function') {
onCancel();
}
}
Expand Down Expand Up @@ -131,7 +132,7 @@ export const spinner = ({

const start = (msg = ''): void => {
isSpinnerActive = true;
unblock = block({ output });
unblock = block({ input, output });
_message = removeTrailingDots(msg);
_origin = performance.now();
if (hasGuide) {
Expand Down
19 changes: 18 additions & 1 deletion packages/prompts/test/spinner.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { styleText } from 'node:util';
import { getColumns, updateSettings } from '@clack/core';
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, test, vi } from 'vitest';
import * as prompts from '../src/index.js';
import { MockWritable } from './test-utils.js';
import { MockReadable, MockWritable } from './test-utils.js';

describe.each(['true', 'false'])('spinner (isCI = %s)', (isCI) => {
let originalCI: string | undefined;
Expand Down Expand Up @@ -305,6 +305,23 @@ describe.each(['true', 'false'])('spinner (isCI = %s)', (isCI) => {
expect(output.buffer).toMatchSnapshot();
});

test('runs onCancel when Ctrl+C exits through blocked input', () => {
const input = new MockReadable();
const onCancel = vi.fn();
const result = prompts.spinner({ input, output, onCancel });
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code) => {
processEmitter.emit('exit', typeof code === 'number' ? code : 0);
return undefined as never;
}) as typeof process.exit);
Comment on lines +314 to +315

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These type assertions don't give me confidence


result.start('Test operation');
input.emit('keypress', Buffer.from('\x03'), { name: 'c' });

expect(exitSpy).toHaveBeenCalled();
expect(onCancel).toHaveBeenCalledOnce();
expect(result.isCancelled).toBe(true);
});

test('uses custom cancel message when provided directly', () => {
const result = prompts.spinner({
output,
Expand Down
Loading