Skip to content
Merged
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/evil-rats-turn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

Strip destructive ANSI codes from task log messages.
6 changes: 5 additions & 1 deletion packages/prompts/src/task-log.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ interface BufferEntry {
};
}

const stripDestructiveANSI = (input: string): string => {
return input.replace(/\x1b\[(?:\d+;)*\d*[ABCDEFGHfJKSTsu]|\x1b\[(s|u)/g, '');
};

/**
* Renders a log which clears on success and remains on failure
*/
Expand Down Expand Up @@ -131,7 +135,7 @@ export const taskLog = (opts: TaskLogOptions) => {
if ((mopts?.raw !== true || !lastMessageWasRaw) && buffer.value !== '') {
buffer.value += '\n';
}
buffer.value += msg;
buffer.value += stripDestructiveANSI(msg);
lastMessageWasRaw = mopts?.raw === true;
if (opts.limit !== undefined) {
const lines = buffer.value.split('\n');
Expand Down
35 changes: 35 additions & 0 deletions packages/prompts/test/__snapshots__/task-log.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,28 @@ exports[`taskLog (isCI = false) > message > can write multiple lines 1`] = `
]
`;

exports[`taskLog (isCI = false) > message > destructive ansi codes are stripped 1`] = `
[
"│
",
"◇ foo
",
"│
",
"│ line 1
",
"<erase.line><cursor.up count=1><erase.line><cursor.left count=1>",
"│ line 1
│ line 2 bad ansi!
",
"<erase.line><cursor.up count=1><erase.line><cursor.up count=1><erase.line><cursor.left count=1>",
"│ line 1
│ line 2 bad ansi!
│ line 3
",
]
`;

exports[`taskLog (isCI = false) > message > enforces limit if set 1`] = `
[
"│
Expand Down Expand Up @@ -1358,6 +1380,19 @@ exports[`taskLog (isCI = true) > message > can write multiple lines 1`] = `
]
`;

exports[`taskLog (isCI = true) > message > destructive ansi codes are stripped 1`] = `
[
"│
",
"◇ foo
",
"│
",
"<erase.line><cursor.up count=1><erase.line><cursor.left count=1>",
"<erase.line><cursor.up count=1><erase.line><cursor.up count=1><erase.line><cursor.left count=1>",
]
`;

exports[`taskLog (isCI = true) > message > enforces limit if set 1`] = `
[
"│
Expand Down
14 changes: 14 additions & 0 deletions packages/prompts/test/task-log.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,20 @@ describe.each(['true', 'false'])('taskLog (isCI = %s)', (isCI) => {

expect(output.buffer).toMatchSnapshot();
});

test('destructive ansi codes are stripped', async () => {
const log = prompts.taskLog({
input,
output,
title: 'foo',
});

log.message('line 1');
log.message('line 2\x1b[2K bad ansi!');
log.message('line 3');

expect(output.buffer).toMatchSnapshot();
});
});

describe('error', () => {
Expand Down
Loading