[Bug]: ProcessOutput Releases w/o Line Breaks

[straub]

Replication of the Problem

const { Listr } = require('listr2');

const tasks = new Listr({
  task: () => {
    console.log('one');
    console.log('two');
  },
})

tasks.run();
// Outputs "onetwo"

Problem

Hi there,

I'm trying to use Listr2@6 in my CLI, but when tasks have console output, line breaks are lost during release(). The output comes out all glued together in one line, which is difficult to read.

(Also, is there a way to opt out of output during release? I'd prefer to hide it entirely, but I couldn't see a related option in the docs / source.)

Let me know if you need further details!

Environment

MacOS Ventura 13.2.1
Node.js 16.20.0
iTerm2 3.4.19
listr2@6.0.3

Log Output

onetwo

Preflight

• Read/Search existing issues and the provided documentation.
• Be sure to not open an issue in the looking for contributions section.
• Checking the latest version of the software to confirm it has not been fixed already.

[cenk1cenk2]

Thank you for reporting this @straub!

I shouldn't have refactored this part before releasing a major version but I am glad you caught it early on.

TBH, I am not fully myself today so I did not give it a fair share of testing but the release should be out soon with the given fix.

Even though disabling the process output part is not very convenient as a renderer option, it is now doable without passing your own implementation.

You can check out the related section https://listr2.kilic.dev/renderer/process-output.html, a bit after the pipeline finishes.

[cenk1cenk2]

🎉 This issue has been resolved in version 6.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[straub]

Thank you for the quick response!

Unfortunately, using the new dump option, the streams that aren't dumped stay hijacked permanently. (And I must have a lot of console logging happening with empty messages or possibly just ANSI codes, because v6.1 without changing dump now outputs many blank lines between the original output for me.)

For now, I'm taking your recommendation and making a custom implementation of ProcessOutput that changes just the release() behavior:

// Hide all console output from tasks at completion.
class QuietProcessOutput extends ProcessOutput {
    release () {
        Object.values(this.stream)
        .forEach((stream) => stream.release());

        this.stream.stdout.write(ANSI_ESCAPE_CODES.CURSOR_SHOW);

        this.active = false;
    }
}

[cenk1cenk2]

Thank you for the feedback. I am honestly a bit sick today and not feeling my self but I will give this another go and fix this permanently so will reopen the issue to inform you back whenever it is done.

[straub]

Please don't rush on my account. Feel better soon!

[cenk1cenk2]

🎉 This issue has been resolved in version 6.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[straub]

6.2 resolved my issues! Streams are releasing with no extra blank lines :)

I'm using new ProcessOutput(null, null, { dump: [] }) rather than my custom subclass now. Thanks again!

[cenk1cenk2]

No problems at all. I am glad it was a quick fix for you and thank you again for reporting the issue.

Have a very nice day!