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

Driver name for SARIF formatter #455

Closed
mschoettle opened this issue Nov 13, 2024 · 4 comments
Closed

Driver name for SARIF formatter #455

mschoettle opened this issue Nov 13, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@mschoettle
Copy link
Contributor

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
Copy link
Owner

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?

@DavidAnson DavidAnson added the question Further information is requested label Nov 13, 2024
@mschoettle
Copy link
Contributor Author

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
Copy link
Owner

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.

@DavidAnson DavidAnson added enhancement New feature or request and removed question Further information is requested labels Dec 13, 2024
@DavidAnson
Copy link
Owner

Fixed in v0.0.3 of markdownlint-cli2-formatter-sarif.

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

No branches or pull requests

2 participants