Fix typos and inconsistencies in help message (#464)

This PR fixes typos and missing punctuation in the help message. All split characters for list and map type options are changed to the path separation character for each OS (: for Linux/Mac, ; for Windows) for consistency.

Co-authored-by: Florian Wendland <florian.wendland@aisec.fraunhofer.de>

src/main/java/de/fraunhofer/aisec/codyze/config/CodyzeConfiguration.kt

@@ -14,7 +14,7 @@ class CodyzeConfiguration {
         names = ["-m", "--mark"],
         paramLabel = "<path>",
         description = ["Loads MARK policy files.\n\t(Default: \${DEFAULT-VALUE})"],
-        split = ","
+        split = "\${sys:path.separator}"
     )
     var mark: Array<File> = arrayOf(File("./"))
 
@@ -23,19 +23,19 @@ class CodyzeConfiguration {
         names = ["--no-good-findings"],
         description =
             [
-                "Disable output of \"positive\" findings which indicate correct implementations\n" +
+                "Disable output of \"positive\" findings which indicate correct implementations.\n" +
                     "\t(Default: \${DEFAULT-VALUE})"],
         fallbackValue = "true"
     )
     var noGoodFindings = false
 
     @Option(
         names = ["--disabled-mark-rules"],
-        paramLabel = "<package.rule>",
+        paramLabel = "<package>.<rule>",
         description =
             [
-                "The specified mark rules will be excluded from being parsed and processed. The rule has to be specified by its fully qualified name (package.rule). If there is no package name, specify rule as \".rule\". Use \'*\' to disable an entire package."],
-        split = ","
+                "The specified mark rules will be excluded from being parsed and processed. The rule has to be specified by its fully qualified name. If there is no package name, specify rule as \".<rule>\". Use \'<package>.*\' to disable an entire package."],
+        split = "\${sys:path.separator}"
     )
     var disabledMarkRules: List<String> = emptyList()
 

src/main/java/de/fraunhofer/aisec/codyze/config/CpgConfiguration.kt

@@ -16,8 +16,8 @@ class CpgConfiguration {
 
     @Option(
         names = ["--additional-languages"],
-        split = ",",
-        paramLabel = "language",
+        split = "\${sys:path.separator}",
+        paramLabel = "<language>",
         description =
             [
                 "Enables the experimental support for additional languages (currently \${COMPLETION-CANDIDATES}). Additional files need to be placed in certain locations. Please follow the CPG README."]
@@ -39,7 +39,7 @@ class CpgConfiguration {
         negatable = true,
         description =
             [
-                "If false, type listener system is only activated after the frontends are done building the initial AST structure.(Default: \${DEFAULT-VALUE})"],
+                "If false, type listener system is only activated after the frontends are done building the initial AST structure.\n\t(Default: \${DEFAULT-VALUE})"],
         fallbackValue = "true"
     )
     var typeSystemInFrontend = true
@@ -55,11 +55,11 @@ class CpgConfiguration {
 
     @Option(
         names = ["--passes"],
-        paramLabel = "pass",
+        paramLabel = "<pass>",
         description =
             [
                 "CPG passes in the order in which they should be executed, fully qualified name of the classes only. If default-passes is specified, the default passes are executed first."],
-        split = ","
+        split = "\${sys:path.separator}"
     )
     @JvmName("setPassesNull")
     fun setPasses(passes: List<Pass?>) {
@@ -69,7 +69,7 @@ class CpgConfiguration {
 
     @Option(
         names = ["--debug-parser"],
-        description = ["Controls debug output generation for the cpg parser"],
+        description = ["Controls debug output generation for the cpg parser."],
         fallbackValue = "true"
     )
     var debugParser = false
@@ -78,7 +78,7 @@ class CpgConfiguration {
         names = ["--disable-cleanup"],
         description =
             [
-                "Switch off cleaning up TypeManager memory after the analysis. Set to true only for testing"],
+                "Switch off cleaning up TypeManager memory after the analysis. Set to true only for testing."],
         fallbackValue = "true"
     )
     var disableCleanup = false
@@ -88,15 +88,15 @@ class CpgConfiguration {
         negatable = true,
         description =
             [
-                "Controls showing the code of a node as parameter in the node\n\t(Default: \${DEFAULT-VALUE})"],
+                "Controls showing the code of a node as parameter in the node.\n\t(Default: \${DEFAULT-VALUE})"],
         fallbackValue = "true"
     )
     var codeInNodes = true
 
     @JsonProperty("annotations")
     @Option(
         names = ["--annotations"],
-        description = ["Enables processing annotations or annotation-like elements"],
+        description = ["Enables processing annotations or annotation-like elements."],
         fallbackValue = "true"
     )
     var processAnnotations = false
@@ -105,16 +105,16 @@ class CpgConfiguration {
         names = ["--fail-on-error"],
         description =
             [
-                "Should the parser/translation fail on errors (true) or try to continue in a best-effort manner (false)\n\t(Default: \${DEFAULT-VALUE})"],
+                "Should the parser/translation fail on errors (true) or try to continue in a best-effort manner (false).\n\t(Default: \${DEFAULT-VALUE})"],
         fallbackValue = "true"
     )
     var failOnError = false
 
     @Option(
         names = ["--symbols"],
-        paramLabel = "<symbol=definition>",
-        description = ["Definition of additional symbols"],
-        split = ","
+        paramLabel = "<symbol>=<definition>",
+        description = ["Definition of additional symbols."],
+        split = "\${sys:path.separator}"
     )
     var symbols: Map<String, String> = HashMap()
 
@@ -123,7 +123,7 @@ class CpgConfiguration {
         names = ["--parallel-frontends"],
         description =
             [
-                "Enables parsing the ASTs for the source files in parallel, but the passes afterwards will still run in a single thread"],
+                "Enables parsing the ASTs for the source files in parallel, but the passes afterwards will still run in a single thread."],
         fallbackValue = "true"
     )
     var useParallelFrontends = false
