SARIF: add contextRegion on sarif report output for better readability.

[relzhong]

Linters output sarif report often not include contextRegion info. Such as pmd, checkstyle. so is possible for megalinter to append contentRegion information at the collect report phase?

If we want to add contextRegion info for those linter. we can add contextRegion info directly in those project. but it seems we had to do lots of pr to those project. If we add contextRegion in megalinter, we just read source code and append contentRegion to finally report.

[nvuillam]

Why not but ... what it contextRegion ?
Can we calculate it for sure during post-processing, using only available sarif data ?

[relzhong]

ContextRegion define in sarif specification.
We can't calculate from existed sarif data as other linter not fill the information. but we can access it directory from source code.

[nvuillam]

I think it's the role of source linters to generate complete SARIF output, i'm not sure that we can calculate it from Megalinter, which is just an aggregator :/

If you have ideas about how to calculate that from MegaLinter, you can try a PR of course !

Otherwise, I think the best is to request source linter authors to complete their SARIF output so it contains ContextRegion

[llaville]

Totally agree here with @nvuillam.
@relzhong if your ecosystem is PHP, I suggest to use my project https://github.com/llaville/sarif-php-sdk that support full implementation of SARIF 2.1.0

BTW, PHP Linters included with MegaLinter already use this SDK and provide SARIF support (see https://megalinter.io/latest/descriptors/php/)

[relzhong]

Will try to contact source linter to add this feature, I think is better solution, thanks.