Introduce Sonarqube Generic Format Report

[iVegas]

Is your feature request related to a problem?

I want to provide a code quality report to the Sonarqube instance.

Describe the solution you'd like

I want to be able to choose a report type for code quality check that is compatible with the Sonarqube generic report format.

Additional context (optional)

See https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/importing-external-issues/generic-issue-import-format/

[jrfnl]

@iVegas Thank you for your interest in contributing to PHP_CodeSniffer.

There have been requests for this before. I suggest you read the previous discussion about this and take note of the reasons why this was not accepted so far.

squizlabs/PHP_CodeSniffer#2451

More than anything, I would like to point out that custom reports can already be provided via an external standard since PHPCS 3.3.0: squizlabs/PHP_CodeSniffer#1948. That would very much be the preferred route as that means the maintenance burden would not fall on the maintainers of PHPCS.

[iVegas]

So, if I create a project that will implement the expected Report class in a separate composer package, is there a way phpcs will pick definitions of the new Report class as an additional report option?

UPD: I see the linked PR. As I understand, the approach you are proposing to declare the custom Report implementation is through autoloader, which will initiate the custom code standard. Can we update the https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting page to describe how to set to use the custom report format for phpcs call?

[jrfnl]

Can we update the https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting page to describe how to set to use the custom report format for phpcs call?

@iVegas That sounds like a good idea! Would you like to create a text proposal ? We can then fine-tune it together before I update the page.

[iVegas]

@jrfnl I created a PR with proposed changes to the wiki. See PHPCSStandards/PHP_CodeSniffer-documentation#96