Testing console output

Hello,

we’re in the process of migrating lint-staged to Listr2, but I have some question regarding test output assertion.

The orginal Listr’s verbose renderer printed [started] and [completed] strings, while Listr2 uses fancy symbols like ❯ and ✔. These symbols are different on each platform, though, so testing in a CI environment is a bit difficult.

You can see the progress in the PR https://github.com/okonet/lint-staged/pull/852 and how the assertions fail on our Windows tests: https://ci.appveyor.com/project/okonet/lint-staged/builds/32413566/job/qyae7t039cckykre

[iiroj]

Thanks, seems to be just what we need! I’ll also use the test renderer when TERM=dumb just in case those don’t support the fancy glyphs.

[cenk1cenk2]

Something in the ballpark of this hopefully does it. I will also add tests here when I have free time but been lazy lately.

To call the test renderer set the renderer to test.

  const tasks = new Listr<ListrCtx>([
    {
      // You can nest Listr objects, as in the original but now you can also call a new listr class throught task.newListr and inject a type as well
      title: 'Concurrent sub test.',
      task: (ctx, task): Listr => task.newListr<ListrCtx>([
        ...someTasks
  ], {
    renderer:'test'
  })

I will merge after I perform usual manual tests.