Add SARIF renderer#865
Merged
Merged
Conversation
This makes the raw arguments accessible from renderers for localization etc. Backwards-compatibility inside the `RuleViolation` class is kept as a single string is still supported.
Contributor
Author
|
@kylekatarnls Have you been able to take a look at this so far? Is there anything I can do to make reviewing easier for you? |
kylekatarnls
previously approved these changes
Apr 16, 2021
kylekatarnls
approved these changes
Apr 16, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type: feature
Issue: Fix #858
Breaking change: no
About this PR
SARIF, the Static Analysis Results Interchange Format, is a standard, JSON-based format for the output of static analysis tools.
As it is an approved OASIS standard, many other tools already support it, including other analyzers and also visualizers (for example IDEs or GitHub Actions). SARIF support in PHPMD will therefore make it much more interoperable with other tools and workflows.
Example use-case
GitHub can display the SARIF output in a rich UI with help texts and examples.
You can see this PR in action in this quick and dirty example workflow run:
Please check this points before submitting your PR.