Improve sonarimport help (#2717)

* improve sonarimport help message in cli #357 * add changelog entry #357 * fix changelog entry #357 * fix help message example command #357
MaibornWolff · Mar 18, 2022 · 3eab61d · 3eab61d
1 parent ac59097
commit 3eab61d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ### Changed
 
+-   Improve sonarimport help message [#2717](https://github.com/MaibornWolff/codecharta/pull/2717)
 -   Remove blacklist entry on click of name as well [#2712](https://github.com/MaibornWolff/codecharta/pull/2712)
 
 ## [1.93.0] - 2022-03-14

diff --git a/...arImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sonar/SonarImporterMain.kt b/...arImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sonar/SonarImporterMain.kt
@@ -27,7 +27,13 @@ class SonarImporterMain(
     private val error: PrintStream = System.err
 ) : Callable<Void> {
 
-    @CommandLine.Option(names = ["-h", "--help"], usageHelp = true, description = ["displays this help and exits"])
+    @CommandLine.Option(names = ["-h", "--help"], usageHelp = true, description = [
+        "Please locate:\n" +
+        "-    sonar.host.url=https://sonar.foo\n" +
+        "-    sonar.login=c123d456\n" +
+        "-    sonar.projectKey=de.foo:bar\n" +
+        "That you use to upload your code to sonar.\n" +
+        "Then execute [sonarimport https://sonar.foo de.foo:bar -u c123d456]"])
     private var help = false
 
     @CommandLine.Parameters(index = "0", paramLabel = "URL", description = ["url of sonarqube server"])