Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding stylish formatter to replace pretty formatter (deprecated) #1294

Merged
merged 3 commits into from Aug 23, 2022

Conversation

scalvert
Copy link
Contributor

@scalvert scalvert commented Aug 23, 2022

We've spent a lot of time with the Pretty formatter, in multiple incarnations. The latest, which leverages the excellent Ink library, provides some pretty robust functionality, but sadly has also resulted in a lot of maintenance burden. The amount of benefit it gives is outweighed by the additional maintenance cost, all for a formatter.

As such, we're deprecating the pretty formatter and its associated infra (@checkup/ui package). This will be done in a follow up PR.

To replace it, we're outputting the SARIF in a familiar format used by other static analysis tools, such as eslint and ember-template-lint.

New stylish formatter:

Screen Shot 2022-08-23 at 12 12 20 PM

This formatter has a number of improvements over the pretty formatter:

  1. It works with SARIF, and is very fault-tolerant
  2. It outputs both location information, and category
  3. It provides a useful summary
  4. It resembles other static analysis tool outputs.

@scalvert scalvert added the enhancement New feature or request label Aug 23, 2022
@scalvert scalvert merged commit ed201c7 into main Aug 23, 2022
@scalvert scalvert deleted the simple-format branch August 23, 2022 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant