Need a hand with custom reports on Detekt :pray: [...

# detekt

[mokkun]

Need a hand with custom reports on Detekt 🙏 [thread]

[mokkun]

Hi, thanks for reading this. I'm trying to set up a custom report with Detekt. I've read the main README of the project and the documentation about extensions:
• https://github.com/arturbosch/detekt/blob/master/README.md
• https://arturbosch.github.io/detekt/extensions.html#let-detekt-know-about-your-extensions

[mokkun]

I made a small sample project at https://github.com/mokkun/detekt-json-report-sample to show you how I'm currently setting it up.

[mokkun]

I have a separate Gradle file with the settings for Detekt:
• https://github.com/mokkun/detekt-json-report-sample/blob/master/detekt.gradle
And a library for the custom report itself:
• https://github.com/mokkun/detekt-json-report-sample/blob/master/detekt-report/build.gradle
• https://github.com/mokkun/detekt-json-report-sample/blob/master/detekt-report/src/main/java/io/petter/detekt/report/JsonReport.kt

[mokkun]

When I run ./gradlew detekt I get all the default reports (TXT, HTML and XML) but the custom report is not written. 😞

[mokkun]

If you have the time to look into it and help me find what I am missing I'd appreciate it very much. 🙇‍♂️

[Artur Bosch]

Hey @mokkun,
you need to register your report so detekt-core can find it, see https://github.com/detekt/detekt/blob/4e645d50cf511633fb0296c08c480ac52a6a1107/detekt-sample-extensions/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.OutputReport#L1-L0.

All detekt extensions need a META-INF/services entry.

[mokkun]

Hi @Artur Bosch, thank you so much for the help, it works now. Somehow the docs for the custom report (https://arturbosch.github.io/detekt/extensions.html#custom-reports) don't mention that and I missed it when checking the samples.

[Artur Bosch]

@mokkun glad it worked out.
Would you mind opening a PR improving the extension documentation with this detail?

[mokkun]

Sure thing. Will do it within this week. 👍