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

Provide SARIF output #474

Open
mjpieters opened this issue Mar 26, 2022 · 1 comment
Open

Provide SARIF output #474

mjpieters opened this issue Mar 26, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@mjpieters
Copy link
Contributor

mjpieters commented Mar 26, 2022

Please add support for outputting SARIF (Static Analysis Results Interchange Format) information.

This would help integrate nitpick into other tools, as SARIF is a widely supported standard format for code analysers including linters like nitpick. E.g.:

@mjpieters mjpieters added the enhancement New feature or request label Mar 26, 2022
@andreoliwa
Copy link
Owner

Thanks for yet this suggestion.
I haven't heard of this SARIF format before, but it looks interesting for nitpick check, I assume.


(food for thought, maybe for a separate issue)

For all this integration to look great, the current output should be better formatted (AKA revamped).
E.g. standardise error messages, remove duplicates, renumber (there is a draft card on the Roadmap, but I've yet to think and write a decent issue with details).

Also, line references are not returned by Nitpick.
It might be tricky to do that, I haven't thought much about it.

Right now, each Nitpick plugin (TOML/YAML/JSON/INI) has its own way of comparing dicts and applying a diff on the original file.

To work as a proper linter (like flake8 or pylint), I would have to find and return the line number of each line-to-be-modified.
I don't think the packages I use provide such thing, e.g.: tomlkit and ruamel.yaml.

@andreoliwa andreoliwa moved this to Upvoted / Requests in Nitpick Roadmap Sep 19, 2022
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
Status: Upvoted / Requests
Development

No branches or pull requests

2 participants