Skip to content

fix: wrap spinner output #359

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

Merged
43081j merged 1 commit into from
Jul 25, 2025
Merged

fix: wrap spinner output #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/dull-singers-mate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

Wrap spinner output to allow for multi-line/wrapped messages.
3 changes: 2 additions & 1 deletion packages/prompts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
"is-unicode-supported": "^1.3.0",
"memfs": "^4.17.2",
"vitest": "^3.2.4",
"vitest-ansi-serializer": "^0.1.2"
"vitest-ansi-serializer": "^0.1.2",
"wrap-ansi": "^8.1.0"
}
}
28 changes: 21 additions & 7 deletions packages/prompts/src/spinner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { block, settings } from '@clack/core';
import { block, getColumns, settings } from '@clack/core';
import color from 'picocolors';
import { cursor, erase } from 'sisteransi';
import wrap from 'wrap-ansi';
import {
type CommonOptions,
S_BAR,
Expand Down Expand Up @@ -46,6 +47,7 @@ export const spinner = ({
let _message = '';
let _prevMessage: string | undefined ;
let _origin: number = performance.now();
const columns = getColumns(output);

const handleExit = (code: number) => {
const msg =
Expand Down Expand Up @@ -94,9 +96,14 @@ export const spinner = ({
const clearPrevMessage = () => {
if (_prevMessage === undefined) return;
if (isCI) output.write('\n');
const prevLines = _prevMessage.split('\n');
output.write(cursor.move(-999, prevLines.length - 1));
output.write(erase.down(prevLines.length));
const wrapped = wrap(_prevMessage, columns, {
hard: true,
trim: false,
});
const prevLines = wrapped.split('\n');
output.write(cursor.up(prevLines.length - 1));
output.write(cursor.to(0));
output.write(erase.down());
};

const removeTrailingDots = (msg: string): string => {
Expand Down Expand Up @@ -126,16 +133,23 @@ export const spinner = ({
clearPrevMessage();
_prevMessage = _message;
const frame = color.magenta(frames[frameIndex]);
let outputMessage: string;

if (isCI) {
output.write(`${frame} ${_message}...`);
outputMessage = `${frame} ${_message}...`;
} else if (indicator === 'timer') {
output.write(`${frame} ${_message} ${formatTimer(_origin)}`);
outputMessage = `${frame} ${_message} ${formatTimer(_origin)}`;
} else {
const loadingDots = '.'.repeat(Math.floor(indicatorTimer)).slice(0, 3);
output.write(`${frame} ${_message}${loadingDots}`);
outputMessage = `${frame} ${_message}${loadingDots}`;
}

const wrapped = wrap(outputMessage, columns, {
hard: true,
trim: false,
});
output.write(wrapped);

frameIndex = frameIndex + 1 < frames.length ? frameIndex + 1 : 0;
// indicator increase by 1 every 8 frames
indicatorTimer = indicatorTimer < 4 ? indicatorTimer + 0.125 : 0;
Expand Down
99 changes: 66 additions & 33 deletions packages/prompts/test/__snapshots__/progress-bar.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ exports[`prompts - progress (isCI = false) > message > sets message for next fra
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ foo",
]
Expand Down Expand Up @@ -95,13 +96,16 @@ exports[`prompts - progress (isCI = false) > start > renders frames at interval
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◓ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◑ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
]
Expand Down Expand Up @@ -131,7 +135,8 @@ exports[`prompts - progress (isCI = false) > stop > renders cancel symbol if cod
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"■
",
Expand All @@ -145,7 +150,8 @@ exports[`prompts - progress (isCI = false) > stop > renders error symbol if code
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"▲
",
Expand All @@ -159,7 +165,8 @@ exports[`prompts - progress (isCI = false) > stop > renders message 1`] = `
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇ foo
",
Expand All @@ -173,7 +180,8 @@ exports[`prompts - progress (isCI = false) > stop > renders message without remo
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇ foo.
",
Expand All @@ -187,7 +195,8 @@ exports[`prompts - progress (isCI = false) > stop > renders submit symbol and st
"│
",
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -201,16 +210,20 @@ exports[`prompts - progress (isCI = false) > style > renders block progressbar 1
"│
",
"◒ ██████████ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ██████████ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◓ ██████████ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◑ ██████████ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -224,16 +237,20 @@ exports[`prompts - progress (isCI = false) > style > renders heavy progressbar 1
"│
",
"◒ ━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◓ ━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◑ ━━━━━━━━━━ ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -247,16 +264,20 @@ exports[`prompts - progress (isCI = false) > style > renders light progressbar 1
"│
",
"◒ ────────── ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ────────── ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◓ ────────── ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◑ ────────── ",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -272,7 +293,8 @@ exports[`prompts - progress (isCI = true) > message > sets message for next fram
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ foo...",
]
Expand Down Expand Up @@ -390,7 +412,8 @@ exports[`prompts - progress (isCI = true) > stop > renders cancel symbol if code
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"■
",
Expand All @@ -406,7 +429,8 @@ exports[`prompts - progress (isCI = true) > stop > renders error symbol if code
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"▲
",
Expand All @@ -422,7 +446,8 @@ exports[`prompts - progress (isCI = true) > stop > renders message 1`] = `
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇ foo
",
Expand All @@ -438,7 +463,8 @@ exports[`prompts - progress (isCI = true) > stop > renders message without remov
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇ foo.
",
Expand All @@ -454,7 +480,8 @@ exports[`prompts - progress (isCI = true) > stop > renders submit symbol and sto
"◒ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -470,12 +497,14 @@ exports[`prompts - progress (isCI = true) > style > renders block progressbar 1`
"◒ ██████████ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ██████████ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -491,12 +520,14 @@ exports[`prompts - progress (isCI = true) > style > renders heavy progressbar 1`
"◒ ━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ━━━━━━━━━━ ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand All @@ -512,12 +543,14 @@ exports[`prompts - progress (isCI = true) > style > renders light progressbar 1`
"◒ ────────── ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◐ ────────── ...",
"
",
"<cursor.backward count=999>",
"<cursor.up count=0>",
"<cursor.left count=1>",
"<erase.down>",
"◇
",
Expand Down
Loading