Corrected --reporter usage instructions

pinterest · Mar 29, 2018 · db46520 · db46520
1 parent 4370ad5
commit db46520
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -340,7 +340,7 @@ In short, all you need to do is to implement a
 a custom [ReporterProvider](ktlint-core/src/main/kotlin/com/github/shyiko/ktlint/core/ReporterProvider.kt) using
 `META-INF/services/com.github.shyiko.ktlint.core.ReporterProvider`. Pack all of that into a JAR and you're done.
 
-To load a custom (3rd party) reporter use `ktlint --reporter=groupId:artifactId:version` / `ktlint --reporter=/path/to/custom-ktlint-reporter.jar`
+To load a custom (3rd party) reporter use `ktlint --reporter=name,artifact=groupId:artifactId:version` / `ktlint --reporter=name,artifact=/path/to/custom-ktlint-reporter.jar`
 (see `ktlint --help` for more).
 
 ## Badge

diff --git a/ktlint/src/main/kotlin/com/github/shyiko/ktlint/Main.kt b/ktlint/src/main/kotlin/com/github/shyiko/ktlint/Main.kt
@@ -137,7 +137,8 @@ object Main {
         "To use a third-party reporter specify either a path to a JAR file on the filesystem or a" +
         "<groupId>:<artifactId>:<version> triple pointing to a remote artifact (in which case ktlint will first " +
         "check local cache (~/.m2/repository) and then, if not found, attempt downloading it from " +
-        "Maven Central/JCenter/JitPack/user-provided repository)"
+        "Maven Central/JCenter/JitPack/user-provided repository)\n" +
+        "e.g. \"html,artifact=com.github.username:ktlint-reporter-html:master-SNAPSHOT\""
     ))
     private var reporters = ArrayList<String>()