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

Support arbitrary report formatters for the PMD plugin #22610

Open
slovdahl opened this issue Nov 4, 2022 · 4 comments · May be fixed by #22979
Open

Support arbitrary report formatters for the PMD plugin #22610

slovdahl opened this issue Nov 4, 2022 · 4 comments · May be fixed by #22979
Assignees
Labels
a:feature A new functionality 🌳 help wanted Taking contributor PRs, might need existing Gradle knowledge in:pmd-plugin

Comments

@slovdahl
Copy link

slovdahl commented Nov 4, 2022

Expected Behavior

I would like to be able to configure the report formatter when running PMD to be codeclimate (and maybe sarif in the future if GitLab starts supporting it).

Current Behavior

Only the html and xml formatters can be explicitly enabled/disabled at the moment, and text / textcolor implicitly through pmd { consoleOutput = true }.

Context

We use GitLab and GitLab CI. Its code quality analysis supports the Code Climate format.

@slovdahl slovdahl added a:feature A new functionality to-triage labels Nov 4, 2022
@slovdahl
Copy link
Author

slovdahl commented Nov 4, 2022

Implementing this does not seem to be that hard (for someone that has never touched the Gradle codebase but has a little bit of experience with Gradle plugins). I could try to give it a shot and provide a PR if there's a chance it will be accepted.

@eskatos eskatos added in:pmd-plugin 🌳 help wanted Taking contributor PRs, might need existing Gradle knowledge and removed to-triage labels Nov 18, 2022
@eskatos
Copy link
Member

eskatos commented Nov 18, 2022

This feature request is in the backlog of the relevant team but this area of Gradle is currently not a focus one so it might take a while before it gets implemented.

If you are interested in contributing to Gradle, this issue is actionable and ready for contribution but might be challenging for first time contributors.

See CONTRIBUTING.md for more information.


Yes, if you are interested in contributing, please go ahead.

Also see

@slovdahl slovdahl linked a pull request Dec 5, 2022 that will close this issue
12 tasks
@slovdahl
Copy link
Author

Thanks @eskatos, I opened #22979 as a starting point.

@MitchK
Copy link

MitchK commented Feb 6, 2023

Following, we would like to enable PMD as part of our GitLab CI pipeline, but we currently can't set the reporting format to codeclimate (which is supported by GitLab).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:feature A new functionality 🌳 help wanted Taking contributor PRs, might need existing Gradle knowledge in:pmd-plugin
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants