feat: Add GitLab output format support to CLI. #474
Conversation
raffaelecarelle
changed the title
| */ | ||
| private function getPathFromFqcn(string $fqcn): string | ||
| { | ||
| return (new \ReflectionClass($fqcn))->getFileName(); |
There was a problem hiding this comment.
I would avoid relying on the reflection to get the filename, but rather adding to the violation class. @AlessandroMinoccheri @fain182 wdty?
There was a problem hiding this comment.
@micheleorselli That would be much better, actually. Let me know what I should change, thanks!
Introduced the "gitlab" format for CLI output, alongside existing "text" and "json" formats. This includes a new `GitlabPrinter` implementation, updates to the `PrinterFactory` and output option handling, as well as corresponding unit and E2E tests. The change enhances integration options, particularly for GitLab CI.
Introduced support for the GitLab-specific output format in the Check command and its end-to-end test suite. Modified the condition in the Check command to handle the GitLab format and added a corresponding test case to verify functionality for outputs with no errors.
Unified violation instantiation and assertion logic in tests, replacing mock-based violations with direct object creation. Simplified JSON output comparisons using `assertSame` with string literals. Updated `GitlabPrinter` to use relative paths for better clarity in output.
raffaelecarelle
force-pushed
the
gitlab-output-format
branch
from
c3dcefb to
cefdf9a
Compare
|
@raffaelecarelle Apart from backward compatibility, do we have a good reason to maintain both a JSON format and a GitLab format? Does the current JSON format offer any advantages? |
|
Well, the GitLab format is specific to GitLab (initially I was the one who confused things, I apologize). Meanwhile, the JSON format can be used either by GitLab for other types of reports or also by other platforms like GitHub or SonarQube. I would keep both for greater flexibility, and to cover more use cases, but if it's more difficult then we can remove one of the two. |
Introduced the "gitlab" format for CLI output, alongside existing "text" and "json" formats. This includes a new
GitlabPrinterimplementation, updates to thePrinterFactoryand output option handling, as well as corresponding unit and E2E tests. The change enhances integration options, particularly for GitLab CI.gitlab code quality format must have particular json format
see gitlab docs: https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
this PR depends on #475