@@ -142,10 +142,9 @@ class TranslationSettings {
 
     @Option(
         names = ["--includes"],
-        description =
-            [
-                "Path(s) containing include files. Path must be separated by \':\' (Mac/Linux) or \';\' (Windows)."],
-        split = ":|;"
+        paramLabel = "<path>",
+        description = ["Path(s) containing include files."],
+        split = "\${sys:path.separator}"
     )
     var includes: Array<File> = emptyArray()
 
@@ -154,8 +153,8 @@ class TranslationSettings {
         paramLabel = "<path>",
         description =
             [
-                "If includes is not empty, only the specified files will be parsed and processed in the cpg, unless it is a part of the disabled list, in which it will be ignored. Path must be separated by \':\' (Mac/Linux) or \';\' (Windows)"],
-        split = ":|;"
+                "If includes is not empty, only the specified files will be parsed and processed in the cpg, unless it is a part of the disabled list, in which it will be ignored."],
+        split = "\${sys:path.separator}"
     )
     var enabledIncludes: Array<File> = emptyArray()
 
@@ -164,8 +163,8 @@ class TranslationSettings {
         paramLabel = "<path>",
         description =
             [
-                "If includes is not empty, the specified files will be excluded from being parsed and processed in the cpg. The disabled list entries always take priority over the enabled list entries. Path must be separated by \':\' (Mac/Linux) or \';\' (Windows)"],
-        split = ":|;"
+                "If includes is not empty, the specified files will be excluded from being parsed and processed in the cpg. The disabled list entries always take priority over the enabled list entries."],
+        split = "\${sys:path.separator}"
     )
     var disabledIncludes: Array<File> = emptyArray()
 }

src/test/java/de/fraunhofer/aisec/codyze/crymlin/CLILoadTest.kt

@@ -76,8 +76,8 @@ internal class CLILoadTest {
             Configuration.initConfig(
                 null,
                 "-c",
-                "--passes=de.fraunhofer.aisec.cpg.passes.EdgeCachePass," +
-                    "de.fraunhofer.aisec.cpg.passes.FilenameMapper," +
+                "--passes=de.fraunhofer.aisec.cpg.passes.EdgeCachePass${File.pathSeparator}" +
+                    "de.fraunhofer.aisec.cpg.passes.FilenameMapper${File.pathSeparator}" +
                     "de.fraunhofer.aisec.cpg.passes.CallResolver"
             )
         val translationConfiguration = config.buildTranslationConfiguration(File("test.java"))
@@ -104,10 +104,10 @@ internal class CLILoadTest {
             Configuration.initConfig(
                 null,
                 "-c",
-                "--passes=de.fraunhofer.aisec.cpg.passes.MyPass," +
-                    "de.fraunhofer.aisec.cpg.passes.Pass," +
-                    "de.fraunhofer.aisec.cpg.passes.scopes.BlockScope," +
-                    "de.fraunhofer.aisec.cpg.passes.EdgeCachePass," +
+                "--passes=de.fraunhofer.aisec.cpg.passes.MyPass${File.pathSeparator}" +
+                    "de.fraunhofer.aisec.cpg.passes.Pass${File.pathSeparator}" +
+                    "de.fraunhofer.aisec.cpg.passes.scopes.BlockScope${File.pathSeparator}" +
+                    "de.fraunhofer.aisec.cpg.passes.EdgeCachePass${File.pathSeparator}" +
                     "MyPass2"
             )
         val translationConfiguration = config.buildTranslationConfiguration(File("test.java"))
@@ -125,7 +125,8 @@ internal class CLILoadTest {
     @Test
     @Throws(Exception::class)
     fun symbolsOptionTest() {
-        val config = Configuration.initConfig(null, "-c", "--symbols=#=hash,*=star")
+        val config =
+            Configuration.initConfig(null, "-c", "--symbols=#=hash${File.pathSeparator}*=star")
         val translationConfiguration = config.buildTranslationConfiguration(File("test.java"))
         assertEquals(
             2,

src/test/java/de/fraunhofer/aisec/codyze/crymlin/ConfigCLILoadTest.kt

@@ -25,7 +25,7 @@ class ConfigCLILoadTest {
                 "--sarif", // test if true stays true
                 "--unity", // test if false is set to true
                 "--analyze-includes=false", // test if false is set to false
-                "-m=mark5,mark7,mark6"
+                "-m=mark5${File.pathSeparator}mark7${File.pathSeparator}mark6"
             )
         val config = Configuration.initConfig(correctFile, *options)
         val serverConfig = config.buildServerConfiguration()
@@ -82,9 +82,9 @@ class ConfigCLILoadTest {
             Configuration.initConfig(
                 additionalOptionFile,
                 "-c",
-                "--passes=de.fraunhofer.aisec.cpg.passes.FilenameMapper," +
+                "--passes=de.fraunhofer.aisec.cpg.passes.FilenameMapper${File.pathSeparator}" +
                     "de.fraunhofer.aisec.cpg.passes.CallResolver",
-                "--symbols=&=and,+=plus",
+                "--symbols=&=and${File.pathSeparator}+=plus",
                 "--no-type-system-in-frontend",
                 "--default-passes"
             )