Support for 3rd-party reporters?

[autonomousapps]

See pinterest/ktlint#176.

[jeremymailen]

Would it work for you if I directly support https://github.com/mcassiano/ktlint-html-reporter (with the author's permission of course) as reporter for 'html'?

I could make it extensible with providers the way rule sets are, but I suspect it is a less common use case and I'm shooting for "simply works out of the box" for the most part with this gradle plugin.

[autonomousapps]

That would work for me, and I think it makes sense in this case. An html reporter would be super useful out of the box.

[shyiko]

Guys,
this is not stated in the ktlint's README (even though it should) but reporters are loaded using ServiceLoader same as rulesets. In other words, as long as jar containing Reporter implementation is on the classpath it will be loaded.
This is why something like

dependencies {
    ktlint "com.github.shyiko:ktlint:0.20.0"
    ktlint "com.github.mcassiano:ktlint-html-reporter:master-SNAPSHOT"
}

task ktlint(type: JavaExec, group: "verification") {
    description = "Check Kotlin code style."
    classpath = configurations.ktlint
    main = "com.github.shyiko.ktlint.Main"
    args "--reporter=html", "src/**/*.kt" # notice that no artifact=... is needed
}

should work (same applies to Maven). By extension, https://github.com/jeremymailen/kotlinter-gradle#custom-rules can be used for the same purpose.
This is for your information only. I'm not advocating any particular implementation (or a lack thereof).

[mcassiano]

Hey! I was going to publish this later on but there were some things I was trying to investigate further.

I'm not sure I was doing something wrong but loading the reporter from jar was not working. My guess is that in line 378 the wrong id is being used to query the map (it's using the id passed on as an argument, which in this case is a path), when it should be using ReporterProvider.id. I didn't have time to check if that's what's happening but I'd gladly open an issue and PR to ktlint if that's the case. (ping @shyiko)

What I did to use this in a project was loading the jar as a ruleset (it only loads the jar) and then passing ReporterProvider.id of my reporter as an option (--reporter=html,output=${buildDir}/ktlint.html) which, I know, IS VERY HACKY. haha

[mcassiano]

Oh, I see, you fixed the bug! Nice.

[jeremymailen]

Available now in https://github.com/jeremymailen/kotlinter-gradle/releases/tag/1.11.0

[autonomousapps]

Thanks!

Configuring it now, and I'm considering elaborating on the solution to allow for a single report for all source sets, and/or a single report for multiple modules. Just to make configuring Jenkins a bit easier. Will update you if that ever happens :)