Feature/3274/use-current-directory-if-input-empty

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 -   Add metric tooltips that display attribute descriptors and provide hyperlinks in the sidebar to the metric's documentation [#3273](https://github.com/MaibornWolff/codecharta/pull/3273) </br>
     <img src="https://user-images.githubusercontent.com/65733509/241383211-d9e8e54b-6b06-45bb-8b99-81cc8e0a4596.png" width="450px"/> <img src="https://github.com/MaibornWolff/codecharta/assets/65733509/0ade9ad4-e60b-4911-aadc-d8142167b21a" width="300px"/>
 -   Expand and restructure documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
+-   Add current working directories as hint or default value to interactive parser and parser suggestions when asking for input [#3319](https://github.com/MaibornWolff/codecharta/pull/3319)
 
 ### Fixed 🐞
 

analysis/export/CSVExporter/src/main/kotlin/de/maibornwolff/codecharta/exporter/csv/ParserDialog.kt

@@ -4,13 +4,16 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptInput
 import com.github.kinquirer.components.promptInputNumber
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
 import java.math.BigDecimal
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
         override fun collectParserArgs(): List<String> {
             val inputFileName = KInquirer.promptInput(
                 message = "What is the cc.json file that has to be parsed?",
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "yourInput.cc.json"
             )
 
             val defaultOutputFileName = getOutputFileName(inputFileName)

analysis/filter/EdgeFilter/src/main/kotlin/de/maibornwolff/codecharta/filter/edgefilter/ParserDialog.kt

@@ -4,6 +4,8 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import mu.KotlinLogging
+import java.io.File
+import java.nio.file.Paths
 
 private val logger = KotlinLogging.logger {}
 
@@ -13,7 +15,10 @@ class ParserDialog {
 
         override fun collectParserArgs(): List<String> {
 
-            val inputFileName = KInquirer.promptInput(message = "What is the $EXTENSION file that has to be parsed?")
+            val inputFileName = KInquirer.promptInput(
+                    message = "What is the $EXTENSION file that has to be parsed?",
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "yourInput." + EXTENSION
+                                                     )
             logger.info { "File path: $inputFileName" }
 
             val defaultOutputFileName = getOutputFileName(inputFileName)

analysis/filter/MergeFilter/src/main/kotlin/de/maibornwolff/codecharta/filter/mergefilter/ParserDialog.kt

@@ -4,14 +4,17 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
 
             val inputFolderName =
-                KInquirer.promptInput(message = "What is the folder of cc.json files that has to be merged?")
+                KInquirer.promptInput(
+                        message = "What is the folder of cc.json files that has to be merged?",
+                        default = Paths.get("").toAbsolutePath().toString())
 
             val outputFileName: String = KInquirer.promptInput(
                 message = "What is the name of the output file?"

analysis/filter/StructureModifier/src/main/kotlin/de/maibornwolff/codecharta/filter/structuremodifier/ParserDialog.kt

@@ -4,14 +4,19 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptInput
 import com.github.kinquirer.components.promptInputNumber
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
 import java.math.BigDecimal
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
             val inputFolderName =
-                    KInquirer.promptInput(message = "What is the cc.json file that has to be modified?")
+                    KInquirer.promptInput(
+                            message = "What is the cc.json file that has to be modified?",
+                            hint = Paths.get("").toAbsolutePath().toString() + File.separator + "yourInput.cc.json"
+                                         )
 
             val outputFileName: String = KInquirer.promptInput(
                     message = "What is the name of the output file?"

analysis/import/CSVImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/csv/ParserDialog.kt

@@ -3,26 +3,14 @@ package de.maibornwolff.codecharta.importer.csv
 import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
+import de.maibornwolff.codecharta.importer.util.ParserDialogHelper
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
-            val inputFileNames = mutableListOf(KInquirer.promptInput(
-                    message = "Please specify the name of the first sourcemonitor CSV file to be parsed:",
-                    hint = "input.csv"
-            ))
-            while (true) {
-                val additionalFile = KInquirer.promptInput(
-                        message = "If you want to parse additional sourcemonitor CSV files, specify the name of the next file. Otherwise, leave this field empty to skip.",
-                )
-                if (additionalFile.isNotBlank()) {
-                    inputFileNames.add(additionalFile)
-                } else {
-                    break
-                }
-            }
+            val inputFileNames = ParserDialogHelper.getInputFiles(false)
 
             val outputFileName: String = KInquirer.promptInput(
                     message = "What is the name of the output file?",

analysis/import/CSVImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sourcemonitor/ParserDialog.kt

@@ -3,26 +3,14 @@ package de.maibornwolff.codecharta.importer.sourcemonitor
 import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
+import de.maibornwolff.codecharta.importer.util.ParserDialogHelper
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
-            val inputFileNames = mutableListOf(KInquirer.promptInput(
-                    message = "What is the sourcemonitor CSV file that has to be parsed?",
-                    hint = "sourcemonitor.csv"
-            ))
-            while (true) {
-                val additionalFile = KInquirer.promptInput(
-                    message = "If you want to parse additional sourcemonitor CSV files, specify the name of the next file. Otherwise, leave this field empty to skip.",
-                )
-                if (additionalFile.isNotBlank()) {
-                    inputFileNames.add(additionalFile)
-                } else {
-                    break
-                }
-            }
+            val inputFileNames = ParserDialogHelper.getInputFiles(true)
 
             val outputFileName: String = KInquirer.promptInput(
                 message = "What is the name of the output file?",

analysis/import/CSVImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/util/ParserDialogHelper.kt

@@ -0,0 +1,30 @@
+package de.maibornwolff.codecharta.importer.util
+
+import com.github.kinquirer.KInquirer
+import com.github.kinquirer.components.promptInput
+import java.io.File
+import java.nio.file.Paths
+
+class ParserDialogHelper {
+
+    companion object {
+        fun getInputFiles(isSourceMonitor: Boolean): MutableList<String> {
+            val inputFileNames = mutableListOf(KInquirer.promptInput(
+                    message = if (isSourceMonitor) { "What is the SourceMonitor CSV file that has to be parsed?" } else { "Please specify the name of the first CSV file to be parsed." },
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "yourInput.csv"))
+
+            while (true) {
+                val additionalFile = KInquirer.promptInput(
+                        message = "If you want to parse additional CSV files, specify the name of the next file. Otherwise, leave this field empty to skip.",
+                                                          )
+                if (additionalFile.isNotBlank()) {
+                    inputFileNames.add(additionalFile)
+                } else {
+                    break
+                }
+            }
+
+            return inputFileNames
+        }
+    }
+}

analysis/import/CodeMaatImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/codemaat/ParserDialog.kt

@@ -4,17 +4,20 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
         private const val EXTENSION = "csv"
 
         override fun collectParserArgs(): List<String> {
             val defaultInputFileName = "edges.$EXTENSION"
+            val defaultInputFilePath = Paths.get("").toAbsolutePath().toString() + File.separator + defaultInputFileName
             val inputFileName = KInquirer.promptInput(
                 message = "What is the $EXTENSION file that has to be parsed?",
-                hint = defaultInputFileName,
-                default = defaultInputFileName
+                hint = defaultInputFilePath,
+                default = defaultInputFilePath
             )
 
             val defaultOutputFileName = getOutputFileName(inputFileName)

analysis/import/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/importer/gitlogparser/subcommands/LogScanParserDialog.kt

@@ -3,6 +3,8 @@ package de.maibornwolff.codecharta.importer.gitlogparser.subcommands
 import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
+import java.nio.file.Paths
 
 class LogScanParserDialog {
     companion object : ParserDialogInterface {
@@ -11,12 +13,14 @@ class LogScanParserDialog {
 
             print("You can generate this file with: git log --numstat --raw --topo-order --reverse -m > git.log")
             val gitLogFile = KInquirer.promptInput(
-                message = "What is the git.log file that has to be parsed?", hint = "path/to/git.log"
+                message = "What is the git.log file that has to be parsed?",
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "git.log"
             )
 
             print("You can generate this file with: git ls-files > file-name-list.txt")
             val gitLsFile = KInquirer.promptInput(
-                message = "What is the path to the file name list?", hint = "path/to/file-name-list.txt"
+                message = "What is the path to the file name list?",
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "file-name-list.txt"
             )
 
             return listOfNotNull(

analysis/import/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/importer/gitlogparser/subcommands/RepoScanCommand.kt

@@ -48,8 +48,8 @@ class RepoScanCommand : Callable<Void>, InteractiveParser {
     override fun call(): Void? {
         val repoPath: Path
         if (repoPathName.isNullOrBlank()) {
-            repoPath = Paths.get("").normalize().toAbsolutePath()
-            println("--repo-path not set, assuming current working directory ($repoPath)")
+            println("--repo-path not set, aborting...")
+            return null
         } else {
             repoPath = Paths.get(repoPathName!!).normalize().toAbsolutePath()
         }

analysis/import/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/importer/gitlogparser/subcommands/RepoScanParserDialog.kt

@@ -3,15 +3,16 @@ package de.maibornwolff.codecharta.importer.gitlogparser.subcommands
 import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.nio.file.Paths
 
 class RepoScanParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
 
             val repoPath = KInquirer.promptInput(
-                message = "What is the root directory of the git project you want to parse? If empty, \".\" is assumed",
-                hint = "path/to/repo/root"
+                message = "What is the root directory of the git project you want to parse?",
+                default = Paths.get("").normalize().toAbsolutePath().toString()
             )
 
             return listOfNotNull(

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/ParserDialog.kt

@@ -4,6 +4,8 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
@@ -18,7 +20,7 @@ class ParserDialog {
             val inputFile = KInquirer.promptInput(
                 message = if (isJsonFile) "Which MetricGardener json-File do you want to import?"
                 else "What Project do you want to parse?",
-                hint = if (isJsonFile) "path/to/metricgardener/file.json" else "path/to/my/project"
+                hint = if (isJsonFile) { Paths.get("").toAbsolutePath().toString() + File.separator + "file.json" } else Paths.get("").toAbsolutePath().toString()
             )
 
             val outputFileName: String = KInquirer.promptInput(

analysis/import/MetricGardenerImporter/src/test/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/MetricGardenerImporterTest.kt

@@ -21,16 +21,16 @@ class MetricGardenerImporterTest {
             return listOf(
                     Arguments.of("src/test/resources/my/supported-multi-language/repo"),
                     Arguments.of("src/test/resources/my/supported-multi-language/repo/dummyFile.js"),
-                    Arguments.of("src/test/resources/my"),
-                    Arguments.of(""))
+                    Arguments.of("src/test/resources/my"))
         }
 
         @JvmStatic
         fun provideInvalidInputFiles(): List<Arguments> {
             return listOf(
                     Arguments.of("src/test/resources/my/empty/repo"),
                     Arguments.of("src/test/resources/this/does/not/exist"),
-                    Arguments.of("src/test/resources/my/non-supported-language/repo"))
+                    Arguments.of("src/test/resources/my/non-supported-language/repo"),
+                    Arguments.of(""))
         }
     }
 

analysis/import/SVNLogParser/src/main/kotlin/de/maibornwolff/codecharta/importer/svnlogparser/ParserDialog.kt

@@ -4,6 +4,8 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
@@ -13,10 +15,11 @@ class ParserDialog {
         override fun collectParserArgs(): List<String> {
             print("You can generate this file with: svn log --verbose > svn.log")
             val defaultInputFileName = "svn.$EXTENSION"
+            val defaultInputFilePath = Paths.get("").toAbsolutePath().toString() + File.separator + defaultInputFileName
             val inputFileName = KInquirer.promptInput(
                 message = "What is the $EXTENSION file that has to be parsed?",
-                hint = defaultInputFileName,
-                default = defaultInputFileName
+                hint = defaultInputFilePath,
+                default = defaultInputFilePath
             )
 
             val defaultOutputFileName = getOutputFileName(inputFileName)

analysis/import/SonarImporter/src/test/kotlin/de/maibornwolff/codecharta/importer/sonar/SonarImporterMainTest.kt

@@ -35,15 +35,15 @@ class SonarImporterMainTest {
             return listOf(
                     Arguments.of("src/test/resources/my/sonar/repo"),
                     Arguments.of("src/test/resources/my/sonar/repo/sonar-project.properties"),
-                    Arguments.of("src/test/resources/my/sonar"),
-                    Arguments.of(""))
+                    Arguments.of("src/test/resources/my/sonar"))
         }
 
         @JvmStatic
         fun provideInvalidInputFiles(): List<Arguments> {
             return listOf(
                     Arguments.of("src/test/resources/my/nonsonar/repo"),
-                    Arguments.of("src/test/resources/this/does/not/exist"))
+                    Arguments.of("src/test/resources/this/does/not/exist"),
+                    Arguments.of(""))
         }
 
         @JvmStatic

analysis/import/SourceCodeParser/src/main/kotlin/de/maibornwolff/codecharta/importer/sourcecodeparser/ParserDialog.kt

@@ -6,14 +6,15 @@ import com.github.kinquirer.components.promptInput
 import com.github.kinquirer.components.promptListObject
 import com.github.kinquirer.core.Choice
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
             val inputFileName = KInquirer.promptInput(
                     message = "Which project folder or code file should be parsed?",
-                    hint = "file.java"
+                    default = Paths.get("").toAbsolutePath().toString()
             )
 
             val outputFormat = KInquirer.promptListObject(

analysis/import/SourceCodeParser/src/test/kotlin/de/maibornwolff/codecharta/importer/sourcecodeparser/SourceCodeParserMainTest.kt

@@ -13,16 +13,16 @@ class SourceCodeParserMainTest {
             return listOf(
                     Arguments.of("src/test/resources/my/java/repo"),
                     Arguments.of("src/test/resources/my/java/repo/hello_world.java"),
-                    Arguments.of("src/test/resources/my"),
-                    Arguments.of(""))
+                    Arguments.of("src/test/resources/my"))
         }
 
         @JvmStatic
         fun provideInvalidInputFiles(): List<Arguments> {
             return listOf(
                     Arguments.of("src/test/resources/my/empty/repo"),
                     Arguments.of("src/test/resources/this/does/not/exist"),
-                    Arguments.of("src/test/resources/my/non-java/repo"))
+                    Arguments.of("src/test/resources/my/non-java/repo"),
+                    Arguments.of(""))
         }
     }
 

analysis/import/TokeiImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/tokeiimporter/ParserDialog.kt

@@ -4,14 +4,16 @@ import com.github.kinquirer.KInquirer
 import com.github.kinquirer.components.promptConfirm
 import com.github.kinquirer.components.promptInput
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import java.io.File
+import java.nio.file.Paths
 
 class ParserDialog {
     companion object : ParserDialogInterface {
 
         override fun collectParserArgs(): List<String> {
             val inputFileName = KInquirer.promptInput(
                     message = "Please specify the name of the Tokei JSON file to be parsed:",
-                    hint = "input.json"
+                    hint = Paths.get("").toAbsolutePath().toString() + File.separator + "yourInput.json"
             )
 
             val outputFileName: String = KInquirer.promptInput(