search

DavidAnson / markdownlint-cli2

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library
MIT License
371 stars 47 forks source link

Driver name for SARIF formatter #455

Open mschoettle opened 6 days ago

mschoettle commented 6 days ago

I tried out the SARIF formatter to use it in GitHub Actions. It works like a charm 👍

One thing I find odd though is that the name shows up as "markdownlint-cli2-formatter-sarif" as the tool.

Would it be possible to change this to markdownlint-cli2 since that is the tool? Maybe markdownlint would be appropriate as well.

DavidAnson commented 6 days ago

That's the most helpful name to get more information about the output. It distinguishes it from other formatters which might behave differently. Naming it just "markdownlint" would be hard to work backwards from for someone unfamiliar with the tool. This could be a configurable name, but can you please explain more about why the name is significant?

mschoettle commented 6 days ago

GitHub in this case uses the name to show it as the tool that produced/detected this violation:

image

I think that this is somewhat incorrect. The formatters just format the same violations differently, right?

However, it is not a big deal. :)

DavidAnson commented 5 days ago

Here is what the specification says: https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790791

I find that completely unhelpful because it has examples of using both the program name and the plug-in name. :)

Looking at the way this is presented in the UI you show, I probably agree that "markdownlint-cli2" is the most accurate "tool" name.