fix: list-task with multiline desc

[vmaerten]

Linked to :

• align target hints by column #1637

I have multiple solutions in mind

• First solution : remove all \n so we display one line
  

• Second solution : Display only the first line. We could considere for longer desc, we should use summary and not desc
  

• Third solution: Display "as it" with multiline
  

I would considere that desc should be short and summary for long description. So, I would go for the first one.

[pd93]

Also related:

• Text of multi line description not aligned when running task --list #1350

I generally agree that descriptions should be short and kept to a single line. However, I suspect we will have users complain about options 1 and 2 as it restricts their options. A lot of people use the --list functionality as their docs and I can understand that restricting this to 1 line is annoying.

I've had a ton of issues using text/tabwriter in the past and gave up on trying to make it work. (for example task --experiements is still not aligned correctly). If you're able to find a good generalised solution for alignment, I'd be very interested.

[vmaerten]

@pd93 I agree, I was not aware of this issue.

I've changed to the solution 3. I've also fixed the issue with experiments display. Now, all experiments are aligned in a table.

It seems tabwrite does not work well with colors (cf : https://stackoverflow.com/questions/35398497/how-do-i-get-colors-to-work-with-golang-tabwriter / fatih/color#175 / golang/go#12073)

That why, it can be trick, as we display multiple colors in the same table.

It may be worthy to take a look at https://github.com/juju/ansiterm/
I'll take a look if I can find something that can handle both tabs and colors

[vmaerten]

I've push a last version, using https://github.com/Ladicle/tabwriter as a drop in replacement of tabwriter but supporting color

It's way easier to use (no more headache debugging the tabwrite, yes I have a headache now 😂 ) than the text/tabwriter

I've separate in multiple commit, so we can revert a part if needed

[andreynering]

I think I prefer option 1, forcing descriptions to be a single line. We have summary for longer documentation.

Thoughts?

[vmaerten]

I totally agree with you @andreynering. I did this at the first time before the @pd93's comment
We could write in the doc that desc will be printed in one line. If you want multiple lines you need to use summary

[pd93]

I'm happy to go with option 1 if you both agree. I do think we will get some complaints about this though. I generally prefer to encourage users to doing something a specific way rather than forcing, but we can see how it goes.

edit: Massive thanks for finding a fix for the tabwriter issue. That was driving me crazy 😆

[vmaerten]

Option 1 has been chosen.
Here is the result:

[vmaerten]

It's good for review @pd93