Update Ruby implementation to support pretty output

[fulldecent]

Currently our Ruby implementation only supports JSON output. This is great for consumers, but linters prefer a more friendly looking output by default.

Let's make a great looking output option and add it into the Ruby implementation. It should look so good that linters will want to use our STAT implementation just to get this beautiful output.

Work plan

• Document all possible output situations and required output formatting
  • Processes
    • A process with only a name
      ⭐️ web-puc
    • A process with a name and a version
      ⭐️ web-puc, version 0.0.2
    • (Other information is not used.)
  • Findings
    • With failure set to true
      🛑 Rule, description (entire line is red)
    • With failure set to false
      ⚠️ Rule, description (entire line is yellow)
    • With rule, description and location (location only has file name)
      ⚠️ Rule, description (entire line is yellow)
      in index2.php
    • With rule, description and location (location is one line)
      ⚠️ Rule, description (entire line is yellow)
      in index2.php, line 24
    • With rule, description and location (location is multiple lines)
      ⚠️ Rule, description (entire line is yellow)
      in index2.php, lines 24-26
    • With rule, description and location (location is columns on one line)
      ⚠️ Rule, description (entire line is yellow)
      in index2.php, line 24:15-18
    • With rule, description and location (location is columns on multiple lines)
      ⚠️ Rule, description (entire line is yellow)
      in index2.php, line 24:15 to line 25:5
    • With recommendation
      ⚠️ Rule, description (entire line is yellow)
      RECOMMENDATION: Reword to avoid the passive voice.
    • (Other finding information is not used.)
  • Summaries
    • No errors, no warnings
      ✅ PASSED with no warnings (whole line is green)
    • No errors, with warnings
      ⚠️ PASSED with 5 warnings (whole line is yellow)
    • With errors, no warnings
      🛑 FAILED with 5 errors (whole line is red)
    • With errors, with warnings
      🛑 FAILED with 5 errors and 1 warning (whole line is red)
• Update our Ruby implement to add this outputting option
• Update example consumer from Update example-consumer to use our gem #25 to use this new outputting format

Follow-on work

• Create pull requests for other projects to use our new Gem and use our pretty output format by default
  • https://github.com/mcandre/lili
  • https://github.com/mcandre/gtdlint
  • https://github.com/mcandre/cowl
  • https://github.com/mcandre/enlint
  • https://github.com/mcandre/aspelllint
  • web-puc
• Begin looking for other projects that we may recommend to adopt STAT.

[ilyalyo]

Added PR: #29
Updated example-consumer for for different possible cases.

[ilyalyo]

Also added this PR #32
with fix error symbol utf code

[ilyalyo]

Added PR to: https://github.com/mcandre/lili/issues/22
Added PR to: https://github.com/mcandre/gtdlint/issues/15
Added PR to: https://github.com/mcandre/enlint/issues/12
Added PR to: https://github.com/mcandre/cowl/issues/9
Added PR to: https://github.com/mcandre/aspelllint/pull/21

[ilyalyo]

About web-puc, it's written on shell, so it can not use new STAT gem.

[ilyalyo]

Added PR with pretty json for print_* methods: #35

[fulldecent]

Please see fulldecent/web-puc#5

[ilyalyo]

All points are done except:
Begin looking for other projects that we may recommend to adopt STAT.

[fulldecent]

LGTm, closing, thank you