[docs] example reports

[gabrielcsapo]

Motivation

I am working on a couple of tasks and wondering what the best way to represent data in the CLI would be. For example if I am tracking a few particular lint rules what would be the best way to show current progress? A few examples of the variations that checkup would be best used to track would be a great addition to the docs.

[scalvert]

Thanks for the question, @gabrielcsapo. I assume when you're referring to lint rules you mean 'see how many current violations of a particular rule there are'.

To do this, I'd display in a table using the ui.table utility, where you can output the rule name and the violation count. You can then add 1..n rules you're tracking.

Hope this helps.